PCL
pcl::Translation Class Reference

Image translation algorithm. More...

#include <Translation.h>

+ Inheritance diagram for pcl::Translation:

Public Member Functions

 Translation (PixelInterpolation &p, double dx=0, double dy=0)
 
 Translation (PixelInterpolation &p, const DPoint &d)
 
 Translation (const Translation &)=default
 
const DPointDelta () const
 
double DeltaX () const
 
double DeltaY () const
 
const DVectorFillValues () const
 
void GetNewSizes (int &width, int &height) const override
 
void SetDelta (const DPoint &d)
 
void SetDelta (double dx, double dy)
 
void SetFillValues (const DVector &fillValues)
 
- 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::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 Translation

Definition at line 74 of file Translation.h.

Constructor & Destructor Documentation

◆ Translation() [1/3]

pcl::Translation::Translation ( PixelInterpolation p,
double  dx = 0,
double  dy = 0 
)
inline

Constructs a Translation object using the specified pixel interpolation p, with translation increments dx and dy in pixels.

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

Definition at line 86 of file Translation.h.

◆ Translation() [2/3]

pcl::Translation::Translation ( PixelInterpolation p,
const DPoint d 
)
inline

Constructs a Translation object using the specified pixel interpolation p, with translation increments in pixels given by the components of a point d in the plane.

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

Definition at line 100 of file Translation.h.

◆ Translation() [3/3]

pcl::Translation::Translation ( const Translation )
default

Copy constructor.

Member Function Documentation

◆ Apply() [1/5]

void pcl::Translation::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::Translation::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::Translation::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::Translation::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::Translation::Apply ( pcl::UInt32Image image) const
overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ Delta()

const DPoint& pcl::Translation::Delta ( ) const
inline

Returns the translation increments in pixels for both axes, as the corresponding components of a point in the plane.

Definition at line 115 of file Translation.h.

◆ DeltaX()

double pcl::Translation::DeltaX ( ) const
inline

Returns the horizontal translation increment in pixels.

Definition at line 123 of file Translation.h.

◆ DeltaY()

double pcl::Translation::DeltaY ( ) const
inline

Returns the vertical translation increment in pixels.

Definition at line 131 of file Translation.h.

◆ FillValues()

const DVector& pcl::Translation::FillValues ( ) const
inline

Returns the current vector of per-channel filling values for uncovered image regions.

See the documentation for SetFillValues() for more information.

Definition at line 159 of file Translation.h.

◆ GetNewSizes()

void pcl::Translation::GetNewSizes ( int &  width,
int &  height 
) const
inlineoverridevirtual

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.

Definition at line 185 of file Translation.h.

References pcl::Apply().

◆ SetDelta() [1/2]

void pcl::Translation::SetDelta ( const DPoint d)
inline

Sets the translation increments in pixels as the components of a point d in the plane.

Definition at line 140 of file Translation.h.

◆ SetDelta() [2/2]

void pcl::Translation::SetDelta ( double  dx,
double  dy 
)
inline

Sets the translation increments dx and dy in pixels.

Definition at line 148 of file Translation.h.

◆ SetFillValues()

void pcl::Translation::SetFillValues ( const DVector fillValues)
inline

Sets a vector of per-channel filling values for uncovered image regions.

Uncovered regions result each time an image is translated. Note that uncovering can be partial for one row or column of pixels, when fractional displacements are applied in the corresponding plane directions.

By default, there are no filling values defined (and hence the returned vector is empty by default). When the Translation instance is executed and a filling value is not defined for a channel of the target image, uncovered regions are filled with the minimum sample value in the native range of the image (usually zero).

Definition at line 178 of file Translation.h.


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