PCL
pcl::InterlacedTransformation Class Reference

Interlaced image transformation in the spatial domain. More...

#include <InterlacedTransformation.h>

+ Inheritance diagram for pcl::InterlacedTransformation:

Public Member Functions

 InterlacedTransformation (const InterlacedTransformation &)=default
 
 InterlacedTransformation (int n=1)
 
 ~InterlacedTransformation () override
 
void DisableInterlacing ()
 
int InterlacingDistance () const
 
bool IsInterlaced () const
 
void SetInterlacingDistance (int n)
 
- 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
 

Additional Inherited Members

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

Detailed Description

InterlacedTransformation represents an interlaced image transformation in PCL. An interlaced transformation can be applied to a subset of the pixels in a target image by acting exclusively on selected rows and columns of pixels, distributed at regular intervals.

The distance between two consecutive rows or columns of transformed pixels is the interlacing distance that characterizes an interlaced transformation. Intermediate pixels falling between selected rows or columns are ignored during the transformation.

In PCL, convolutions in the spatial domain and morphological transformations have been implemented as interlaced transformations. A good example of interlaced image transformation algorithm is the starlet transform (see the StarletTransform class), which uses interlaced convolutions to perform a multiscale decomposition.

Definition at line 88 of file InterlacedTransformation.h.

Constructor & Destructor Documentation

◆ InterlacedTransformation() [1/2]

pcl::InterlacedTransformation::InterlacedTransformation ( int  n = 1)
inline

Constructs an InterlacedTransformation object with the specified interlacing distance n > 0 in pixels.

Definition at line 96 of file InterlacedTransformation.h.

◆ InterlacedTransformation() [2/2]

pcl::InterlacedTransformation::InterlacedTransformation ( const InterlacedTransformation )
default

Copy constructor.

◆ ~InterlacedTransformation()

pcl::InterlacedTransformation::~InterlacedTransformation ( )
inlineoverride

Destroys an InterlacedTransformation object.

Definition at line 110 of file InterlacedTransformation.h.

Member Function Documentation

◆ DisableInterlacing()

void pcl::InterlacedTransformation::DisableInterlacing ( )
inline

Disables interlacing for this transformation.

This is a convenience function, equivalent to:

Definition at line 161 of file InterlacedTransformation.h.

◆ InterlacingDistance()

int pcl::InterlacedTransformation::InterlacingDistance ( ) const
inline

Returns the current interlacing distance of this transformation in pixels.

See also
SetInterlacingDistance(), IsInterlaced()

Definition at line 133 of file InterlacedTransformation.h.

◆ IsInterlaced()

bool pcl::InterlacedTransformation::IsInterlaced ( ) const
inline

Returns true iff this transformation is currently interlaced.

The transformation is interlaced if the current interlacing distance is greater than one pixel.

See also
InterlacingDistance()

Definition at line 122 of file InterlacedTransformation.h.

◆ SetInterlacingDistance()

void pcl::InterlacedTransformation::SetInterlacingDistance ( int  n)
inline

Sets the current interlacing distance of this transformation to the specified value n > 0 in pixels.

The interlacing distance is the distance in pixels between two consecutive rows or columns of transformed pixels. Intermediate pixels falling between selected rows or columns are ignored.

See also
InterlacingDistance(), DisableInterlacing(), IsInterlaced()

Definition at line 148 of file InterlacedTransformation.h.

References pcl::Max().


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