MLPCLBaseObjectWrapper Class Reference

This class is an object wrapper for MultiFileVolume objects for Python. More...

#include <mlPCLBaseObjectWrapper.h>

Inheritance diagram for MLPCLBaseObjectWrapper:

Public Slots
size_t	getPCLMajorVersion () const
	\script
size_t	getPCLMinorVersion () const
	Returns the minor PCL version.
size_t	getPCLRevisionVersion () const
	Returns the revision of the PCL version.
QString	getPCLVersionString () const
	Returns the PCL version string, for example "1.8.0" or "1.12.1".
bool	hasValidPointCloudPointer () const
	Returns whether the PCL base object contains a valid point cloud.
bool	hasValidPolygonMeshPointer () const
	Returns whether the PCL base object contains a valid polygon mesh.
bool	hasValidPCLObjectPointer () const
	Returns whether the PCL base object contains any valid pcl object mesh.
bool	isXYZPointCloud () const
	Returns true if the point cloud is a XYZ point cloud, otherwise false.
bool	isXYZLNormalPointCloud () const
	Returns true if the point cloud is a XYZLNormal point cloud, otherwise false.
bool	isXYZRGBNormalPointCloud () const
	Returns true if the point cloud is a XYZRGBNormal point cloud, otherwise false.
bool	isXYZINormalPointCloud () const
	Returns true if the point cloud is a XYZINormal point cloud, otherwise false.
bool	isPolygonMesh () const
	Returns true if the object in the wrapper is a polygon mesh, otherwise false.
void	clearPCLObjectPointers ()
	Frees the actual pcl object if there is any.
void	createEmptyXYZPointCloud ()
	Clears any object and creates an empty XYZ point cloud.
void	createEmptyXYZLNormalPointCloud ()
	Clears any object and creates an empty XYZLNormal point cloud.
void	createEmptyXYZRGBNormalPointCloud ()
	Clears any object and creates an empty XYZRGBNormal point cloud.
void	createEmptyXYZINormalPointCloud ()
	Clears any object and creates an empty XYZINormal point cloud.
void	createEmptyPolygonMesh ()
	Clears any object and creates an empty polygon mesh.
void	resizePointCloud (size_t newNumEntries)
	Resizes the point cloud to newNumEntries number of points.
size_t	getNumberOfPoints () const
	Returns the number of points of the point cloud.
size_t	getWidth () const
	Returns the width member of the point cloud.
size_t	getHeight () const
	Returns the height member of the point cloud.
bool	getIsDense () const
	Returns the is_dense member of the point cloud.
bool	getIsOrganized () const
	Returns the return value of isOrganized member function of the point cloud.
void	setIntensityReplacement (size_t idx, float replVal)
	Sets the point member value to repl which is the most appropriate to be considered as intensity; if no appropriate members exists then the call is ignored.
float	getIntensityReplacement (size_t idx) const
	Returns the point member value which is the most appropriate to be considered as intensity; if no appropriate members exists then 0 is returned.
float	getPointMemberX (size_t idx) const
float	getPointMemberY (size_t idx) const
float	getPointMemberZ (size_t idx) const
float	getPointMemberNormalX (size_t idx) const
float	getPointMemberNormalY (size_t idx) const
float	getPointMemberNormalZ (size_t idx) const
float	getPointMemberCurvature (size_t idx) const
float	getPointMemberRGBAAsFloat (size_t idx) const
float	getPointMemberIntensity (size_t idx) const
quint32	getPointMemberRGBAAsInt (size_t idx) const
quint32	getPointMemberLabel (size_t idx) const
void	setPointMemberXYZ (size_t idx, float x, float y, float z)
void	setPointMemberXYZIntensityReplacement (size_t idx, float x, float y, float z, float val)
void	setPointMemberNormalXYZ (size_t idx, float x, float y, float z)
void	setPointMemberXYZIntensityReplacement (PyObject *x, PyObject *y, PyObject *z, PyObject *val)
void	setPointMemberX (size_t idx, float val)
void	setPointMemberY (size_t idx, float val)
void	setPointMemberZ (size_t idx, float val)
void	setPointMemberNormalX (size_t idx, float val)
void	setPointMemberNormalY (size_t idx, float val)
void	setPointMemberNormalZ (size_t idx, float val)
void	setPointMemberCurvature (size_t idx, float val)
void	setPointMemberIntensity (size_t idx, float val)
void	setPointMemberRGBAAsFloat (size_t idx, float val)
void	setPointMemberRGBAAsInt (size_t idx, quint32 val)
void	setPointMemberLabel (size_t idx, quint32 val)
Access to indices.
\script Returns the number index sets in the vector of index sets.
size_t	getNumberOfIndexSetsInIndexVector () const
size_t	getNumberOfIndicesInNthIndexVector (size_t nthIndexSet) const
	Returns the number indices in the nthIndexSet index set of the vector of index sets; accesses out of range will except.
size_t	getNumberOfComposedIndices () const
	Return number of total indices in all index sets in the vector of index sets.
void	resizeVectorOfIndexVectors (size_t numIndexVectors)
	Resize vector of index vectors to have numIndexVectors entries; resize is performed as std::vector resize.
void	resizeNthVectorOfIndexVectors (size_t nthIndexSet, size_t numIndices)
	Resize nth entry of vector of index vectors to have numIndices entries; resize is performed as std::vector resize and accesses out of range will except.
void	clearVectorOfIndexVectors ()
	Clear entire vector of index vectors to have 0 entries.
int	getIndex (size_t idxVecIdx, size_t idx) const
	Returns index idx in nth entry of vector of index; accesses out of range will except.
void	setIndex (size_t idxVecIdx, size_t idx, int newVal)
	Set index idx in nth entry of vector of index vectors to newVal; accesses out of range will except.
void	setIndexSet (size_t idxVecIdx, PyObject *idxSet)
	Set the nthIndexSet to the numpy array newIdxSet; idxVecIdx accesses out of range will except.

Public Member Functions
	MLPCLBaseObjectWrapper (ml::PCLBaseObject *pclBaseObject)
	\script Constructor.
	~MLPCLBaseObjectWrapper () override
	\script Destructor.

Detailed Description

This class is an object wrapper for MultiFileVolume objects for Python.

\script

Definition at line 28 of file mlPCLBaseObjectWrapper.h.

Constructor & Destructor Documentation

MLPCLBaseObjectWrapper()

MLPCLBaseObjectWrapper::MLPCLBaseObjectWrapper

(

ml::PCLBaseObject *

pclBaseObject

)

\script Constructor.

~MLPCLBaseObjectWrapper()

MLPCLBaseObjectWrapper::~MLPCLBaseObjectWrapper ( )

override

\script Destructor.

Member Function Documentation

clearPCLObjectPointers

void MLPCLBaseObjectWrapper::clearPCLObjectPointers ( )

slot

Frees the actual pcl object if there is any.

clearVectorOfIndexVectors

void MLPCLBaseObjectWrapper::clearVectorOfIndexVectors ( )

slot

Clear entire vector of index vectors to have 0 entries.

createEmptyPolygonMesh

void MLPCLBaseObjectWrapper::createEmptyPolygonMesh ( )

slot

Clears any object and creates an empty polygon mesh.

createEmptyXYZINormalPointCloud

void MLPCLBaseObjectWrapper::createEmptyXYZINormalPointCloud ( )

slot

Clears any object and creates an empty XYZINormal point cloud.

createEmptyXYZLNormalPointCloud

void MLPCLBaseObjectWrapper::createEmptyXYZLNormalPointCloud ( )

slot

Clears any object and creates an empty XYZLNormal point cloud.

createEmptyXYZPointCloud

void MLPCLBaseObjectWrapper::createEmptyXYZPointCloud ( )

slot

Clears any object and creates an empty XYZ point cloud.

createEmptyXYZRGBNormalPointCloud

void MLPCLBaseObjectWrapper::createEmptyXYZRGBNormalPointCloud ( )

slot

Clears any object and creates an empty XYZRGBNormal point cloud.

getHeight

size_t MLPCLBaseObjectWrapper::getHeight ( ) const

slot

Returns the height member of the point cloud.

getIndex

int MLPCLBaseObjectWrapper::getIndex ( size_t  idxVecIdx, size_t  idx  ) const

slot

Returns index idx in nth entry of vector of index; accesses out of range will except.

getIntensityReplacement

float MLPCLBaseObjectWrapper::getIntensityReplacement ( size_t  idx ) const

slot

Returns the point member value which is the most appropriate to be considered as intensity; if no appropriate members exists then 0 is returned.

getIsDense

bool MLPCLBaseObjectWrapper::getIsDense ( ) const

slot

Returns the is_dense member of the point cloud.

getIsOrganized

bool MLPCLBaseObjectWrapper::getIsOrganized ( ) const

slot

Returns the return value of isOrganized member function of the point cloud.

getNumberOfComposedIndices

size_t MLPCLBaseObjectWrapper::getNumberOfComposedIndices ( ) const

slot

Return number of total indices in all index sets in the vector of index sets.

getNumberOfIndexSetsInIndexVector

size_t MLPCLBaseObjectWrapper::getNumberOfIndexSetsInIndexVector ( ) const

slot

getNumberOfIndicesInNthIndexVector

size_t MLPCLBaseObjectWrapper::getNumberOfIndicesInNthIndexVector ( size_t  nthIndexSet ) const

slot

Returns the number indices in the nthIndexSet index set of the vector of index sets; accesses out of range will except.

getNumberOfPoints

size_t MLPCLBaseObjectWrapper::getNumberOfPoints ( ) const

slot

Returns the number of points of the point cloud.

getPCLMajorVersion

size_t MLPCLBaseObjectWrapper::getPCLMajorVersion ( ) const

slot

\script

Returns the major PCL version.

getPCLMinorVersion

size_t MLPCLBaseObjectWrapper::getPCLMinorVersion ( ) const

slot

Returns the minor PCL version.

getPCLRevisionVersion

size_t MLPCLBaseObjectWrapper::getPCLRevisionVersion ( ) const

slot

Returns the revision of the PCL version.

getPCLVersionString

QString MLPCLBaseObjectWrapper::getPCLVersionString ( ) const

slot

Returns the PCL version string, for example "1.8.0" or "1.12.1".

getPointMemberCurvature

float MLPCLBaseObjectWrapper::getPointMemberCurvature ( size_t  idx ) const

slot

getPointMemberIntensity

float MLPCLBaseObjectWrapper::getPointMemberIntensity ( size_t  idx ) const

slot

getPointMemberLabel

quint32 MLPCLBaseObjectWrapper::getPointMemberLabel ( size_t  idx ) const

slot

getPointMemberNormalX

float MLPCLBaseObjectWrapper::getPointMemberNormalX ( size_t  idx ) const

slot

getPointMemberNormalY

float MLPCLBaseObjectWrapper::getPointMemberNormalY ( size_t  idx ) const

slot

getPointMemberNormalZ

float MLPCLBaseObjectWrapper::getPointMemberNormalZ ( size_t  idx ) const

slot

getPointMemberRGBAAsFloat

float MLPCLBaseObjectWrapper::getPointMemberRGBAAsFloat ( size_t  idx ) const

slot

getPointMemberRGBAAsInt

quint32 MLPCLBaseObjectWrapper::getPointMemberRGBAAsInt ( size_t  idx ) const

slot

getPointMemberX

float MLPCLBaseObjectWrapper::getPointMemberX ( size_t  idx ) const

slot

\script Returns the named member of point at position idx; for members which do not exist 0 is returned.

getPointMemberY

float MLPCLBaseObjectWrapper::getPointMemberY ( size_t  idx ) const

slot

getPointMemberZ

float MLPCLBaseObjectWrapper::getPointMemberZ ( size_t  idx ) const

slot

getWidth

size_t MLPCLBaseObjectWrapper::getWidth ( ) const

slot

Returns the width member of the point cloud.

hasValidPCLObjectPointer

bool MLPCLBaseObjectWrapper::hasValidPCLObjectPointer ( ) const

slot

Returns whether the PCL base object contains any valid pcl object mesh.

hasValidPointCloudPointer

bool MLPCLBaseObjectWrapper::hasValidPointCloudPointer ( ) const

slot

Returns whether the PCL base object contains a valid point cloud.

hasValidPolygonMeshPointer

bool MLPCLBaseObjectWrapper::hasValidPolygonMeshPointer ( ) const

slot

Returns whether the PCL base object contains a valid polygon mesh.

isPolygonMesh

bool MLPCLBaseObjectWrapper::isPolygonMesh ( ) const

slot

Returns true if the object in the wrapper is a polygon mesh, otherwise false.

isXYZINormalPointCloud

bool MLPCLBaseObjectWrapper::isXYZINormalPointCloud ( ) const

slot

Returns true if the point cloud is a XYZINormal point cloud, otherwise false.

isXYZLNormalPointCloud

bool MLPCLBaseObjectWrapper::isXYZLNormalPointCloud ( ) const

slot

Returns true if the point cloud is a XYZLNormal point cloud, otherwise false.

isXYZPointCloud

bool MLPCLBaseObjectWrapper::isXYZPointCloud ( ) const

slot

Returns true if the point cloud is a XYZ point cloud, otherwise false.

isXYZRGBNormalPointCloud

bool MLPCLBaseObjectWrapper::isXYZRGBNormalPointCloud ( ) const

slot

Returns true if the point cloud is a XYZRGBNormal point cloud, otherwise false.

resizeNthVectorOfIndexVectors

void MLPCLBaseObjectWrapper::resizeNthVectorOfIndexVectors ( size_t  nthIndexSet, size_t  numIndices  )

slot

Resize nth entry of vector of index vectors to have numIndices entries; resize is performed as std::vector resize and accesses out of range will except.

resizePointCloud

void MLPCLBaseObjectWrapper::resizePointCloud ( size_t  newNumEntries )

slot

Resizes the point cloud to newNumEntries number of points.

resizeVectorOfIndexVectors

void MLPCLBaseObjectWrapper::resizeVectorOfIndexVectors ( size_t  numIndexVectors )

slot

Resize vector of index vectors to have numIndexVectors entries; resize is performed as std::vector resize.

setIndex

void MLPCLBaseObjectWrapper::setIndex ( size_t  idxVecIdx, size_t  idx, int  newVal  )

slot

Set index idx in nth entry of vector of index vectors to newVal; accesses out of range will except.

setIndexSet

void MLPCLBaseObjectWrapper::setIndexSet ( size_t  idxVecIdx, PyObject *  idxSet  )

slot

Set the nthIndexSet to the numpy array newIdxSet; idxVecIdx accesses out of range will except.

setIntensityReplacement

void MLPCLBaseObjectWrapper::setIntensityReplacement ( size_t  idx, float  replVal  )

slot

Sets the point member value to repl which is the most appropriate to be considered as intensity; if no appropriate members exists then the call is ignored.

setPointMemberCurvature

void MLPCLBaseObjectWrapper::setPointMemberCurvature ( size_t  idx, float  val  )

slot

setPointMemberIntensity

void MLPCLBaseObjectWrapper::setPointMemberIntensity ( size_t  idx, float  val  )

slot

setPointMemberLabel

void MLPCLBaseObjectWrapper::setPointMemberLabel ( size_t  idx, quint32  val  )

slot

setPointMemberNormalX

void MLPCLBaseObjectWrapper::setPointMemberNormalX ( size_t  idx, float  val  )

slot

setPointMemberNormalXYZ

void MLPCLBaseObjectWrapper::setPointMemberNormalXYZ ( size_t  idx, float  x, float  y, float  z  )

slot

setPointMemberNormalY

void MLPCLBaseObjectWrapper::setPointMemberNormalY ( size_t  idx, float  val  )

slot

setPointMemberNormalZ

void MLPCLBaseObjectWrapper::setPointMemberNormalZ ( size_t  idx, float  val  )

slot

setPointMemberRGBAAsFloat

void MLPCLBaseObjectWrapper::setPointMemberRGBAAsFloat ( size_t  idx, float  val  )

slot

setPointMemberRGBAAsInt

void MLPCLBaseObjectWrapper::setPointMemberRGBAAsInt ( size_t  idx, quint32  val  )

slot

setPointMemberX

void MLPCLBaseObjectWrapper::setPointMemberX ( size_t  idx, float  val  )

slot

\script Sets the named member of point at position idx; if member does not exist the call is ignored.

setPointMemberXYZ

void MLPCLBaseObjectWrapper::setPointMemberXYZ ( size_t  idx, float  x, float  y, float  z  )

slot

\script Sets multiple members of the specified name of the point at position idx at the same time; if member does not exist the call is ignored.

setPointMemberXYZIntensityReplacement [1/2]

void MLPCLBaseObjectWrapper::setPointMemberXYZIntensityReplacement ( PyObject *  x, PyObject *  y, PyObject *  z, PyObject *  val  )

slot

\script Dedicated version expecting four one dimensional scalar and same sized numpy arrays containing x,y,z, and intensity replacement values.

setPointMemberXYZIntensityReplacement [2/2]

void MLPCLBaseObjectWrapper::setPointMemberXYZIntensityReplacement ( size_t  idx, float  x, float  y, float  z, float  val  )

slot

setPointMemberY

void MLPCLBaseObjectWrapper::setPointMemberY ( size_t  idx, float  val  )

slot

setPointMemberZ

void MLPCLBaseObjectWrapper::setPointMemberZ ( size_t  idx, float  val  )

slot

---

The documentation for this class was generated from the following file:

• FMEstable/PCL/Projects/MLPCLSupportWrappers/Sources/mlPCLBaseObjectWrapper.h