Point Cloud Library (PCL)  1.14.1-dev
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::io::PointCloudImageExtractorWithScaling< PointT > Class Template Reference

Image Extractor extension which provides functionality to apply scaling to the values extracted from a field. More...

#include <pcl/io/point_cloud_image_extractors.h>

+ Inheritance diagram for pcl::io::PointCloudImageExtractorWithScaling< PointT >:
+ Collaboration diagram for pcl::io::PointCloudImageExtractorWithScaling< PointT >:

Public Types

enum  ScalingMethod { SCALING_NO , SCALING_FULL_RANGE , SCALING_FIXED_FACTOR }
 Different scaling methods. More...
 
using Ptr = shared_ptr< PointCloudImageExtractorWithScaling< PointT > >
 
using ConstPtr = shared_ptr< const PointCloudImageExtractorWithScaling< PointT > >
 
- Public Types inherited from pcl::io::PointCloudImageExtractor< PointT >
using PointCloud = pcl::PointCloud< PointT >
 
using Ptr = shared_ptr< PointCloudImageExtractor< PointT > >
 
using ConstPtr = shared_ptr< const PointCloudImageExtractor< PointT > >
 

Public Member Functions

 PointCloudImageExtractorWithScaling (const std::string &field_name, const ScalingMethod scaling_method)
 Constructor. More...
 
 PointCloudImageExtractorWithScaling (const std::string &field_name, const float scaling_factor)
 Constructor. More...
 
 ~PointCloudImageExtractorWithScaling () override=default
 Destructor. More...
 
void setScalingMethod (const ScalingMethod scaling_method)
 Set scaling method. More...
 
void setScalingFactor (const float scaling_factor)
 Set fixed scaling factor. More...
 
- Public Member Functions inherited from pcl::io::PointCloudImageExtractor< PointT >
 PointCloudImageExtractor ()=default
 Constructor. More...
 
virtual ~PointCloudImageExtractor ()=default
 Destructor. More...
 
bool extract (const PointCloud &cloud, pcl::PCLImage &image) const
 Obtain the image from the given cloud. More...
 
void setPaintNaNsWithBlack (bool flag)
 Set a flag that controls if image pixels corresponding to NaN (infinite) points should be painted black. More...
 

Protected Member Functions

bool extractImpl (const PointCloud &cloud, pcl::PCLImage &image) const override
 Implementation of the extract() function, has to be implemented in deriving classes. More...
 

Protected Attributes

std::string field_name_
 
ScalingMethod scaling_method_
 
float scaling_factor_
 
- Protected Attributes inherited from pcl::io::PointCloudImageExtractor< PointT >
bool paint_nans_with_black_ {false}
 A flag that controls if image pixels corresponding to NaN (infinite) points should be painted black. More...
 

Detailed Description

template<typename PointT>
class pcl::io::PointCloudImageExtractorWithScaling< PointT >

Image Extractor extension which provides functionality to apply scaling to the values extracted from a field.

Author
Sergey Alexandrov

Definition at line 129 of file point_cloud_image_extractors.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 135 of file point_cloud_image_extractors.h.

◆ Ptr

Definition at line 134 of file point_cloud_image_extractors.h.

Member Enumeration Documentation

◆ ScalingMethod

Different scaling methods.

  • SCALING_NO - no scaling.
  • SCALING_FULL_RANGE - scales to full range of the output value.
  • SCASING_FIXED_FACTOR - scales by a given fixed factor.
Enumerator
SCALING_NO 
SCALING_FULL_RANGE 
SCALING_FIXED_FACTOR 

Definition at line 144 of file point_cloud_image_extractors.h.

Constructor & Destructor Documentation

◆ PointCloudImageExtractorWithScaling() [1/2]

template<typename PointT >
pcl::io::PointCloudImageExtractorWithScaling< PointT >::PointCloudImageExtractorWithScaling ( const std::string &  field_name,
const ScalingMethod  scaling_method 
)
inline

Constructor.

Definition at line 152 of file point_cloud_image_extractors.h.

◆ PointCloudImageExtractorWithScaling() [2/2]

template<typename PointT >
pcl::io::PointCloudImageExtractorWithScaling< PointT >::PointCloudImageExtractorWithScaling ( const std::string &  field_name,
const float  scaling_factor 
)
inline

Constructor.

Definition at line 160 of file point_cloud_image_extractors.h.

◆ ~PointCloudImageExtractorWithScaling()

Destructor.

Member Function Documentation

◆ extractImpl()

template<typename PointT >
bool pcl::io::PointCloudImageExtractorWithScaling< PointT >::extractImpl ( const PointCloud cloud,
pcl::PCLImage image 
) const
overrideprotectedvirtual

◆ setScalingFactor()

template<typename PointT >
void pcl::io::PointCloudImageExtractorWithScaling< PointT >::setScalingFactor ( const float  scaling_factor)
inline

Set fixed scaling factor.

Definition at line 179 of file point_cloud_image_extractors.h.

References pcl::io::PointCloudImageExtractorWithScaling< PointT >::scaling_factor_.

◆ setScalingMethod()

template<typename PointT >
void pcl::io::PointCloudImageExtractorWithScaling< PointT >::setScalingMethod ( const ScalingMethod  scaling_method)
inline

Member Data Documentation

◆ field_name_

template<typename PointT >
std::string pcl::io::PointCloudImageExtractorWithScaling< PointT >::field_name_
protected

Definition at line 189 of file point_cloud_image_extractors.h.

◆ scaling_factor_

template<typename PointT >
float pcl::io::PointCloudImageExtractorWithScaling< PointT >::scaling_factor_
protected

◆ scaling_method_

template<typename PointT >
ScalingMethod pcl::io::PointCloudImageExtractorWithScaling< PointT >::scaling_method_
protected

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