aims::strel::Shape Class Reference

aims::strel::Shape pure abstract class representing a "shape" 3D structuring element. More...

#include <aims/connectivity/structuring_element.h>

Inheritance diagram for aims::strel::Shape:

Collaboration diagram for aims::strel::Shape:

Public Types
typedef StructuringElement::iterator	iterator
typedef StructuringElement::const_iterator	const_iterator
Public Types inherited from aims::StructuringElement
typedef std::vector< Point3dl >::iterator	iterator
typedef std::vector< Point3dl >::const_iterator	const_iterator

Public Member Functions
virtual	~Shape ()
virtual Shape *	clone () const =0
	Clone the StructuringElement. More...
Public Member Functions inherited from aims::StructuringElement
	StructuringElement ()
	StructuringElement (const std::vector< Point3dl > &vector)
virtual	~StructuringElement ()
iterator	begin ()
	Return iterator to beginning. More...
iterator	end ()
	Return iterator to end. More...
const_iterator	begin () const
	Return const_iterator to beginning. More...
const_iterator	end () const
	Return const_iterator to end. More...
size_t	size () const
const std::vector< Point3dl > &	getVector () const
	Return std::vector<Point3dl> More...
std::vector< int >	getAmplitude (const Point3dl &origin=Point3dl(0, 0, 0)) const
	Maximum distance to origin in each direction. More...

Protected Member Functions
void	setParameters (const double amplitude=1., const bool usecenter=false)
void	setParameters (const Point3dl &origin, const double amplitude=1., const bool usecenter=false)
void	setParameters (const Point3d &origin, const double amplitude=1, const bool usecenter=false)
void	setParameters (const std::vector< double > &amplitude, const bool usecenter=false)
void	setParameters (const Point3d &origin, const std::vector< double > &amplitude, const bool usecenter=false)
virtual void	setParameters (const Point3dl &origin, const std::vector< double > &amplitude, const bool usecenter=false)=0

Friends
class	ShapeFactory

Additional Inherited Members
Protected Attributes inherited from aims::StructuringElement
std::vector< Point3dl >	_vector

Detailed Description

aims::strel::Shape pure abstract class representing a "shape" 3D structuring element.

Shapes are defined by an origin and an amplitude. They can be generated from a keyword using aims::strel::ShapeFactory

See also

aims::strel::Cube aims::strel::SquareXY aims::strel::SquareXZ aims::strel::SquareYZ aims::strel::Sphere aims::strel::DiskXY aims::strel::DiskXZ aims::strel::DiskYZ

Definition at line 269 of file structuring_element.h.

Member Typedef Documentation

const_iterator

typedef StructuringElement::const_iterator aims::strel::Shape::const_iterator

Definition at line 274 of file structuring_element.h.

iterator

typedef StructuringElement::iterator aims::strel::Shape::iterator

Definition at line 273 of file structuring_element.h.

Constructor & Destructor Documentation

~Shape()

virtual aims::strel::Shape::~Shape ( )

inlinevirtual

Definition at line 275 of file structuring_element.h.

Member Function Documentation

clone()

virtual Shape* aims::strel::Shape::clone ( ) const

pure virtual

Clone the StructuringElement.

Reimplemented from aims::StructuringElement.

setParameters() [1/6]

void aims::strel::Shape::setParameters ( const double  amplitude = 1., const bool  usecenter = false  )

protected

Referenced by aims::strel::ClockWiseCircleXY::ClockWiseCircleXY().

setParameters() [2/6]

void aims::strel::Shape::setParameters ( const Point3d &  origin, const double  amplitude = 1, const bool  usecenter = false  )

protected

setParameters() [3/6]

void aims::strel::Shape::setParameters ( const Point3d &  origin, const std::vector< double > &  amplitude, const bool  usecenter = false  )

protected

setParameters() [4/6]

void aims::strel::Shape::setParameters ( const Point3dl &  origin, const double  amplitude = 1., const bool  usecenter = false  )

protected

setParameters() [5/6]

virtual void aims::strel::Shape::setParameters ( const Point3dl &  origin, const std::vector< double > &  amplitude, const bool  usecenter = false  )

protectedpure virtual

setParameters() [6/6]

void aims::strel::Shape::setParameters ( const std::vector< double > &  amplitude, const bool  usecenter = false  )

protected

Friends And Related Function Documentation

ShapeFactory

friend class ShapeFactory

friend

Definition at line 271 of file structuring_element.h.

---

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

• aims/connectivity/structuring_element.h