PCL
pcl::MorphologicalTransformation Class Reference

Generic n-way morphological transformation. More...

#include <MorphologicalTransformation.h>

+ Inheritance diagram for pcl::MorphologicalTransformation:

Public Member Functions

 MorphologicalTransformation ()=default
 
 MorphologicalTransformation (const MorphologicalOperator &op, const StructuringElement &structure)
 
 MorphologicalTransformation (const MorphologicalTransformation &x)
 
 MorphologicalTransformation (MorphologicalTransformation &&x)=default
 
virtual ~MorphologicalTransformation ()
 
const MorphologicalOperatorOperator () const
 
MorphologicalTransformationoperator= (const MorphologicalTransformation &x)
 
MorphologicalTransformationoperator= (MorphologicalTransformation &&)=default
 
int OverlappingDistance () const
 
void SetOperator (const MorphologicalOperator &op)
 
void SetStructure (const StructuringElement &structure)
 
const StructuringElementStructure () const
 
- Public Member Functions inherited from pcl::InterlacedTransformation
 InterlacedTransformation (int n=1)
 
 InterlacedTransformation (const InterlacedTransformation &)=default
 
virtual ~InterlacedTransformation ()
 
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
 
- Public Member Functions inherited from pcl::ThresholdedTransformation
 ThresholdedTransformation (double low=0, double high=0)
 
 ThresholdedTransformation (const ThresholdedTransformation &)=default
 
virtual ~ThresholdedTransformation ()
 
double HighThreshold () const
 
bool IsThresholded () const
 
double LowThreshold () const
 
void SetHighThreshold (double t)
 
void SetLowThreshold (double t)
 
- 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 MorphologicalTransformation.

See also
MorphologicalOperator, StructuringElement

Definition at line 80 of file MorphologicalTransformation.h.

Constructor & Destructor Documentation

◆ MorphologicalTransformation() [1/4]

pcl::MorphologicalTransformation::MorphologicalTransformation ( )
default

Constructs a default MorphologicalTransformation object.

Note
This constructor creates an uninitialized instance. In order to use this object, it must be associated with a particular operator and structuring element by calling the SetOperator() and SetStructure() member functions, respectively, with the appropriate instances of MorphologicalOperator and StructuringElement.

◆ MorphologicalTransformation() [2/4]

pcl::MorphologicalTransformation::MorphologicalTransformation ( const MorphologicalOperator op,
const StructuringElement structure 
)
inline

Constructs a MorphologicalTransformation object with the specified operator and structuring element.

The specified objects don't have to remain valid while this MorphologicalTransformation instance is actively used, since it will own private copies of the specified filter operator and structure.

Definition at line 105 of file MorphologicalTransformation.h.

References pcl::MorphologicalOperator::Clone(), pcl::StructuringElement::Clone(), and pcl::StructuringElement::Initialize().

◆ MorphologicalTransformation() [3/4]

pcl::MorphologicalTransformation::MorphologicalTransformation ( const MorphologicalTransformation x)
inline

Copy constructor.

Definition at line 115 of file MorphologicalTransformation.h.

◆ MorphologicalTransformation() [4/4]

pcl::MorphologicalTransformation::MorphologicalTransformation ( MorphologicalTransformation &&  x)
default

Move constructor.

◆ ~MorphologicalTransformation()

virtual pcl::MorphologicalTransformation::~MorphologicalTransformation ( )
inlinevirtual

Destroys a MorphologicalTransformation object.

Definition at line 136 of file MorphologicalTransformation.h.

Member Function Documentation

◆ Apply() [1/5]

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

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

Reimplemented from pcl::ImageTransformation.

◆ Operator()

const MorphologicalOperator& pcl::MorphologicalTransformation::Operator ( ) const
inline

Returns a reference to the morphological operator associated with this transformation.

Definition at line 173 of file MorphologicalTransformation.h.

◆ operator=() [1/2]

MorphologicalTransformation& pcl::MorphologicalTransformation::operator= ( const MorphologicalTransformation x)
inline

Copy assignment operator. Returns a reference to this object.

Definition at line 143 of file MorphologicalTransformation.h.

◆ operator=() [2/2]

MorphologicalTransformation& pcl::MorphologicalTransformation::operator= ( MorphologicalTransformation &&  )
default

Move assignment operator. Returns a reference to this object.

◆ OverlappingDistance()

int pcl::MorphologicalTransformation::OverlappingDistance ( ) const
inline

Returns the size in pixels of the overlapping regions between adjacent areas processed by parallel execution threads. The overlapping distance is a function of the size of the associated structuring element and the current interlacing distance.

Definition at line 214 of file MorphologicalTransformation.h.

References pcl::Apply().

◆ SetOperator()

void pcl::MorphologicalTransformation::SetOperator ( const MorphologicalOperator op)
inline

Causes this transformation to use a duplicate of the specified morphological operator.

Definition at line 183 of file MorphologicalTransformation.h.

References pcl::MorphologicalOperator::Clone().

◆ SetStructure()

void pcl::MorphologicalTransformation::SetStructure ( const StructuringElement structure)
inline

Causes this transformation to use a duplicate of the specified structuring element.

Definition at line 202 of file MorphologicalTransformation.h.

References pcl::StructuringElement::Clone(), and pcl::StructuringElement::Initialize().

◆ Structure()

const StructuringElement& pcl::MorphologicalTransformation::Structure ( ) const
inline

Returns a reference to the structuring element associated with this transformation.

Definition at line 192 of file MorphologicalTransformation.h.


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