Point Cloud Library (PCL)  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions
pcl::CustomPointRepresentation< PointDefault > Class Template Reference

CustomPointRepresentation extends PointRepresentation to allow for sub-part selection on the point. More...

#include <pcl/point_representation.h>

Inheritance diagram for pcl::CustomPointRepresentation< PointDefault >:
Inheritance graph
[legend]
Collaboration diagram for pcl::CustomPointRepresentation< PointDefault >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef boost::shared_ptr
< CustomPointRepresentation
< PointDefault > > 
Ptr
typedef boost::shared_ptr
< const
CustomPointRepresentation
< PointDefault > > 
ConstPtr

Public Member Functions

 CustomPointRepresentation (const int max_dim=3, const int start_dim=0)
 Constructor.
Ptr makeShared () const
virtual void copyToFloatArray (const PointDefault &p, float *out) const
 Copy the point data into a float array.
bool isTrivial () const
 Returns whether this point representation is trivial.
virtual bool isValid (const PointDefault &p) const
 Verify that the input point is valid.
void vectorize (const PointDefault &p, OutputType &out) const
 Convert input point into a vector representation, rescaling by alpha.
void setRescaleValues (const float *rescale_array)
 Set the rescale values to use when vectorizing points.
int getNumberOfDimensions () const
 Return the number of dimensions in the point's vector representation.

Detailed Description

template<typename PointDefault>
class pcl::CustomPointRepresentation< PointDefault >

CustomPointRepresentation extends PointRepresentation to allow for sub-part selection on the point.

Definition at line 503 of file point_representation.h.


Member Typedef Documentation

template<typename PointDefault >
typedef boost::shared_ptr<const CustomPointRepresentation<PointDefault> > pcl::CustomPointRepresentation< PointDefault >::ConstPtr

Reimplemented from pcl::PointRepresentation< PointDefault >.

Definition at line 510 of file point_representation.h.

template<typename PointDefault >
typedef boost::shared_ptr<CustomPointRepresentation<PointDefault> > pcl::CustomPointRepresentation< PointDefault >::Ptr

Reimplemented from pcl::PointRepresentation< PointDefault >.

Definition at line 509 of file point_representation.h.


Constructor & Destructor Documentation

template<typename PointDefault >
pcl::CustomPointRepresentation< PointDefault >::CustomPointRepresentation ( const int  max_dim = 3,
const int  start_dim = 0 
) [inline]

Constructor.

Parameters:
[in]max_dimthe maximum number of dimensions to use
[in]start_dimthe starting dimension

Definition at line 516 of file point_representation.h.


Member Function Documentation

template<typename PointDefault >
virtual void pcl::CustomPointRepresentation< PointDefault >::copyToFloatArray ( const PointDefault &  p,
float *  out 
) const [inline, virtual]

Copy the point data into a float array.

Parameters:
[in]pthe input point
[out]outthe resultant output array

Implements pcl::PointRepresentation< PointDefault >.

Definition at line 537 of file point_representation.h.

int pcl::PointRepresentation< PointDefault >::getNumberOfDimensions ( ) const [inline, inherited]

Return the number of dimensions in the point's vector representation.

Definition at line 171 of file point_representation.h.

bool pcl::PointRepresentation< PointDefault >::isTrivial ( ) const [inline, inherited]

Returns whether this point representation is trivial.

It is trivial if and only if the following conditions hold:

  • the relevant data consists only of float values
  • the vectorize operation directly copies the first nr_dimensions_ elements of PointT to the out array
  • sizeof(PointT) is a multiple of sizeof(float) In short, a trivial point representation converts the input point to a float array that is the same as if the point was reinterpret_casted to a float array of length nr_dimensions_ .

Definition at line 96 of file point_representation.h.

virtual bool pcl::PointRepresentation< PointDefault >::isValid ( const PointDefault &  p) const [inline, virtual, inherited]

Verify that the input point is valid.

Parameters:
pThe point to validate

Definition at line 102 of file point_representation.h.

template<typename PointDefault >
Ptr pcl::CustomPointRepresentation< PointDefault >::makeShared ( ) const [inline]

Definition at line 527 of file point_representation.h.

void pcl::PointRepresentation< PointDefault >::setRescaleValues ( const float *  rescale_array) [inline, inherited]

Set the rescale values to use when vectorizing points.

Parameters:
[in]rescale_arrayThe array/vector of rescale values. Can be of any type that implements the [] operator.

Definition at line 163 of file point_representation.h.

void pcl::PointRepresentation< PointDefault >::vectorize ( const PointDefault &  p,
OutputType &  out 
) const [inline, inherited]

Convert input point into a vector representation, rescaling by alpha.

Parameters:
[in]pthe input point
[out]outThe output vector. Can be of any type that implements the [] operator.

Definition at line 142 of file point_representation.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines