PCL
pcl::BoxStructure Class Reference

Standard box (square) structure. More...

#include <StructuringElement.h>

+ Inheritance diagram for pcl::BoxStructure:

Public Member Functions

 BoxStructure (const BoxStructure &)=default
 
 BoxStructure (int size)
 
StructuringElementClone () const override
 
bool IsBox (int k) const override
 
- Public Member Functions inherited from pcl::StructuringElement
 StructuringElement (const StructuringElement &x)
 
 StructuringElement (int size=3, int n=1)
 
virtual ~StructuringElement ()
 
virtual bool ElementExists (int i, int j, int k) const
 
void Initialize () const
 
bool IsReflected () const
 
int NumberOfElements () const
 
int NumberOfWays () const
 
StructuringElementoperator= (const StructuringElement &x)
 
template<typename T >
void PeekElements (T *h1, int &nh1, const T *h, int k) const
 
void Reflect ()
 
int Size () const
 

Additional Inherited Members

- Public Types inherited from pcl::StructuringElement
using existence_mask = GenericVector< existence_mask_element >
 
using existence_mask_count = GenericVector< int >
 
using existence_mask_element = uint32
 
using existence_mask_set = GenericVector< existence_mask >
 

Detailed Description

A block structure defines all of its elements. For example, a box structure of size 5 is:

x x x x x
x x x x x
x x x x x
x x x x x
x x x x x

where existing elements are marked as 'x'.

See also
CircularStructure, OrthogonalStructure, DiagonalStructure, StarStructure

Definition at line 421 of file StructuringElement.h.

Constructor & Destructor Documentation

◆ BoxStructure() [1/2]

pcl::BoxStructure::BoxStructure ( int  size)
inline

Constructs a standard block structure of the specified size.

Definition at line 428 of file StructuringElement.h.

◆ BoxStructure() [2/2]

pcl::BoxStructure::BoxStructure ( const BoxStructure )
default

Copy constructor.

Member Function Documentation

◆ Clone()

StructuringElement* pcl::BoxStructure::Clone ( ) const
inlineoverridevirtual

Returns a pointer to a dynamically allocated duplicate of this structuring element.

Implements pcl::StructuringElement.

Definition at line 440 of file StructuringElement.h.

◆ IsBox()

bool pcl::BoxStructure::IsBox ( int  k) const
inlineoverridevirtual

Returns true iff this is a box structure. All elements in a box structure are existing elements.

As reimplemented by BoxStructure, this member function always returns true.

Reimplemented from pcl::StructuringElement.

Definition at line 452 of file StructuringElement.h.


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