eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::Easy3D::EPlaneCropper Class Reference

A EPlaneCropper object is used to crop some points of a EPointCloud object. More...

#include <eVision/Easy3D/EPlaneCropper.h>

Collaboration diagram for eVision::Easy3D::EPlaneCropper:

Public Member Functions

 EPlaneCropper ()
 Creates an EPlaneCropper object using a horizontal plane as a default reference.
 EPlaneCropper (const eVision::Easy3D::E3DPlane &plane)
 Creates an EPlaneCropper object using a horizontal plane as a default reference.
 EPlaneCropper (const eVision::Easy3D::EPlaneCropper &other)
 Creates an EPlaneCropper object using a horizontal plane as a default reference.
virtual ~EPlaneCropper () throw ()
eVision::Easy3D::EPlaneCropper & operator= (const eVision::Easy3D::EPlaneCropper &other)
 Assignment operator.
void SetPlane (const eVision::Easy3D::E3DPlane &plane)
 Sets/gets the new reference E3DPlane of the EPlaneCropper object.
eVision::Easy3D::E3DPlane GetPlane () const
 Sets/gets the new reference E3DPlane of the EPlaneCropper object.
void Load (const std::string &path)
 Loads the EPlaneCropper configuration. The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Loads the EPlaneCropper configuration. The given ESerializer must have been created for reading.
void Save (const std::string &path)
 Saves the EPlaneCropper configuration. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Saves the EPlaneCropper configuration. The given ESerializer must have been created for writing.
void Crop (const eVision::Easy3D::EPointCloud &cloudIn, eVision::Easy3D::EPointCloud &cloudOut, eVision::Easy3D::EPlaneCropperType type, float maxDistance) const
 Crops an EPointCloud. An output point cloud is produced from an input point cloud by only keeping the points that satisfy the specified condition.
void Crop (const eVision::Easy3D::EPointCloud &cloudIn, eVision::Easy3D::EPointCloud &cloudOut, eVision::Easy3D::EPlaneCropperType type) const
 Crops an EPointCloud. An output point cloud is produced from an input point cloud by only keeping the points that satisfy the specified condition.
 EPlaneCropper (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

A EPlaneCropper object is used to crop some points of a EPointCloud object.

The points to keep are selected according to their positions with respect to a reference plane. A EPlaneCropper object is characterized by its reference plane and is used to produce an output EPointCloud object from an input EPointCloud object. The produced point cloud contains a subset of the input point cloud.

License(s): Easy3D

Constructor & Destructor Documentation

◆ EPlaneCropper() [1/4]

eVision::Easy3D::EPlaneCropper::EPlaneCropper ( )

Creates an EPlaneCropper object using a horizontal plane as a default reference.

◆ EPlaneCropper() [2/4]

eVision::Easy3D::EPlaneCropper::EPlaneCropper ( const eVision::Easy3D::E3DPlane & plane)

Creates an EPlaneCropper object using a horizontal plane as a default reference.

Parameters
planeReference E3DPlane used for the initialization.

◆ EPlaneCropper() [3/4]

eVision::Easy3D::EPlaneCropper::EPlaneCropper ( const eVision::Easy3D::EPlaneCropper & other)

Creates an EPlaneCropper object using a horizontal plane as a default reference.

Parameters
otherReference EPlaneCropper used for the initialization.

◆ ~EPlaneCropper()

eVision::Easy3D::EPlaneCropper::~EPlaneCropper ( )
throw ( )
virtual

◆ EPlaneCropper() [4/4]

eVision::Easy3D::EPlaneCropper::EPlaneCropper ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Crop() [1/2]

void eVision::Easy3D::EPlaneCropper::Crop ( const eVision::Easy3D::EPointCloud & cloudIn,
eVision::Easy3D::EPointCloud & cloudOut,
eVision::Easy3D::EPlaneCropperType type ) const

Crops an EPointCloud. An output point cloud is produced from an input point cloud by only keeping the points that satisfy the specified condition.

The condition tests the (signed) distance of the points with respect to the reference plane of the cropper.

Parameters
cloudInThe input point cloud.
cloudOutThe output point cloud.
typeAn enum of type EPlaneCropperType that specifies which points of the input point cloud will be copied to the output point cloud.

The input point cloud 'cloudIn' should be different from the output point cloud 'cloudOut'. If not a exception will be thrown.

◆ Crop() [2/2]

void eVision::Easy3D::EPlaneCropper::Crop ( const eVision::Easy3D::EPointCloud & cloudIn,
eVision::Easy3D::EPointCloud & cloudOut,
eVision::Easy3D::EPlaneCropperType type,
float maxDistance ) const

Crops an EPointCloud. An output point cloud is produced from an input point cloud by only keeping the points that satisfy the specified condition.

The condition tests the (signed) distance of the points with respect to the reference plane of the cropper.

Parameters
cloudInThe input point cloud.
cloudOutThe output point cloud.
typeAn enum of type EPlaneCropperType that specifies which points of the input point cloud will be copied to the output point cloud.
maxDistanceSpecifies the distance from the plane for the types "EPlaneCropperType_KeepClose" and "EPlaneCropperType_KeepFar". It should be 0 for the types "EPlaneCropperType_KeepAbove" and "EPlaneCropperType_KeepBelow.

The input point cloud 'cloudIn' should be different from the output point cloud 'cloudOut'. If not a exception will be thrown.

◆ GetPlane()

eVision::Easy3D::E3DPlane eVision::Easy3D::EPlaneCropper::GetPlane ( ) const

Sets/gets the new reference E3DPlane of the EPlaneCropper object.

◆ Load() [1/2]

void eVision::Easy3D::EPlaneCropper::Load ( const std::string & path)

Loads the EPlaneCropper configuration. The given ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Load() [2/2]

void eVision::Easy3D::EPlaneCropper::Load ( eVision::ESerializer * serializer)

Loads the EPlaneCropper configuration. The given ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ operator=()

eVision::Easy3D::EPlaneCropper & eVision::Easy3D::EPlaneCropper::operator= ( const eVision::Easy3D::EPlaneCropper & other)

Assignment operator.

Parameters
otherAn other EPlaneCropper.

◆ Save() [1/2]

void eVision::Easy3D::EPlaneCropper::Save ( const std::string & path)

Saves the EPlaneCropper configuration. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [2/2]

void eVision::Easy3D::EPlaneCropper::Save ( eVision::ESerializer * serializer)

Saves the EPlaneCropper configuration. The given ESerializer must have been created for writing.

Parameters
serializerThe ESerializer object that is written to.

◆ SetPlane()

void eVision::Easy3D::EPlaneCropper::SetPlane ( const eVision::Easy3D::E3DPlane & plane)

Sets/gets the new reference E3DPlane of the EPlaneCropper object.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Easy3D::EPlaneCropper::wrappedClass_