PCL
pcl::Rotation Class Reference

Image rotation algorithm. More...

#include <Rotation.h>

+ Inheritance diagram for pcl::Rotation:

Public Member Functions

 Rotation (PixelInterpolation &p, float angle=0, double cx=0, double cy=0)
 
 Rotation (PixelInterpolation &p, float angle, const DPoint &center)
 
 Rotation (const Rotation &)=default
 
float Angle () const
 
DPoint Center () const
 
double CenterX () const
 
double CenterY () const
 
const DVectorFillValues () const
 
void GetNewSizes (int &width, int &height) const override
 
void SetAngle (float rads)
 
void SetCenter (const DPoint &center)
 
void SetCenter (double xc, double yc)
 
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 Rotation

Definition at line 74 of file Rotation.h.

Constructor & Destructor Documentation

◆ Rotation() [1/3]

pcl::Rotation::Rotation ( PixelInterpolation p,
float  angle = 0,
double  cx = 0,
double  cy = 0 
)
inline

Constructs a Rotation object using the specified pixel interpolation p, rotation angle in radians, and rotation center coordinates cx and cy.

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

Definition at line 87 of file Rotation.h.

◆ Rotation() [2/3]

pcl::Rotation::Rotation ( PixelInterpolation p,
float  angle,
const DPoint center 
)
inline

Constructs a Rotation object using the specified pixel interpolation p, rotation angle in radians, and rotation center.

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

Definition at line 100 of file Rotation.h.

◆ Rotation() [3/3]

pcl::Rotation::Rotation ( const Rotation )
default

Copy constructor.

Member Function Documentation

◆ Angle()

float pcl::Rotation::Angle ( ) const
inline

Returns the rotation angle in radians.

Definition at line 114 of file Rotation.h.

◆ Apply() [1/5]

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

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

Reimplemented from pcl::ImageTransformation.

◆ Center()

DPoint pcl::Rotation::Center ( ) const
inline

Returns the center of rotation.

Definition at line 130 of file Rotation.h.

◆ CenterX()

double pcl::Rotation::CenterX ( ) const
inline

Returns the horizontal coordinate of center of rotation.

Definition at line 138 of file Rotation.h.

◆ CenterY()

double pcl::Rotation::CenterY ( ) const
inline

Returns the vertical coordinate of center of rotation.

Definition at line 146 of file Rotation.h.

◆ FillValues()

const DVector& pcl::Rotation::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 173 of file Rotation.h.

◆ GetNewSizes()

void pcl::Rotation::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.

◆ SetAngle()

void pcl::Rotation::SetAngle ( float  rads)
inline

Sets the rotation angle in radians.

Definition at line 122 of file Rotation.h.

◆ SetCenter() [1/2]

void pcl::Rotation::SetCenter ( const DPoint center)
inline

Sets the center of rotation.

Definition at line 154 of file Rotation.h.

◆ SetCenter() [2/2]

void pcl::Rotation::SetCenter ( double  xc,
double  yc 
)
inline

Sets the center of rotation to the specified coordinates xc and yc.

Definition at line 162 of file Rotation.h.

◆ SetFillValues()

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

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

Uncovered regions result when an image is rotated by non-orthogonal angles.

By default, there are no filling values defined (and hence the returned vector is empty by default). When the Rotation 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 190 of file Rotation.h.

References pcl::Apply().


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