ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
itk::EllipseSpatialObject< TDimension > Class Template Reference

#include <itkEllipseSpatialObject.h>

+ Inheritance diagram for itk::EllipseSpatialObject< TDimension >:
+ Collaboration diagram for itk::EllipseSpatialObject< TDimension >:

List of all members.

Public Types

typedef FixedArray< double,
TDimension > 
ArrayType
typedef Superclass::BoundingBoxType BoundingBoxType
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer
< PointContainerType
PointContainerPointer
typedef VectorContainer
< IdentifierType, PointType
PointContainerType
typedef SmartPointer< SelfPointer
typedef Superclass::PointType PointType
typedef double ScalarType
typedef EllipseSpatialObject Self
typedef SpatialObject< TDimension > Superclass
typedef SmartPointer< SuperclassSuperclassPointer
typedef Superclass::TransformType TransformType
- Public Types inherited from itk::SpatialObject< TDimension >
typedef
AffineGeometryFrameType::Pointer 
AffineGeometryFramePointer
typedef AffineGeometryFrame
< double, VDimension > 
AffineGeometryFrameType
typedef BoundingBoxType::Pointer BoundingBoxPointer
typedef ChildrenListTypeChildrenListPointer
typedef std::list< PointerChildrenListType
typedef CovariantVector
< ScalarType, VDimension > 
CovariantVectorType
typedef Index< VDimension > IndexType
typedef Point< ScalarType,
VDimension > 
InputType
typedef Offset< VDimension > OffsetType
typedef OutputVectorTypeOutputVectorPointer
typedef CovariantVector
< double, VDimension > 
OutputVectorType
typedef PointTypePointPointer
typedef PropertyType::Pointer PropertyPointer
typedef SpatialObjectProperty
< float > 
PropertyType
typedef ImageRegion< VDimension > RegionType
typedef Size< VDimension > SizeType
typedef double * SpacingType
typedef const TransformTypeTransformConstPointer
typedef TransformType::Pointer TransformPointer
typedef SpatialObjectTreeNode
< VDimension > 
TreeNodeType
typedef VectorContainer
< IdentifierType, PointType
VectorContainerType
typedef VectorTypeVectorPointer
typedef Vector< ScalarType,
VDimension > 
VectorType
- Public Types inherited from itk::DataObject
typedef std::string DataObjectIdentifierType
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual bool ComputeLocalBoundingBox () const
void CopyInformation (const DataObject *data)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual const ArrayTypeGetRadius ()
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool IsInside (const PointType &point, unsigned int depth, char *) const
virtual bool IsInside (const PointType &point) const
void SetRadius (double radius)
virtual void SetRadius (ArrayType _arg)
virtual bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
- Public Member Functions inherited from itk::SpatialObject< TDimension >
void AddSpatialObject (Self *pointer)
virtual void Clear (void)
virtual bool ComputeBoundingBox () const
void ComputeObjectToParentTransform (void)
void ComputeObjectToWorldTransform (void)
virtual void DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
bool Evaluate (const PointType &point) const
virtual BoundingBoxTypeGetBoundingBox () const
virtual const RegionTypeGetBufferedRegion () const
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=NULL) const
TransformTypeGetIndexToObjectTransform (void)
const TransformTypeGetIndexToObjectTransform (void) const
virtual TransformTypeGetIndexToWorldTransform ()
virtual const TransformTypeGetIndexToWorldTransform ()
virtual const RegionTypeGetLargestPossibleRegion () const
unsigned int GetMaximumDepth () const
unsigned long GetMTime (void) const
TransformTypeGetNodeToParentNodeTransform (void)
const TransformTypeGetNodeToParentNodeTransform (void) const
unsigned int GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned int GetObjectDimension (void) const
unsigned long GetObjectMTime (void) const
TransformTypeGetObjectToNodeTransform (void)
const TransformTypeGetObjectToNodeTransform (void) const
TransformTypeGetObjectToParentTransform (void)
const TransformTypeGetObjectToParentTransform (void) const
virtual TransformTypeGetObjectToWorldTransform ()
virtual const TransformTypeGetObjectToWorldTransform ()
virtual const SelfGetParent (void) const
virtual SelfGetParent (void)
virtual const RegionTypeGetRequestedRegion () const
virtual const double * GetSpacing () const
virtual std::string GetSpatialObjectTypeAsString () const
unsigned long GetTransformMTime (void)
virtual const char * GetTypeName (void) const
unsigned long GetWorldTransformMTime (void)
virtual bool HasParent (void) const
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) 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 SetObjectToWorldTransform (TransformType *transform)
void SetParent (Self *parent)
virtual void SetRequestedRegion (const RegionType &region)
virtual void SetRequestedRegion (const DataObject *data)
void SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void SetTreeNode (TreeNodeType *_arg)
virtual void Update (void)
virtual bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
virtual const
AffineGeometryFrameType
GetAffineGeometryFrame ()
virtual void SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
const OffsetValueTypeGetOffsetTable () const
OffsetValueType ComputeOffset (const IndexType &ind) const
IndexType ComputeIndex (OffsetValueType offset) const
virtual void UpdateOutputInformation ()
virtual void SetRequestedRegionToLargestPossibleRegion ()
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool VerifyRequestedRegion ()
PropertyTypeGetProperty (void)
const PropertyTypeGetProperty (void) const
void SetProperty (PropertyType *property)
virtual const int & GetId ()
virtual void SetId (int _arg)
virtual void SetParentId (int _arg)
virtual const int & GetParentId ()
virtual TreeNodeTypeGetTreeNode ()
virtual const TreeNodeTypeGetTreeNode ()
virtual void SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual const unsigned int & GetBoundingBoxChildrenDepth ()
virtual void SetBoundingBoxChildrenName (std::string _arg)
virtual const std::string & GetBoundingBoxChildrenName ()
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 ()
SmartPointerForwardReference
< ProcessObject
GetSource () const
DataObjectPointerArraySizeType GetSourceOutputIndex () const
const DataObjectIdentifierTypeGetSourceOutputName () const
virtual unsigned long GetUpdateMTime () const
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 (unsigned long time)
virtual const unsigned long & GetPipelineMTime ()
virtual void SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStampGetRealTimeStamp ()
virtual void Graft (const DataObject *)
- 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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 Attributes

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

Protected Member Functions

 EllipseSpatialObject (const Self &)
 EllipseSpatialObject (void)
void operator= (const Self &)
virtual void PrintSelf (std::ostream &os, Indent indent) const
 ~EllipseSpatialObject (void)
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
void ComputeOffsetTable ()
virtual const BoundingBoxTypeGetBounds ()
virtual const unsigned int & GetDimension ()
virtual const TransformTypeGetInternalInverseTransform ()
virtual void SetDimension (unsigned int _arg)
bool SetInternalInverseTransformToWorldToIndexTransform () const
virtual void SetTypeName (std::string _arg)
 SpatialObject ()
virtual ~SpatialObject ()
- Protected Member Functions inherited from itk::DataObject
virtual void PropagateResetPipeline ()
 DataObject ()
 ~DataObject ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- 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

ArrayType m_Radius

Detailed Description

template<unsigned int TDimension = 3>
class itk::EllipseSpatialObject< TDimension >

TODO.

Wiki Examples:

Definition at line 38 of file itkEllipseSpatialObject.h.


Member Typedef Documentation

template<unsigned int TDimension = 3>
typedef FixedArray< double, TDimension > itk::EllipseSpatialObject< TDimension >::ArrayType

Definition at line 55 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::BoundingBoxType itk::EllipseSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 51 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< const Self > itk::EllipseSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 46 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< PointContainerType > itk::EllipseSpatialObject< TDimension >::PointContainerPointer

Definition at line 53 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef VectorContainer< IdentifierType, PointType > itk::EllipseSpatialObject< TDimension >::PointContainerType

Definition at line 52 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< Self > itk::EllipseSpatialObject< TDimension >::Pointer

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 45 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::PointType itk::EllipseSpatialObject< TDimension >::PointType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 49 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef double itk::EllipseSpatialObject< TDimension >::ScalarType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 44 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef EllipseSpatialObject itk::EllipseSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 43 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SpatialObject< TDimension > itk::EllipseSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 47 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< Superclass > itk::EllipseSpatialObject< TDimension >::SuperclassPointer

Definition at line 48 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::TransformType itk::EllipseSpatialObject< TDimension >::TransformType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 50 of file itkEllipseSpatialObject.h.


Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::EllipseSpatialObject< TDimension >::EllipseSpatialObject ( const Self )
protected
template<unsigned int TDimension = 3>
itk::EllipseSpatialObject< TDimension >::EllipseSpatialObject ( void  )
protected
template<unsigned int TDimension = 3>
itk::EllipseSpatialObject< TDimension >::~EllipseSpatialObject ( void  )
protected

Member Function Documentation

template<unsigned int TDimension = 3>
virtual bool itk::EllipseSpatialObject< TDimension >::ComputeLocalBoundingBox ( ) const
virtual

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< TDimension >.

template<unsigned int TDimension = 3>
void itk::EllipseSpatialObject< TDimension >::CopyInformation ( const DataObject data)
virtual

Copy the information from another SpatialObject

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual::itk::LightObject::Pointer itk::EllipseSpatialObject< TDimension >::CreateAnother ( void  ) 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::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual const char* itk::EllipseSpatialObject< TDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual const ArrayType& itk::EllipseSpatialObject< TDimension >::GetRadius ( )
virtual

Get radii via an array of radius values

template<unsigned int TDimension = 3>
virtual bool itk::EllipseSpatialObject< TDimension >::IsEvaluableAt ( const PointType point,
unsigned int  depth = 0,
char *  name = NULL 
) const
virtual

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

template<unsigned int TDimension = 3>
virtual bool itk::EllipseSpatialObject< TDimension >::IsInside ( const PointType point,
unsigned int  depth,
char *   
) const
virtual

Test whether a point is inside or outside the object

template<unsigned int TDimension = 3>
virtual bool itk::EllipseSpatialObject< TDimension >::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

template<unsigned int TDimension = 3>
static Pointer itk::EllipseSpatialObject< TDimension >::New ( void  )
static

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
void itk::EllipseSpatialObject< TDimension >::operator= ( const Self )
protected

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual void itk::EllipseSpatialObject< TDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Print the object informations in a stream.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
void itk::EllipseSpatialObject< TDimension >::SetRadius ( double  radius)

Set all radii to the same radius value. Each radius is half the length of one axis of the ellipse.

template<unsigned int TDimension = 3>
virtual void itk::EllipseSpatialObject< TDimension >::SetRadius ( ArrayType  _arg)
virtual

Set radii via an array of radius values

template<unsigned int TDimension = 3>
virtual bool itk::EllipseSpatialObject< TDimension >::ValueAt ( const PointType point,
double &  value,
unsigned int  depth = 0,
char *  name = NULL 
) const
virtual

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


Member Data Documentation

template<unsigned int TDimension = 3>
ArrayType itk::EllipseSpatialObject< TDimension >::m_Radius
protected

Definition at line 109 of file itkEllipseSpatialObject.h.

template<unsigned int TDimension = 3>
const unsigned int itk::EllipseSpatialObject< TDimension >::NumberOfDimension = TDimension
static

Definition at line 57 of file itkEllipseSpatialObject.h.


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