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

#include <itkArrowSpatialObject.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TransformType::MatrixType MatrixType
typedef SmartPointer< SelfPointer
typedef Point< double, TDimension > PointType
typedef double ScalarType
typedef ArrowSpatialObject Self
typedef SpatialObject< TDimension > Superclass
typedef Superclass::TransformType TransformType
typedef Vector< double,
TDimension > 
VectorType
- Public Types inherited from itk::SpatialObject< TDimension >
typedef
AffineGeometryFrameType::Pointer 
AffineGeometryFramePointer
typedef AffineGeometryFrame
< double, VDimension > 
AffineGeometryFrameType
typedef BoundingBoxType::Pointer BoundingBoxPointer
typedef BoundingBox
< IdentifierType, VDimension,
ScalarType,
VectorContainerType
BoundingBoxType
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
- 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

bool ComputeLocalBoundingBox () const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual VectorType GetDirection () const
virtual const double & GetLength ()
virtual const char * GetNameOfClass () const
virtual PointType GetPosition () const
bool IsInside (const PointType &point, unsigned int depth, char *name) const
virtual bool IsInside (const PointType &point) const
void SetDirection (float x, float y)
void SetDirection (float x, float y, float z)
void SetLength (double length)
void SetPosition (float x, float y)
void SetPosition (float x, float y, float z)
void SetPosition (const PointType &p)
void SetDirection (const VectorType &d)
- 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 CopyInformation (const DataObject *data)
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 ()

Protected Member Functions

 ArrowSpatialObject ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
void UpdateTransform ()
virtual ~ArrowSpatialObject ()
- 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 ()

Private Member Functions

 ArrowSpatialObject (const Self &)
void operator= (const Self &)

Private Attributes

VectorType m_Direction
double m_Length
PointType m_Position

Additional Inherited Members

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

Detailed Description

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

Representation of a Arrow based on the spatial object classes.

A ArrowSpatialObject represents a Arrow by serving as the parent of the elements of the Arrow. Since any itk::SpatialObject can have children (see SpatialObject::GetChildren()), this class needs no additional methods.

Definition at line 38 of file itkArrowSpatialObject.h.


Member Typedef Documentation

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 46 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
typedef TransformType::MatrixType itk::ArrowSpatialObject< TDimension >::MatrixType

Definition at line 51 of file itkArrowSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 45 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Point< double, TDimension > itk::ArrowSpatialObject< TDimension >::PointType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 49 of file itkArrowSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 47 of file itkArrowSpatialObject.h.

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

Standard class typedefs.

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 43 of file itkArrowSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 44 of file itkArrowSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 50 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Vector< double, TDimension > itk::ArrowSpatialObject< TDimension >::VectorType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 48 of file itkArrowSpatialObject.h.


Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::ArrowSpatialObject< TDimension >::ArrowSpatialObject ( )
protected
template<unsigned int TDimension = 3>
virtual itk::ArrowSpatialObject< TDimension >::~ArrowSpatialObject ( )
protectedvirtual
template<unsigned int TDimension = 3>
itk::ArrowSpatialObject< TDimension >::ArrowSpatialObject ( const Self )
private

Member Function Documentation

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

Compute the local bounding box

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual::itk::LightObject::Pointer itk::ArrowSpatialObject< 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 VectorType itk::ArrowSpatialObject< TDimension >::GetDirection ( ) const
virtual
template<unsigned int TDimension = 3>
virtual const double& itk::ArrowSpatialObject< TDimension >::GetLength ( )
virtual

Get the length of the arrow

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

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

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

Returns true if the point is inside the line, false otherwise.

template<unsigned int TDimension = 3>
virtual bool itk::ArrowSpatialObject< 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::ArrowSpatialObject< TDimension >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

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

Reimplemented from itk::SpatialObject< TDimension >.

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

Method to print the object.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetDirection ( const VectorType d)
inline

Set the direction of the arrow

Definition at line 85 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetDirection ( float  x,
float  y 
)
inline

Definition at line 94 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetDirection ( float  x,
float  y,
float  z 
)
inline

Definition at line 101 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetLength ( double  length)

Set the length of the arrow

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetPosition ( const PointType p)
inline

Set the position of the arrow

Definition at line 60 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetPosition ( float  x,
float  y 
)
inline

Definition at line 69 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::SetPosition ( float  x,
float  y,
float  z 
)
inline

Definition at line 76 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::ArrowSpatialObject< TDimension >::UpdateTransform ( )
protected

Update the transformation given the position and the direction


Member Data Documentation

template<unsigned int TDimension = 3>
VectorType itk::ArrowSpatialObject< TDimension >::m_Direction
private

Definition at line 142 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
double itk::ArrowSpatialObject< TDimension >::m_Length
private

Definition at line 144 of file itkArrowSpatialObject.h.

template<unsigned int TDimension = 3>
PointType itk::ArrowSpatialObject< TDimension >::m_Position
private

Definition at line 143 of file itkArrowSpatialObject.h.


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