PCL
pcl::Resample Class Reference

Image resampling algorithm. More...

#include <Resample.h>

+ Inheritance diagram for pcl::Resample:

Public Types

typedef AbsoluteResizeMode::value_type abs_resize_mode
 
typedef ResizeMode::value_type resize_mode
 

Public Member Functions

 Resample (PixelInterpolation &p, double scale=1.0)
 
 Resample (PixelInterpolation &p, double scaleX, double scaleY)
 
 Resample (const Resample &)=default
 
abs_resize_mode AbsMode () const
 
void GetNewSizes (int &width, int &height) const override
 
void GetScalingFactors (double &sx, double &sy) const
 
void GetSizes (double &width, double &height) const
 
bool IsAbsolute () const
 
bool IsRelative () const
 
resize_mode Mode () const
 
void SetAbsMode (abs_resize_mode absMode)
 
void SetMode (resize_mode mode)
 
void SetScalingFactors (double sx, double sy)
 
void SetSizes (double width, double height)
 
void SetXScale (double sx)
 
void SetXSize (double width)
 
void SetYScale (double sy)
 
void SetYSize (double height)
 
double XScale () const
 
double XSize () const
 
double YScale () const
 
double YSize () const
 
- Public Member Functions inherited from pcl::InterpolatingGeometricTransformation
 InterpolatingGeometricTransformation (PixelInterpolation &p)
 
 InterpolatingGeometricTransformation (const InterpolatingGeometricTransformation &)=default
 
 InterpolatingGeometricTransformation (InterpolatingGeometricTransformation &&x)
 
void DisableUnclippedInterpolation (bool disable=true)
 
void EnableUnclippedInterpolation (bool enable=true)
 
const PixelInterpolationInterpolation () const
 
PixelInterpolationInterpolation ()
 
InterpolatingGeometricTransformationoperator= (const InterpolatingGeometricTransformation &)=default
 
InterpolatingGeometricTransformationoperator= (InterpolatingGeometricTransformation &&x)
 
void SetInterpolation (PixelInterpolation &p)
 
bool UsingUnclippedInterpolation () const
 
- Public Member Functions inherited from pcl::GeometricTransformation
 GeometricTransformation ()=default
 
 GeometricTransformation (const GeometricTransformation &)=default
 
virtual ~GeometricTransformation ()
 
- Public Member Functions inherited from pcl::ImageTransformation
 ImageTransformation ()=default
 
 ImageTransformation (const ImageTransformation &)=default
 
virtual ~ImageTransformation ()
 
template<class P >
GenericImage< P > & operator>> (GenericImage< P > &image) const
 
ImageVariantoperator>> (ImageVariant &image) const
 
- Public Member Functions inherited from pcl::ImageResolution
 ImageResolution ()
 
 ImageResolution (const ImageResolution &x)
 
void GetResolution (double &x, double &y)
 
double HorizontalResolution () const
 
bool IsMetricResolution () const
 
ImageResolutionoperator= (const ImageResolution &x)
 
double Resolution () const
 
void SetMetricResolution (bool m)
 
void SetResolution (double x, double y)
 
void SetResolution (double r)
 
double VerticalResolution () const
 
- Public Member Functions inherited from pcl::ParallelProcess
 ParallelProcess ()=default
 
 ParallelProcess (const ParallelProcess &)=default
 
void DisableParallelProcessing (bool disable=true)
 
void EnableParallelProcessing (bool enable=true, int maxProcessors=0)
 
bool IsParallelProcessingEnabled () const
 
int MaxProcessors () const
 
ParallelProcessoperator= (const ParallelProcess &)=default
 
void SetMaxProcessors (int maxProcessors)
 
void Swap (ParallelProcess &process)
 

Protected Member Functions

void Apply (pcl::Image &) const override
 
void Apply (pcl::DImage &) const override
 
void Apply (pcl::UInt8Image &) const override
 
void Apply (pcl::UInt16Image &) const override
 
void Apply (pcl::UInt32Image &) const override
 
- Protected Member Functions inherited from pcl::ImageTransformation
virtual void Apply (pcl::ComplexImage &image) const
 
virtual void Apply (pcl::DComplexImage &image) const
 

Detailed Description

TODO: Write a detailed description for Resample

Definition at line 133 of file Resample.h.

Member Typedef Documentation

◆ abs_resize_mode

typedef AbsoluteResizeMode::value_type pcl::Resample::abs_resize_mode

Represents an absolute resizing mode.

Definition at line 147 of file Resample.h.

◆ resize_mode

typedef ResizeMode::value_type pcl::Resample::resize_mode

Represents a resizing mode.

Definition at line 142 of file Resample.h.

Constructor & Destructor Documentation

◆ Resample() [1/3]

pcl::Resample::Resample ( PixelInterpolation p,
double  scale = 1.0 
)
inline

Constructs a default Resample object using the specified pixel interpolation p and a single scaling ratio for both axes.

The specified pixel interpolation object p must remain valid while this object exists.

The resizing mode is set relative to current image dimensions.

Definition at line 158 of file Resample.h.

◆ Resample() [2/3]

pcl::Resample::Resample ( PixelInterpolation p,
double  scaleX,
double  scaleY 
)
inline

Constructs a default Resample object using the specified pixel interpolation p and separate scaling ratios for the X and Y axes, scaleX and scaleY respectively.

The specified pixel interpolation object p must remain valid while this object exists.

The resizing mode is set relative to current image dimensions.

Definition at line 174 of file Resample.h.

◆ Resample() [3/3]

pcl::Resample::Resample ( const Resample )
default

Copy constructor.

Member Function Documentation

◆ AbsMode()

abs_resize_mode pcl::Resample::AbsMode ( ) const
inline

Returns the current absolute resizing mode. The absolute resizing mode is only applied when Mode() is not equal to ResizeMode::RelativeDimensions.

Definition at line 364 of file Resample.h.

◆ Apply() [1/5]

void pcl::Resample::Apply ( pcl::Image image) const
overrideprotectedvirtual

Applies this transformation to a 32-bit floating point image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [2/5]

void pcl::Resample::Apply ( pcl::DImage image) const
overrideprotectedvirtual

Applies this transformation to a 64-bit floating point image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [3/5]

void pcl::Resample::Apply ( pcl::UInt8Image image) const
overrideprotectedvirtual

Applies this transformation to an 8-bit unsigned integer image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [4/5]

void pcl::Resample::Apply ( pcl::UInt16Image image) const
overrideprotectedvirtual

Applies this transformation to a 16-bit unsigned integer image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [5/5]

void pcl::Resample::Apply ( pcl::UInt32Image image) const
overrideprotectedvirtual

Applies this transformation to a 32-bit unsigned integer image.

Reimplemented from pcl::ImageTransformation.

◆ GetNewSizes()

void pcl::Resample::GetNewSizes ( int &  width,
int &  height 
) const
overridevirtual

Predicts transformed image dimensions.

Parameters
[in,out]widthReference to a variable whose value is a horizontal dimension in pixels (width). On output, it will receive the predicted horizontal dimension after the transformation.
[in,out]heightReference to a variable whose value is a vertical dimension in pixels (height). On output, it will receive the predicted vertical dimension after the transformation.
Note
This is a pure virtual member function that must be reimplemented in every derived class.

Implements pcl::GeometricTransformation.

◆ GetScalingFactors()

void pcl::Resample::GetScalingFactors ( double &  sx,
double &  sy 
) const
inline

Gets the scaling factors sx and sy for the X and Y axes, respectively.

Use GetScalingFactors(), XScale() and YScale() semantics to define a Resample instance that resizes images relative to their current dimensions.

Definition at line 259 of file Resample.h.

◆ GetSizes()

void pcl::Resample::GetSizes ( double &  width,
double &  height 
) const
inline

Gets the resampled image width and height.

Use GetSizes(), XSize() and YSize() semantics to define a Resample instance that resizes images to fixed dimensions.

Definition at line 191 of file Resample.h.

◆ IsAbsolute()

bool pcl::Resample::IsAbsolute ( ) const
inline

Returns true iff this Resample object resizes images to fixed dimensions, i.e. when Mode() is not equal to ResizeMode::RelativeDimensions.

Definition at line 347 of file Resample.h.

◆ IsRelative()

bool pcl::Resample::IsRelative ( ) const
inline

Returns true iff this Resample object resizes images relative to their current dimensions, i.e. when Mode() is equal to ResizeMode::RelativeDimensions.

Definition at line 338 of file Resample.h.

◆ Mode()

resize_mode pcl::Resample::Mode ( ) const
inline

Returns the current resize mode.

Definition at line 328 of file Resample.h.

◆ SetAbsMode()

void pcl::Resample::SetAbsMode ( abs_resize_mode  absMode)
inline

Sets the absolute resizing mode. The absolute resizing mode is only applied when Mode() is not equal to ResizeMode::RelativeDimensions.

Definition at line 373 of file Resample.h.

References pcl::Apply().

◆ SetMode()

void pcl::Resample::SetMode ( resize_mode  mode)
inline

Sets the current resize mode.

Definition at line 355 of file Resample.h.

◆ SetScalingFactors()

void pcl::Resample::SetScalingFactors ( double  sx,
double  sy 
)
inline

Sets the scaling factors sx and sy for the X and Y axes, respectively.

Use SetScalingFactors(), SetXScale() and SetYScale() semantics to define a Resample instance that resizes images relative to their current dimensions.

Definition at line 296 of file Resample.h.

◆ SetSizes()

void pcl::Resample::SetSizes ( double  width,
double  height 
)
inline

Sets the resampled image width and height.

Use SetSizes(), SetXSize() and SetYSize() semantics to define a Resample instance that resizes images to fixed dimensions.

Definition at line 224 of file Resample.h.

◆ SetXScale()

void pcl::Resample::SetXScale ( double  sx)
inline

Sets the horizontal scaling factor.

Use SetScalingFactors(), SetXScale() and SetYScale() semantics to define a Resample instance that resizes images relative to their current dimensions.

Definition at line 308 of file Resample.h.

◆ SetXSize()

void pcl::Resample::SetXSize ( double  width)
inline

Sets the resampled image width.

Use SetSizes(), SetXSize() and SetYSize() semantics to define a Resample instance that resizes images to fixed dimensions.

Definition at line 235 of file Resample.h.

◆ SetYScale()

void pcl::Resample::SetYScale ( double  sy)
inline

Sets the vertical scaling factor.

Use SetScalingFactors(), SetXScale() and SetYScale() semantics to define a Resample instance that resizes images relative to their current dimensions.

Definition at line 320 of file Resample.h.

◆ SetYSize()

void pcl::Resample::SetYSize ( double  height)
inline

Sets the resampled image height.

Use SetSizes(), SetXSize() and SetYSize() semantics to define a Resample instance that resizes images to fixed dimensions.

Definition at line 246 of file Resample.h.

◆ XScale()

double pcl::Resample::XScale ( ) const
inline

Returns the horizontal scaling factor.

Use GetScalingFactors(), XScale() and YScale() semantics to define a Resample instance that resizes images relative to their current dimensions.

Definition at line 271 of file Resample.h.

◆ XSize()

double pcl::Resample::XSize ( ) const
inline

Returns the resampled image width.

Use GetSizes(), XSize() and YSize() semantics to define a Resample instance that resizes images to fixed dimensions.

Definition at line 202 of file Resample.h.

◆ YScale()

double pcl::Resample::YScale ( ) const
inline

Returns the vertical scaling factor.

Use GetScalingFactors(), XScale() and YScale() semantics to define a Resample instance that resizes images relative to their current dimensions.

Definition at line 283 of file Resample.h.

◆ YSize()

double pcl::Resample::YSize ( ) const
inline

Returns the resampled image height.

Use GetSizes(), XSize() and YSize() semantics to define a Resample instance that resizes images to fixed dimensions.

Definition at line 213 of file Resample.h.


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