itk::CylinderSpatialObject Class Reference

#include <itkCylinderSpatialObject.h>

Inheritance diagram for itk::CylinderSpatialObject:

Collaboration diagram for itk::CylinderSpatialObject:

Detailed Description

This class describe a cylinder in 3D only.

Examples:

Examples/Filtering/SpatialObjectToImage1.cxx, and Examples/SpatialObjects/CylinderSpatialObject.cxx.

Definition at line 32 of file itkCylinderSpatialObject.h.

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer < PointContainerType >	PointContainerPointer
typedef VectorContainer < IdentifierType, PointType >	PointContainerType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	ScalarType
typedef CylinderSpatialObject	Self
typedef SpatialObject< 3 >	Superclass
typedef SmartPointer< Superclass >	SuperclassPointer
typedef Superclass::TransformType	TransformType
Public Types inherited from itk::SpatialObject< 3 >
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer
typedef AffineGeometryFrame < double, VDimension >	AffineGeometryFrameType
typedef BoundingBoxType::Pointer	BoundingBoxPointer
typedef BoundingBox < IdentifierType, VDimension, ScalarType, VectorContainerType >	BoundingBoxType
typedef ChildrenListType *	ChildrenListPointer
typedef std::list< Pointer >	ChildrenListType
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector < ScalarType, VDimension >	CovariantVectorType
typedef Index< VDimension >	IndexType
typedef Point< ScalarType, VDimension >	InputType
typedef Offset< VDimension >	OffsetType
typedef OutputVectorType *	OutputVectorPointer
typedef CovariantVector < double, VDimension >	OutputVectorType
typedef SmartPointer< Self >	Pointer
typedef PointType *	PointPointer
typedef Point< ScalarType, VDimension >	PointType
typedef PropertyType::Pointer	PropertyPointer
typedef SpatialObjectProperty < float >	PropertyType
typedef ImageRegion< VDimension >	RegionType
typedef double	ScalarType
typedef SpatialObject< VDimension >	Self
typedef Size< VDimension >	SizeType
typedef double *	SpacingType
typedef DataObject	Superclass
typedef const TransformType *	TransformConstPointer
typedef TransformType::Pointer	TransformPointer
typedef ScalableAffineTransform < double, VDimension >	TransformType
typedef SpatialObjectTreeNode < VDimension >	TreeNodeType
typedef VectorContainer < IdentifierType, PointType >	VectorContainerType
typedef VectorType *	VectorPointer
typedef Vector< ScalarType, VDimension >	VectorType
Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
typedef SmartPointer< Self >	Pointer
typedef DataObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual bool	ComputeLocalBoundingBox () const override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const override
virtual bool	IsInside (const PointType &point, unsigned int depth, char *) const override
virtual bool	IsInside (const PointType &point) const
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const override
virtual void	SetRadius (double _arg)
virtual const double &	GetRadius () const
virtual void	SetHeight (double _arg)
virtual const double &	GetHeight () const
Public Member Functions inherited from itk::SpatialObject< 3 >
void	AddSpatialObject (Self *pointer)
virtual void	Clear ()
virtual bool	ComputeBoundingBox () const
void	ComputeObjectToParentTransform ()
void	ComputeObjectToWorldTransform ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=nullptr)
bool	Evaluate (const PointType &point) const
virtual BoundingBoxType *	GetBoundingBox () const
virtual const RegionType &	GetBufferedRegion () const
virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=nullptr) const
const TransformType *	GetIndexToObjectTransform () const
TransformType *	GetIndexToObjectTransform (void)
virtual const TransformType *	GetIndexToWorldTransform () const
virtual const RegionType &	GetLargestPossibleRegion () const
unsigned int	GetMaximumDepth () const
TransformType *	GetModifiableIndexToObjectTransform (void)
virtual TransformType *	GetModifiableIndexToWorldTransform ()
virtual TreeNodeType *	GetModifiableTreeNode ()
virtual ModifiedTimeType	GetMTime (void) const override
TransformType *	GetNodeToParentNodeTransform ()
const TransformType *	GetNodeToParentNodeTransform () const
unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=nullptr) const
unsigned int	GetObjectDimension (void) const
ModifiedTimeType	GetObjectMTime (void) const
TransformType *	GetObjectToParentTransform ()
const TransformType *	GetObjectToParentTransform () const
virtual const Self *	GetParent () const
virtual Self *	GetParent ()
virtual const RegionType &	GetRequestedRegion () const
virtual const double *	GetSpacing () const
virtual std::string	GetSpatialObjectTypeAsString () const
ModifiedTimeType	GetTransformMTime ()
virtual const TreeNodeType *	GetTreeNode () const
virtual const char *	GetTypeName (void) const
ModifiedTimeType	GetWorldTransformMTime ()
virtual bool	HasParent () const
virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const
virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=nullptr) const
void	RemoveSpatialObject (Self *object)
virtual void	SetBufferedRegion (const RegionType &region)
void	SetChildren (ChildrenListType &children)
virtual void	SetLargestPossibleRegion (const RegionType &region)
void	SetNodeToParentNodeTransform (TransformType *transform)
void	SetObjectToParentTransform (TransformType *transform)
void	SetParent (Self *parent)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const DataObject *data) override
void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void	SetTreeNode (TreeNodeType *_arg)
virtual void	Update (void) override
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const
virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
virtual AffineGeometryFrameType *	GetModifiableAffineGeometryFrame ()
virtual const AffineGeometryFrameType *	GetAffineGeometryFrame () const
void	SetObjectToWorldTransform (TransformType *transform)
virtual TransformType *	GetModifiableObjectToWorldTransform ()
virtual const TransformType *	GetObjectToWorldTransform () const
const OffsetValueType *	GetOffsetTable () const
OffsetValueType	ComputeOffset (const IndexType &ind) const
IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	CopyInformation (const DataObject *data) override
virtual void	UpdateOutputInformation () override
virtual void	SetRequestedRegionToLargestPossibleRegion () override
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
virtual bool	VerifyRequestedRegion () override
PropertyType *	GetProperty ()
const PropertyType *	GetProperty (void) const
void	SetProperty (PropertyType *property)
virtual const int &	GetId () const
virtual void	SetId (int _arg)
virtual void	SetParentId (int _arg)
virtual const int &	GetParentId () const
	itkLegacyMacro (TransformType *GetObjectToNodeTransform())
TransformType *	GetModifiableObjectToNodeTransform ()
const TransformType *	GetObjectToNodeTransform () const
virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual const unsigned int &	GetBoundingBoxChildrenDepth () const
virtual void	SetBoundingBoxChildrenName (std::string _arg)
virtual const std::string &	GetBoundingBoxChildrenName () const
virtual void	SetDefaultInsideValue (double _arg)
virtual double	GetDefaultInsideValue () const
virtual void	SetDefaultOutsideValue (double _arg)
virtual double	GetDefaultOutsideValue () const
Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag () const
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual ModifiedTimeType	GetUpdateMTime () const
virtual void	Graft (const DataObject *)
virtual void	Initialize ()
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
bool	ShouldIReleaseData () const
virtual void	UpdateOutputData ()
void	SetPipelineMTime (ModifiedTimeType time)
virtual const ModifiedTimeType &	GetPipelineMTime () const
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::SpatialObject< 3 >
static Pointer	New ()
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	SetGlobalReleaseDataFlag (bool val)
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static const unsigned int	NumberOfDimension = 3
Static Public Attributes inherited from itk::SpatialObject< 3 >
static const unsigned int	MaximumDepth
static const unsigned int	ObjectDimension

Protected Member Functions
	CylinderSpatialObject ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	~CylinderSpatialObject () override
Protected Member Functions inherited from itk::SpatialObject< 3 >
void	ComputeOffsetTable ()
virtual const BoundingBoxType *	GetBounds () const
virtual const unsigned int &	GetDimension () const
virtual const TransformType *	GetInternalInverseTransform () const
virtual BoundingBoxType *	GetModifiableBounds ()
virtual TransformType *	GetModifiableInternalInverseTransform ()
virtual void	SetDimension (unsigned int _arg)
bool	SetInternalInverseTransformToWorldToIndexTransform () const
virtual void	SetTypeName (std::string _arg)
	SpatialObject ()
virtual	~SpatialObject () override
Protected Member Functions inherited from itk::DataObject
	DataObject ()
virtual void	PropagateResetPipeline ()
virtual	~DataObject () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
double	m_Height
double	m_Radius
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef Superclass::BoundingBoxType itk::CylinderSpatialObject::BoundingBoxType

Definition at line 45 of file itkCylinderSpatialObject.h.

typedef SmartPointer< const Self > itk::CylinderSpatialObject::ConstPointer

Definition at line 40 of file itkCylinderSpatialObject.h.

typedef SmartPointer< PointContainerType > itk::CylinderSpatialObject::PointContainerPointer

Definition at line 47 of file itkCylinderSpatialObject.h.

typedef VectorContainer< IdentifierType, PointType > itk::CylinderSpatialObject::PointContainerType

Definition at line 46 of file itkCylinderSpatialObject.h.

typedef SmartPointer< Self > itk::CylinderSpatialObject::Pointer

Definition at line 39 of file itkCylinderSpatialObject.h.

typedef Superclass::PointType itk::CylinderSpatialObject::PointType

Definition at line 43 of file itkCylinderSpatialObject.h.

typedef double itk::CylinderSpatialObject::ScalarType

Definition at line 38 of file itkCylinderSpatialObject.h.

typedef CylinderSpatialObject itk::CylinderSpatialObject::Self

Definition at line 37 of file itkCylinderSpatialObject.h.

typedef SpatialObject< 3 > itk::CylinderSpatialObject::Superclass

Definition at line 41 of file itkCylinderSpatialObject.h.

typedef SmartPointer< Superclass > itk::CylinderSpatialObject::SuperclassPointer

Definition at line 42 of file itkCylinderSpatialObject.h.

typedef Superclass::TransformType itk::CylinderSpatialObject::TransformType

Definition at line 44 of file itkCylinderSpatialObject.h.

Constructor & Destructor Documentation

itk::CylinderSpatialObject::CylinderSpatialObject ( )

protected

itk::CylinderSpatialObject::~CylinderSpatialObject ( )

overrideprotected

Member Function Documentation

virtual bool itk::CylinderSpatialObject::ComputeLocalBoundingBox ( ) const

overridevirtual

Get the boundaries of a specific object. This function needs to be called every time one of the object's components is changed.

Reimplemented from itk::SpatialObject< 3 >.

virtual::itk::LightObject::Pointer itk::CylinderSpatialObject::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

virtual const double& itk::CylinderSpatialObject::GetHeight ( ) const

virtual

Set/Get the height

virtual const char* itk::CylinderSpatialObject::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< 3 >.

virtual const double& itk::CylinderSpatialObject::GetRadius ( ) const

virtual

Set/Get the radius

virtual bool itk::CylinderSpatialObject::IsEvaluableAt ( const PointType &  point, unsigned int  depth = 0, char *  name = nullptr  ) const

overridevirtual

Return true if the object provides a method to evaluate the value at the specified point, false otherwise.

virtual bool itk::CylinderSpatialObject::IsInside ( const PointType &  point, unsigned int  depth, char *    ) const

overridevirtual

Test whether a point is inside or outside the object

virtual bool itk::CylinderSpatialObject::IsInside ( const PointType &  point ) const

virtual

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth

static Pointer itk::CylinderSpatialObject::New ( )

static

virtual void itk::CylinderSpatialObject::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Print the object informations in a stream.

Reimplemented from itk::SpatialObject< 3 >.

virtual void itk::CylinderSpatialObject::SetHeight ( double  _arg )

virtual

Set/Get the height

virtual void itk::CylinderSpatialObject::SetRadius ( double  _arg )

virtual

Set/Get the radius

virtual bool itk::CylinderSpatialObject::ValueAt ( const PointType &  point, double &  value, unsigned int  depth = 0, char *  name = nullptr  ) const

overridevirtual

Returns a degree of membership to the object. That's useful for fuzzy objects.

Member Data Documentation

double itk::CylinderSpatialObject::m_Height

protected

Definition at line 99 of file itkCylinderSpatialObject.h.

double itk::CylinderSpatialObject::m_Radius

protected

Definition at line 98 of file itkCylinderSpatialObject.h.

const unsigned int itk::CylinderSpatialObject::NumberOfDimension = 3

static

Definition at line 50 of file itkCylinderSpatialObject.h.

---

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

• itkCylinderSpatialObject.h