Discrete two-dimensional wavelet transforms by the pyramidal algorithms. More...

#include <PyramidalWaveletTransform.h>

Inheritance diagram for pcl::PyramidalWaveletTransform:

Public Member Functions
	PyramidalWaveletTransform ()=default

	PyramidalWaveletTransform (const PyramidalWaveletTransform &)=default

	PyramidalWaveletTransform (const WaveletFilter &f)

	PyramidalWaveletTransform (PyramidalWaveletTransform &&)=default

	~PyramidalWaveletTransform () override

void	Clear ()

bool	IsNonstandard () const

bool	IsStandard () const

PyramidalWaveletTransform &	operator= (const PyramidalWaveletTransform &)=default

PyramidalWaveletTransform &	operator= (PyramidalWaveletTransform &&)=default

const WaveletFilter &	ScalingFunction () const

void	SetNonstandard (bool b=true)

void	SetScalingFunction (const WaveletFilter &f)

void	SetStandard (bool b=true)

Image &	Transform ()

const Image &	Transform () const

Public Member Functions inherited from pcl::BidirectionalImageTransformation
	BidirectionalImageTransformation ()=default

	BidirectionalImageTransformation (const BidirectionalImageTransformation &)=default

	~BidirectionalImageTransformation () override

template<class P >
const GenericImage< P > &	operator<< (const GenericImage< P > &image)

const ImageVariant &	operator<< (const ImageVariant &image)

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

ImageVariant &	operator>> (ImageVariant &image) const

Protected Member Functions
void	Apply (pcl::ComplexImage &) const override

void	Apply (pcl::DComplexImage &) const override

void	Apply (pcl::DImage &) const override

void	Apply (pcl::Image &) const override

void	Apply (pcl::UInt16Image &) const override

void	Apply (pcl::UInt32Image &) const override

void	Apply (pcl::UInt8Image &) const override

void	Transform (const pcl::ComplexImage &) override

void	Transform (const pcl::DComplexImage &) override

void	Transform (const pcl::DImage &) override

void	Transform (const pcl::Image &) override

void	Transform (const pcl::UInt16Image &) override

void	Transform (const pcl::UInt32Image &) override

void	Transform (const pcl::UInt8Image &) override

Detailed Description

Note: The dimensions of transformed images must be integer powers of two.

References

Partially based on Numerical Recipes in C, 2nd Ed., by W. H. Press et al.

TODO: Write a detailed description for PyramidalWaveletTransform.

Definition at line 317 of file PyramidalWaveletTransform.h.

Constructor & Destructor Documentation

◆ PyramidalWaveletTransform() [1/4]

pcl::PyramidalWaveletTransform::PyramidalWaveletTransform ( )

default

Default constructor.

Note: This constructor yields an uninitialized instance that cannot be used prior to initializing it with a reference to a WaveletFilter, which will be used as the scaling function of the wavelet transform.

◆ PyramidalWaveletTransform() [2/4]

pcl::PyramidalWaveletTransform::PyramidalWaveletTransform ( const WaveletFilter & f )

inline

Constructs a PyramidalWaveletTransform instance with the specified wavelet filter f.

Definition at line 334 of file PyramidalWaveletTransform.h.

◆ PyramidalWaveletTransform() [3/4]

pcl::PyramidalWaveletTransform::PyramidalWaveletTransform ( const PyramidalWaveletTransform & )

default

Copy constructor.

◆ PyramidalWaveletTransform() [4/4]

pcl::PyramidalWaveletTransform::PyramidalWaveletTransform ( PyramidalWaveletTransform && )

default

Move constructor.

◆ ~PyramidalWaveletTransform()

pcl::PyramidalWaveletTransform::~PyramidalWaveletTransform ( )

inlineoverride

Destroys a PyramidalWaveletTransform object. The wavelet transform is destroyed and deallocated.

Definition at line 354 of file PyramidalWaveletTransform.h.

Member Function Documentation

◆ Apply() [1/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::ComplexImage & image ) const

overrideprotectedvirtual

Applies this transformation to a 32-bit complex image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [2/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::DComplexImage & image ) const

overrideprotectedvirtual

Applies this transformation to a 64-bit complex image.

Reimplemented from pcl::ImageTransformation.

◆ Apply() [3/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::DImage & image ) const

overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ Apply() [4/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::Image & image ) const

overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ Apply() [5/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::UInt16Image & image ) const

overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ Apply() [6/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::UInt32Image & image ) const

overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ Apply() [7/7]

void pcl::PyramidalWaveletTransform::Apply ( pcl::UInt8Image & image ) const

overrideprotectedvirtual

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

Reimplemented from pcl::ImageTransformation.

◆ Clear()

void pcl::PyramidalWaveletTransform::Clear ( )

inline

Destroys and deallocates the existing wavelet transform.

Definition at line 465 of file PyramidalWaveletTransform.h.

◆ IsNonstandard()

bool pcl::PyramidalWaveletTransform::IsNonstandard ( ) const

inline

Returns true if this object applies nonstandard wavelet transforms; false if it applies nstandard wavelet transforms.

This is a convenience member function, equivalent to !IsStandard().

Definition at line 405 of file PyramidalWaveletTransform.h.

◆ IsStandard()

bool pcl::PyramidalWaveletTransform::IsStandard ( ) const

inline

Returns true iff this object applies standard wavelet transforms; false if it applies nonstandard wavelet transforms.

Definition at line 393 of file PyramidalWaveletTransform.h.

◆ operator=() [1/2]

PyramidalWaveletTransform& pcl::PyramidalWaveletTransform::operator= ( const PyramidalWaveletTransform & )

default

Copy assignment operator. Returns a reference to this object.

◆ operator=() [2/2]

PyramidalWaveletTransform& pcl::PyramidalWaveletTransform::operator= ( PyramidalWaveletTransform && )

default

Move assignment operator. Returns a reference to this object.

◆ ScalingFunction()

const WaveletFilter& pcl::PyramidalWaveletTransform::ScalingFunction ( ) const

inline

Returns a reference to the scaling function (or wavelet filter) used by this wavelet transform.

Definition at line 372 of file PyramidalWaveletTransform.h.

◆ SetNonstandard()

void pcl::PyramidalWaveletTransform::SetNonstandard ( bool b = true )

inline

Enables or disables nonstandard wavelet transforms for this PyramidalWaveletTransform object.

Calling this member function implicitly destroys the existing wavelet transform.

This is a convenience member function, equivalent to SetStandard( !b ).

Definition at line 432 of file PyramidalWaveletTransform.h.

◆ SetScalingFunction()

void pcl::PyramidalWaveletTransform::SetScalingFunction ( const WaveletFilter & f )

inline

Sets the scaling function (or wavelet filter) used by this wavelet transform.

Definition at line 382 of file PyramidalWaveletTransform.h.

◆ SetStandard()

void pcl::PyramidalWaveletTransform::SetStandard ( bool b = true )

inline

Enables or disables standard wavelet transforms for this PyramidalWaveletTransform object.

Calling this member function implicitly destroys the existing wavelet transform.

Definition at line 417 of file PyramidalWaveletTransform.h.

◆ Transform() [1/9]

Image& pcl::PyramidalWaveletTransform::Transform ( )

inline

Returns a reference to the wavelet transform in this PyramidalWaveletTransform object.

The returned image is empty if no transform has been performed by this PyramidalWaveletTransform object.

Definition at line 457 of file PyramidalWaveletTransform.h.

◆ Transform() [2/9]

const Image& pcl::PyramidalWaveletTransform::Transform ( ) const

inline

Returns a reference to the wavelet transform in this PyramidalWaveletTransform object.

The returned image is empty if no transform has been performed by this PyramidalWaveletTransform object.

Definition at line 445 of file PyramidalWaveletTransform.h.

◆ Transform() [3/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::ComplexImage & image )

overrideprotectedvirtual

Transforms a 32-bit complex image.

Reimplemented from pcl::BidirectionalImageTransformation.

◆ Transform() [4/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::DComplexImage & image )

overrideprotectedvirtual

Transforms a 64-bit complex image.

Reimplemented from pcl::BidirectionalImageTransformation.

◆ Transform() [5/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::DImage & image )

overrideprotectedvirtual

Transforms a 64-bit floating point image.

Reimplemented from pcl::BidirectionalImageTransformation.

◆ Transform() [6/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::Image & image )

overrideprotectedvirtual

Transforms a 32-bit floating point image.

Reimplemented from pcl::BidirectionalImageTransformation.

◆ Transform() [7/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::UInt16Image & image )

overrideprotectedvirtual

Transforms a 16-bit unsigned integer image.

Reimplemented from pcl::BidirectionalImageTransformation.

◆ Transform() [8/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::UInt32Image & image )

overrideprotectedvirtual

Transforms a 32-bit unsigned integer image.

Reimplemented from pcl::BidirectionalImageTransformation.

◆ Transform() [9/9]

void pcl::PyramidalWaveletTransform::Transform ( const pcl::UInt8Image & image )

overrideprotectedvirtual

Transforms an 8-bit unsigned integer image.

Reimplemented from pcl::BidirectionalImageTransformation.

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

PyramidalWaveletTransform.h

Public Member Functions

Protected Member Functions

Detailed Description

TODO: Write a detailed description for PyramidalWaveletTransform.

Constructor & Destructor Documentation

◆ PyramidalWaveletTransform() [1/4]

◆ PyramidalWaveletTransform() [2/4]

◆ PyramidalWaveletTransform() [3/4]

◆ PyramidalWaveletTransform() [4/4]

◆ ~PyramidalWaveletTransform()

Member Function Documentation

◆ Apply() [1/7]

◆ Apply() [2/7]

◆ Apply() [3/7]

◆ Apply() [4/7]

◆ Apply() [5/7]

◆ Apply() [6/7]

◆ Apply() [7/7]

◆ Clear()

◆ IsNonstandard()

◆ IsStandard()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ScalingFunction()

◆ SetNonstandard()

◆ SetScalingFunction()

◆ SetStandard()

◆ Transform() [1/9]

◆ Transform() [2/9]

◆ Transform() [3/9]

◆ Transform() [4/9]

◆ Transform() [5/9]

◆ Transform() [6/9]

◆ Transform() [7/9]

◆ Transform() [8/9]

◆ Transform() [9/9]