Point Cloud Library (PCL)  1.3.1
Public Types | Public Member Functions
pcl::PointRepresentation Class Reference

PointRepresentation provides a set of methods for converting a point structs/object into an n-dimensional vector. More...

#include <pcl/point_representation.h>

List of all members.

Public Types

typedef boost::shared_ptr
< PointRepresentation< PointT > > 
Ptr
typedef boost::shared_ptr
< const PointRepresentation
< PointT > > 
ConstPtr

Public Member Functions

 PointRepresentation ()
 Empty constructor.
virtual void copyToFloatArray (const PointT &p, float *out) const =0
 Copy point data from input point to a float array.
virtual bool isValid (const PointT &p) const
 Verify that the input point is valid.
template<typename OutputType >
void vectorize (const PointT &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

PointRepresentation provides a set of methods for converting a point structs/object into an n-dimensional vector.

Note:
This is an abstract class. Subclasses must set nr_dimensions_ to the appropriate value in the constructor and provide an implemention of the pure virtual copyToFloatArray method.
Author:
Michael Dixon

Member Typedef Documentation

typedef boost::shared_ptr<const PointRepresentation<PointT> > pcl::PointRepresentation::ConstPtr
typedef boost::shared_ptr<PointRepresentation<PointT> > pcl::PointRepresentation::Ptr

Constructor & Destructor Documentation

pcl::PointRepresentation::PointRepresentation ( ) [inline]

Empty constructor.

Definition at line 68 of file point_representation.h.


Member Function Documentation

virtual void pcl::PointRepresentation::copyToFloatArray ( const PointT &  p,
float *  out 
) const [pure virtual]

Copy point data from input point to a float array.

This method must be overriden in all subclasses.

Parameters:
[in]pThe input point
[out]outA pointer to a float array.
int pcl::PointRepresentation::getNumberOfDimensions ( ) const [inline]

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

Definition at line 131 of file point_representation.h.

virtual bool pcl::PointRepresentation::isValid ( const PointT &  p) const [inline, virtual]

Verify that the input point is valid.

Parameters:
pThe point to validate

Definition at line 80 of file point_representation.h.

void pcl::PointRepresentation::setRescaleValues ( const float *  rescale_array) [inline]

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 123 of file point_representation.h.

template<typename OutputType >
void pcl::PointRepresentation::vectorize ( const PointT &  p,
OutputType &  out 
) const [inline]

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 102 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