eVision C++ API 26.10.0
Loading...
Searching...
No Matches
eVision::Easy3D::EPointCloudFilter Class Reference

An EPointCloudFilter is used to filter some points out of an EPointCloud. More...

#include <eVision/Easy3D/EPointCloudFilter.h>

Collaboration diagram for eVision::Easy3D::EPointCloudFilter:

Public Member Functions

 EPointCloudFilter (float thresholdMultiplier, uint32_t numberOfNeighbors, eVision::Easy3D::EPointCloudFilteringMethod method, bool replaceByAverage)
 Creates an EPointCloudFilter object to filter out some points in an EPointCloud.
 EPointCloudFilter (float thresholdMultiplier, uint32_t numberOfNeighbors, eVision::Easy3D::EPointCloudFilteringMethod method)
 Creates an EPointCloudFilter object to filter out some points in an EPointCloud.
 EPointCloudFilter (float thresholdMultiplier, uint32_t numberOfNeighbors)
 Creates an EPointCloudFilter object to filter out some points in an EPointCloud.
 EPointCloudFilter (float thresholdMultiplier)
 Creates an EPointCloudFilter object to filter out some points in an EPointCloud.
 EPointCloudFilter ()
 Creates an EPointCloudFilter object to filter out some points in an EPointCloud.
 EPointCloudFilter (const eVision::Easy3D::EPointCloudFilter &other)
 Creates an EPointCloudFilter object to filter out some points in an EPointCloud.
virtual ~EPointCloudFilter () throw ()
eVision::Easy3D::EPointCloudFilter & operator= (const eVision::Easy3D::EPointCloudFilter &other)
 Assignment operator.
void Filter (const eVision::Easy3D::EPointCloud &cloudIn, eVision::Easy3D::EPointCloud &cloudOut) const
 Filters the input point cloud and puts the result of the operation in the output point cloud.
void Load (const std::string &path)
 Loads the EPointCloudFilter configuration. The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Loads the EPointCloudFilter configuration. The given ESerializer must have been created for reading.
void Save (const std::string &path)
 Saves the EPointCloudFilter configuration. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Saves the EPointCloudFilter configuration. The given ESerializer must have been created for writing.
void SetFilteringMethod (eVision::Easy3D::EPointCloudFilteringMethod method)
 Sets/Gets the filtering method.
eVision::Easy3D::EPointCloudFilteringMethod GetFilteringMethod () const
 Sets/Gets the filtering method.
void SetNumberOfNeighbors (uint32_t numberOfNeighbors)
 Sets/Gets the number of neighbors.
uint32_t GetNumberOfNeighbors () const
 Sets/Gets the number of neighbors.
void SetThresholdMultiplier (float thresholdMultiplier)
 Sets/Gets the filtering threshold multiplier.
float GetThresholdMultiplier () const
 Sets/Gets the filtering threshold multiplier.
void SetReplaceByAverage (bool replaceByAverage)
 Sets/Gets whether to replace filtered points by their average.
bool GetReplaceByAverage () const
 Sets/Gets whether to replace filtered points by their average.
 EPointCloudFilter (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

An EPointCloudFilter is used to filter some points out of an EPointCloud.

The points to filter out are selected according to a criteria (see EPointCloudFilteringMethod) based on their neighborhood.

License(s): Easy3D

Constructor & Destructor Documentation

◆ EPointCloudFilter() [1/7]

eVision::Easy3D::EPointCloudFilter::EPointCloudFilter ( float thresholdMultiplier,
uint32_t numberOfNeighbors,
eVision::Easy3D::EPointCloudFilteringMethod method,
bool replaceByAverage )

Creates an EPointCloudFilter object to filter out some points in an EPointCloud.

Parameters
thresholdMultiplierPoints whose criterion is greater than mean + thresholdMultiplier * stddev are removed, mean and stddev being the mean and standard derivation of the criterion across all points of the cloud. Default: 1.
numberOfNeighborsNumber of neighbors in the neighborhood used to determine if a point is filtered or not. Default: 10
methodEPointCloudFilteringMethod used to select the points to filter.

Default: EPointCloudFilteringMethod::EPointCloudFilteringMethod_HighStandardDerivation.

Parameters
replaceByAverageSet to true to replace points to filter out by the mean of their neighborhood instead of removing them. Default: false

◆ EPointCloudFilter() [2/7]

eVision::Easy3D::EPointCloudFilter::EPointCloudFilter ( float thresholdMultiplier,
uint32_t numberOfNeighbors,
eVision::Easy3D::EPointCloudFilteringMethod method )

Creates an EPointCloudFilter object to filter out some points in an EPointCloud.

Parameters
thresholdMultiplierPoints whose criterion is greater than mean + thresholdMultiplier * stddev are removed, mean and stddev being the mean and standard derivation of the criterion across all points of the cloud. Default: 1.
numberOfNeighborsNumber of neighbors in the neighborhood used to determine if a point is filtered or not. Default: 10
methodEPointCloudFilteringMethod used to select the points to filter.

Default: EPointCloudFilteringMethod::EPointCloudFilteringMethod_HighStandardDerivation.

◆ EPointCloudFilter() [3/7]

eVision::Easy3D::EPointCloudFilter::EPointCloudFilter ( float thresholdMultiplier,
uint32_t numberOfNeighbors )

Creates an EPointCloudFilter object to filter out some points in an EPointCloud.

Parameters
thresholdMultiplierPoints whose criterion is greater than mean + thresholdMultiplier * stddev are removed, mean and stddev being the mean and standard derivation of the criterion across all points of the cloud. Default: 1.
numberOfNeighborsNumber of neighbors in the neighborhood used to determine if a point is filtered or not. Default: 10

◆ EPointCloudFilter() [4/7]

eVision::Easy3D::EPointCloudFilter::EPointCloudFilter ( float thresholdMultiplier)

Creates an EPointCloudFilter object to filter out some points in an EPointCloud.

Parameters
thresholdMultiplierPoints whose criterion is greater than mean + thresholdMultiplier * stddev are removed, mean and stddev being the mean and standard derivation of the criterion across all points of the cloud. Default: 1.

◆ EPointCloudFilter() [5/7]

eVision::Easy3D::EPointCloudFilter::EPointCloudFilter ( )

Creates an EPointCloudFilter object to filter out some points in an EPointCloud.

◆ EPointCloudFilter() [6/7]

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

Creates an EPointCloudFilter object to filter out some points in an EPointCloud.

Parameters
otherThe point cloud filterer we copy from.

◆ ~EPointCloudFilter()

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

◆ EPointCloudFilter() [7/7]

eVision::Easy3D::EPointCloudFilter::EPointCloudFilter ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Filter()

void eVision::Easy3D::EPointCloudFilter::Filter ( const eVision::Easy3D::EPointCloud & cloudIn,
eVision::Easy3D::EPointCloud & cloudOut ) const

Filters the input point cloud and puts the result of the operation in the output point cloud.

Parameters
cloudInInput point cloud that will be filtered
cloudOutOutput point cloud that has been filtered

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

◆ GetFilteringMethod()

eVision::Easy3D::EPointCloudFilteringMethod eVision::Easy3D::EPointCloudFilter::GetFilteringMethod ( ) const

Sets/Gets the filtering method.

◆ GetNumberOfNeighbors()

uint32_t eVision::Easy3D::EPointCloudFilter::GetNumberOfNeighbors ( ) const

Sets/Gets the number of neighbors.

◆ GetReplaceByAverage()

bool eVision::Easy3D::EPointCloudFilter::GetReplaceByAverage ( ) const

Sets/Gets whether to replace filtered points by their average.

◆ GetThresholdMultiplier()

float eVision::Easy3D::EPointCloudFilter::GetThresholdMultiplier ( ) const

Sets/Gets the filtering threshold multiplier.

◆ Load() [1/2]

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

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

Parameters
pathThe file path.

◆ Load() [2/2]

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

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

Parameters
serializerThe ESerializer object that is read from

◆ operator=()

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

Assignment operator.

Parameters
otherAn other EPointCloudFilter.

◆ Save() [1/2]

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

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

Parameters
pathThe file path.

◆ Save() [2/2]

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

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

Parameters
serializerThe ESerializer object that is written to

◆ SetFilteringMethod()

void eVision::Easy3D::EPointCloudFilter::SetFilteringMethod ( eVision::Easy3D::EPointCloudFilteringMethod method)

Sets/Gets the filtering method.

Parameters
methodEPointCloudFilteringMethod used to select the points to filter.

◆ SetNumberOfNeighbors()

void eVision::Easy3D::EPointCloudFilter::SetNumberOfNeighbors ( uint32_t numberOfNeighbors)

Sets/Gets the number of neighbors.

Parameters
numberOfNeighborsNumber of neighbors in the neighborhood used to determine if a point will be filtered or not.

◆ SetReplaceByAverage()

void eVision::Easy3D::EPointCloudFilter::SetReplaceByAverage ( bool replaceByAverage)

Sets/Gets whether to replace filtered points by their average.

Parameters
replaceByAverageSet to true to replace points to filter out by the mean of their neighborhood instead of removing them. Default: false

◆ SetThresholdMultiplier()

void eVision::Easy3D::EPointCloudFilter::SetThresholdMultiplier ( float thresholdMultiplier)

Sets/Gets the filtering threshold multiplier.

Parameters
thresholdMultiplierPoints whose criterion is greater than mean + thresholdMultiplier * stddev are removed, mean and stddev being the mean and standard derivation of the criterion across all points of the cloud.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Easy3D::EPointCloudFilter::wrappedClass_