Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::CylinderSpatialObject Class Reference

#include <itkCylinderSpatialObject.h>

Inheritance diagram for itk::CylinderSpatialObject:

Inheritance graph
[legend]
Collaboration diagram for itk::CylinderSpatialObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class describe a cylinder in 3D only.

Definition at line 32 of file itkCylinderSpatialObject.h.

Public Types

typedef AffineGeometryFrameType::Pointer AffineGeometryFramePointer
typedef AffineGeometryFrame<
double, TDimension > 
AffineGeometryFrameType
typedef BoundingBoxType::Pointer BoundingBoxPointer
typedef Superclass::BoundingBoxType BoundingBoxType
typedef ChildrenListTypeChildrenListPointer
typedef std::list< PointerChildrenListType
typedef SmartPointer< const
Self
ConstPointer
typedef CovariantVector< ScalarType,
TDimension > 
CovariantVectorType
typedef Index< TDimension > IndexType
typedef IndexType::IndexValueType IndexValueType
typedef Point< ScalarType,
TDimension > 
InputType
typedef Offset< TDimension > OffsetType
typedef OffsetType::OffsetValueType OffsetValueType
typedef OutputVectorTypeOutputVectorPointer
typedef CovariantVector< double,
TDimension > 
OutputVectorType
typedef SmartPointer< PointContainerTypePointContainerPointer
typedef VectorContainer< unsigned
long, PointType
PointContainerType
typedef SmartPointer< SelfPointer
typedef PointTypePointPointer
typedef Superclass::PointType PointType
typedef PropertyType::Pointer PropertyPointer
typedef SpatialObjectProperty<
float > 
PropertyType
typedef ImageRegion< TDimension > RegionType
typedef double ScalarType
typedef CylinderSpatialObject Self
typedef Size< TDimension > SizeType
typedef double * SpacingType
typedef SpatialObject< 3 > Superclass
typedef SmartPointer< SuperclassSuperclassPointer
typedef const TransformTypeTransformConstPointer
typedef TransformType::Pointer TransformPointer
typedef Superclass::TransformType TransformType
typedef SpatialObjectTreeNode<
TDimension > 
TreeNodeType
typedef VectorContainer< unsigned
long int, PointType
VectorContainerType
typedef VectorTypeVectorPointer
typedef Vector< ScalarType,
TDimension > 
VectorType

Public Member Functions

void AddSpatialObject (Self *pointer)
virtual void Clear (void)
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is meaning
that *the bounding box for
the object and all its recursive
children is computed *This
depth can be it is possible
to *restrict the bounding
box computation to objects
of a specified *type or family
of types The spatial objects
included in the *computation
are those whose typenames
as their initial the string
specified via then it is not
included in the bounding box
but its descendents that match
the string are *included
*virtual bool 
ComputeBoundingBox () const
Compute the index of the pixel
at a specified offset from
the *beginning of the buffered
region *IndexType 
ComputeIndex (OffsetValueType offset) const
virtual bool ComputeLocalBoundingBox () const
void ComputeObjectToParentTransform (void)
void ComputeObjectToWorldTransform (void)
Compute an offset from the
beginning of the buffer for
a pixel *at the specified
index *OffsetValueType 
ComputeOffset (const IndexType &ind) const
virtual void CopyInformation (const DataObject *data)
virtual void DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
Returns true if a point is
inside the object provided
*to make spatial objects compatible
with spatial functions *and
conditional iterators for
defining regions of interest
*bool 
Evaluate (const PointType &point) const
Set Get the AffineGeometryFrame
*virtual const AffineGeometryFrameType
GetAffineGeometryFrame ()
virtual BoundingBoxTypeGetBoundingBox () const
virtual const unsigned int & GetBoundingBoxChildrenDepth ()
virtual const std::string & GetBoundingBoxChildrenName ()
virtual const RegionTypeGetBufferedRegion () const
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=NULL) const
virtual double GetDefaultInsideValue () const
virtual double GetDefaultOutsideValue () const
virtual const double & GetHeight ()
Get Set the ID *virtual const
int & 
GetId ()
const TransformTypeGetIndexToObjectTransform (void) const
Transform points from the
internal data coordinate system
*of the and offset of the
indices *TransformType
GetIndexToObjectTransform (void)
virtual const TransformTypeGetIndexToWorldTransform ()
virtual TransformTypeGetIndexToWorldTransform ()
virtual const RegionTypeGetLargestPossibleRegion () const
unsigned int GetMaximumDepth ()
unsigned long GetMTime (void) const
virtual const char * GetNameOfClass () const
const TransformTypeGetNodeToParentNodeTransform (void) const
TransformTypeGetNodeToParentNodeTransform (void)
unsigned int GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned int GetObjectDimension (void) const
unsigned long GetObjectMTime (void) const
const TransformTypeGetObjectToNodeTransform (void) const
Transforms points from the
object specific physical space
*to the physical space of
its parent object *TransformType
GetObjectToNodeTransform (void)
const TransformTypeGetObjectToParentTransform (void) const
TransformTypeGetObjectToParentTransform (void)
virtual const TransformTypeGetObjectToWorldTransform ()
virtual TransformTypeGetObjectToWorldTransform ()
simplifies the implementation
of *some data accessing algorithms
*const OffsetValueType
GetOffsetTable () const
virtual SelfGetParent (void)
virtual const SelfGetParent (void) const
virtual const int & GetParentId ()
const PropertyTypeGetProperty (void) const
Returns a pointer to the property
object applied to this class
*PropertyType
GetProperty (void)
virtual const double & GetRadius ()
virtual const RegionTypeGetRequestedRegion () const
virtual const double * GetSpacing () const
virtual std::string GetSpatialObjectTypeAsString () const
unsigned long GetTransformMTime (void)
virtual const TreeNodeTypeGetTreeNode ()
Return a raw pointer to the
node container *virtual TreeNodeType
GetTreeNode ()
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) const
virtual bool IsInside (const PointType &point, unsigned int depth, char *) const
 itkStaticConstMacro (ObjectDimension, unsigned int, TDimension)
 itkStaticConstMacro (MaximumDepth, unsigned int, 9999999)
 itkStaticConstMacro (NumberOfDimension, unsigned int, 3)
Transform points from the
internal data coordinate system
*of the 
object (typically the indices of the image from which *the object was defined) to"physical"space(which accounts *for the spacing
void RemoveSpatialObject (Self *object)
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is meaning
that *the bounding box for
the object and all its recursive
children is computed *This
depth can be 
set (before calling ComputeBoundingBox) using *SetBoundingBoxChildrenDepth().**By calling SetBoundingBoxChildrenName()
virtual void SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
Set Get the depth at which
the bounding box is computed
*virtual void 
SetBoundingBoxChildrenDepth (unsigned int _arg)
Set Get the name of the children
to consider when computing
the *bounding box *virtual
void 
SetBoundingBoxChildrenName (std::string _arg)
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is meaning
that *the bounding box for
the object and all its recursive
children is computed *This
depth can be it is possible
to *restrict the bounding
box computation to objects
of a specified *type or family
of types The spatial objects
included in the *computation
are those whose typenames
as their initial the string
specified via 
SetBoundingBoxChildrenName ().*The root spatial object(on which the method is called) is not *treated specially.If its typename does not match the bounding *box children name
virtual void SetBufferedRegion (const RegionType &region)
void SetChildren (ChildrenListType &children)
Set Get the height *virtual
void 
SetHeight (double _arg)
virtual void SetId (int _arg)
virtual void SetLargestPossibleRegion (const RegionType &region)
These function are just calling
the node container transforms
*void 
SetNodeToParentNodeTransform (TransformType *transform)
Transforms points from the
object specific physical space
*to the physical space of
its parent object *void 
SetObjectToParentTransform (TransformType *transform)
This defines the transformation
from the global coordinate
frame *By setting this the
local transform is computed
*void 
SetObjectToWorldTransform (TransformType *transform)
void SetParent (Self *parent)
Set Get the parent Identification
number *virtual void 
SetParentId (int _arg)
void SetProperty (PropertyType *property)
Set Get the radius *virtual
void 
SetRadius (double _arg)
virtual void SetRequestedRegion (DataObject *data)
virtual void SetRequestedRegion (const RegionType &region)
virtual void SetRequestedRegionToLargestPossibleRegion ()
void SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void SetTreeNode (TreeNodeType *_arg)
virtual void Update (void)
virtual void UpdateOutputInformation ()
Set Get the default outside value (ValueAt()) of the object.Default is 0.0 */virtual void SetDefaultOutsideValue(double _arg)
Set Get the default inside value (ValueAt()) of the object.Default is 1.0 */virtual void SetDefaultInsideValue(double _arg)
virtual bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
virtual bool VerifyRequestedRegion ()

Static Public Member Functions

static Pointer New ()

Public Attributes

Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current *etc This
table if of because its *values
are computed progressively 
as
*Compute an axis aligned bounding
box for an object and its
selected * 
children
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current 
column
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is meaning
that *the bounding box for
the object and all its recursive
children is computed *This
depth can be it is possible
to *restrict the bounding
box computation to objects
of a specified *type or family
of types The spatial objects
included in the *computation
are those whose typenames
as their initial the string
specified via then it is not
included in the bounding box * 
computation
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After 
computation
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By 
default
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is 
maximum
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current *etc This
table if of because its *values
are computed progressively 
N1
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current *etc This
table if of because its *values
are computed progressively
N1
N2
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current *etc This
table if of because its *values
are computed progressively
N1 *N1 *N2
N3
Transform points from the
internal data coordinate system
*of the 
orientation
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current 
row
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is meaning
that *the bounding box for
the object and all its recursive
children is computed *This
depth can be it is possible
to *restrict the bounding
box computation to objects
of a specified *type or family
of types The spatial objects
included in the *computation
are those whose typenames 
share
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current *etc This
table if of 
size [VImageDimension+1]
Get the offset table The offset
table gives increments for
*moving from one pixel to
next in the current 
slice
*Compute an axis aligned bounding
box for an object and its
selected down to a specified
depth After the *resulting
bounding box is stored in
this m_Bounds **By the bounding
box children depth is meaning
that *the bounding box for
the object and all its recursive
children is computed *This
depth can be it is possible
to *restrict the bounding
box computation to objects
of a specified *type or family
of types The spatial objects
included in the *computation
are those whose typenames
as their initial * 
substring
This defines the transformation
from the global coordinate
frame *By setting this 
transform

Protected Member Functions

void ComputeOffsetTable ()
 CylinderSpatialObject (void)
virtual const BoundingBoxTypeGetBounds ()
virtual const unsigned int & GetDimension ()
virtual const TransformTypeGetInternalInverseTransform ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void SetDimension (unsigned int _arg)
virtual void SetTypeName (std::string _arg)
 SpatialObject ()
 ~CylinderSpatialObject (void)

Protected Attributes

double m_Height
double m_Radius


Member Typedef Documentation

typedef AffineGeometryFrameType::Pointer itk::SpatialObject< TDimension >::AffineGeometryFramePointer [inherited]
 

Definition at line 115 of file itkSpatialObject.h.

typedef AffineGeometryFrame<double,TDimension> itk::SpatialObject< TDimension >::AffineGeometryFrameType [inherited]
 

Definition at line 114 of file itkSpatialObject.h.

typedef BoundingBoxType::Pointer itk::SpatialObject< TDimension >::BoundingBoxPointer [inherited]
 

Definition at line 112 of file itkSpatialObject.h.

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

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 46 of file itkCylinderSpatialObject.h.

typedef ChildrenListType* itk::SpatialObject< TDimension >::ChildrenListPointer [inherited]
 

Definition at line 119 of file itkSpatialObject.h.

typedef std::list< Pointer > itk::SpatialObject< TDimension >::ChildrenListType [inherited]
 

Return type for the list of children

Definition at line 118 of file itkSpatialObject.h.

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

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 41 of file itkCylinderSpatialObject.h.

typedef CovariantVector<ScalarType, TDimension > itk::SpatialObject< TDimension >::CovariantVectorType [inherited]
 

Definition at line 96 of file itkSpatialObject.h.

typedef Index<TDimension> itk::SpatialObject< TDimension >::IndexType [inherited]
 

Index typedef support. An index is used to access pixel values.

Definition at line 123 of file itkSpatialObject.h.

typedef IndexType::IndexValueType itk::SpatialObject< TDimension >::IndexValueType [inherited]
 

Definition at line 124 of file itkSpatialObject.h.

typedef Point< ScalarType, TDimension > itk::SpatialObject< TDimension >::InputType [inherited]
 

Definition at line 92 of file itkSpatialObject.h.

typedef Offset<TDimension> itk::SpatialObject< TDimension >::OffsetType [inherited]
 

Offset typedef support. An offset represent relative position between indices.

Definition at line 128 of file itkSpatialObject.h.

typedef OffsetType::OffsetValueType itk::SpatialObject< TDimension >::OffsetValueType [inherited]
 

Definition at line 129 of file itkSpatialObject.h.

typedef OutputVectorType* itk::SpatialObject< TDimension >::OutputVectorPointer [inherited]
 

Definition at line 102 of file itkSpatialObject.h.

typedef CovariantVector< double, TDimension > itk::SpatialObject< TDimension >::OutputVectorType [inherited]
 

Definition at line 101 of file itkSpatialObject.h.

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

Definition at line 48 of file itkCylinderSpatialObject.h.

typedef VectorContainer<unsigned long,PointType> itk::CylinderSpatialObject::PointContainerType
 

Definition at line 47 of file itkCylinderSpatialObject.h.

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

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 40 of file itkCylinderSpatialObject.h.

typedef PointType* itk::SpatialObject< TDimension >::PointPointer [inherited]
 

Definition at line 93 of file itkSpatialObject.h.

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

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 44 of file itkCylinderSpatialObject.h.

typedef PropertyType::Pointer itk::SpatialObject< TDimension >::PropertyPointer [inherited]
 

Definition at line 133 of file itkSpatialObject.h.

typedef SpatialObjectProperty< float > itk::SpatialObject< TDimension >::PropertyType [inherited]
 

Definition at line 132 of file itkSpatialObject.h.

typedef ImageRegion<TDimension> itk::SpatialObject< TDimension >::RegionType [inherited]
 

Definition at line 130 of file itkSpatialObject.h.

typedef double itk::CylinderSpatialObject::ScalarType
 

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 39 of file itkCylinderSpatialObject.h.

typedef CylinderSpatialObject itk::CylinderSpatialObject::Self
 

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 38 of file itkCylinderSpatialObject.h.

typedef Size<TDimension> itk::SpatialObject< TDimension >::SizeType [inherited]
 

Definition at line 131 of file itkSpatialObject.h.

typedef double* itk::SpatialObject< TDimension >::SpacingType [inherited]
 

Definition at line 99 of file itkSpatialObject.h.

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

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 42 of file itkCylinderSpatialObject.h.

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

Definition at line 43 of file itkCylinderSpatialObject.h.

typedef const TransformType* itk::SpatialObject< TDimension >::TransformConstPointer [inherited]
 

Definition at line 106 of file itkSpatialObject.h.

typedef TransformType::Pointer itk::SpatialObject< TDimension >::TransformPointer [inherited]
 

Definition at line 105 of file itkSpatialObject.h.

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

Reimplemented from itk::SpatialObject< 3 >.

Definition at line 45 of file itkCylinderSpatialObject.h.

typedef SpatialObjectTreeNode<TDimension> itk::SpatialObject< TDimension >::TreeNodeType [inherited]
 

Definition at line 135 of file itkSpatialObject.h.

typedef VectorContainer< unsigned long int, PointType > itk::SpatialObject< TDimension >::VectorContainerType [inherited]
 

Definition at line 108 of file itkSpatialObject.h.

typedef VectorType* itk::SpatialObject< TDimension >::VectorPointer [inherited]
 

Definition at line 97 of file itkSpatialObject.h.

typedef Vector< ScalarType, TDimension > itk::SpatialObject< TDimension >::VectorType [inherited]
 

Definition at line 95 of file itkSpatialObject.h.


Constructor & Destructor Documentation

itk::CylinderSpatialObject::CylinderSpatialObject void   )  [protected]
 

itk::CylinderSpatialObject::~CylinderSpatialObject void   )  [protected]
 


Member Function Documentation

void itk::SpatialObject< TDimension >::AddSpatialObject Self pointer  )  [inherited]
 

Add an object to the list of children.

virtual void itk::SpatialObject< TDimension >::Clear void   )  [virtual, inherited]
 

Clear the spatial object by deleting all lists of children and subchildren

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is meaning that* the bounding box for the object and all its recursive children is computed* This depth can be it is possible to* restrict the bounding box computation to objects of a specified* type or family of types The spatial objects included in the* computation are those whose typenames as their initial the string specified via then it is not included in the bounding box but its descendents that match the string are* included* virtual bool itk::SpatialObject< TDimension >::ComputeBoundingBox void   )  const [virtual, inherited]
 

Compute the index of the pixel at a specified offset from the* beginning of the buffered region* IndexType itk::SpatialObject< TDimension >::ComputeIndex OffsetValueType  offset  )  const [inline, inherited]
 

Definition at line 316 of file itkSpatialObject.h.

virtual bool itk::CylinderSpatialObject::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< 3 >.

void itk::SpatialObject< TDimension >::ComputeObjectToParentTransform void   )  [inherited]
 

Compute the Local transform when the global transform is set

void itk::SpatialObject< TDimension >::ComputeObjectToWorldTransform void   )  [inherited]
 

Compute the World transform when the local transform is set This function should be called each time the local transform has been modified

Compute an offset from the beginning of the buffer for a pixel* at the specified index* OffsetValueType itk::SpatialObject< TDimension >::ComputeOffset const IndexType ind  )  const [inline, inherited]
 

Definition at line 296 of file itkSpatialObject.h.

void itk::SpatialObject< TDimension >::ComputeOffsetTable  )  [protected, inherited]
 

Calculate the offsets needed to move from one pixel to the next along a row, column, slice, volume, etc. These offsets are based on the size of the BufferedRegion. This should be called after the BufferedRegion is set.

virtual void itk::SpatialObject< TDimension >::CopyInformation const DataObject data  )  [virtual, inherited]
 

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. ImageBase has more meta-data than its DataObject. Thus, it must provide its own version of CopyInformation() in order to copy the LargestPossibleRegion from the input parameter.

virtual void itk::SpatialObject< TDimension >::DerivativeAt const PointType point,
short unsigned int  order,
OutputVectorType value,
unsigned int  depth = 0,
char *  name = NULL
[virtual, inherited]
 

Return the n-th order derivative value at the specified point.

Returns true if a point is inside the object provided* to make spatial objects compatible with spatial functions* and conditional iterators for defining regions of interest* bool itk::SpatialObject< TDimension >::Evaluate const PointType point  )  const [inline, inherited]
 

Definition at line 210 of file itkSpatialObject.h.

Set Get the AffineGeometryFrame* virtual const AffineGeometryFrameType* itk::SpatialObject< TDimension >::GetAffineGeometryFrame  )  [virtual, inherited]
 

virtual BoundingBoxType* itk::SpatialObject< TDimension >::GetBoundingBox void   )  const [virtual, inherited]
 

Get the bounding box of the object. This function calls ComputeBoundingBox()

virtual const unsigned int& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenDepth  )  [virtual, inherited]
 

virtual const std::string& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenName  )  [virtual, inherited]
 

virtual const BoundingBoxType* itk::SpatialObject< TDimension >::GetBounds  )  [protected, virtual, inherited]
 

virtual const RegionType& itk::SpatialObject< TDimension >::GetBufferedRegion  )  const [inline, virtual, inherited]
 

Get the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also:
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

Definition at line 260 of file itkSpatialObject.h.

virtual ChildrenListType* itk::SpatialObject< TDimension >::GetChildren unsigned int  depth = 0,
char *  name = NULL
const [virtual, inherited]
 

Returns a list of pointer to the children affiliated to this object. A depth of 0 returns the immediate childred. A depth of 1 returns the children and those children's children.

Warning:
User is responsible for freeing the list, but not the elements of the list.

virtual double itk::SpatialObject< TDimension >::GetDefaultInsideValue  )  const [virtual, inherited]
 

virtual double itk::SpatialObject< TDimension >::GetDefaultOutsideValue  )  const [virtual, inherited]
 

virtual const unsigned int& itk::SpatialObject< TDimension >::GetDimension void   )  [protected, virtual, inherited]
 

virtual const double& itk::CylinderSpatialObject::GetHeight  )  [virtual]
 

Get Set the ID* virtual const int& itk::SpatialObject< TDimension >::GetId  )  [virtual, inherited]
 

const TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform void   )  const [inherited]
 

Transform points from the internal data coordinate system* of the and offset of the indices* TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform void   )  [inherited]
 

virtual const TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform  )  [virtual, inherited]
 

virtual TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform  )  [virtual, inherited]
 

virtual const TransformType* itk::SpatialObject< TDimension >::GetInternalInverseTransform  )  [protected, virtual, inherited]
 

virtual const RegionType& itk::SpatialObject< TDimension >::GetLargestPossibleRegion  )  const [inline, virtual, inherited]
 

Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also:
ImageRegion, GetBufferedRegion(), GetRequestedRegion()

Definition at line 249 of file itkSpatialObject.h.

unsigned int itk::SpatialObject< TDimension >::GetMaximumDepth  )  [inline, inherited]
 

Return the maximum depth that a tree of spatial objects can have. This provides convenient access to a static constant.

Definition at line 82 of file itkSpatialObject.h.

unsigned long itk::SpatialObject< TDimension >::GetMTime void   )  const [inherited]
 

Returns the latest modified time of the spatial object, and any of its components.

virtual const char* itk::CylinderSpatialObject::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< 3 >.

const TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform void   )  const [inherited]
 

TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform void   )  [inherited]
 

unsigned int itk::SpatialObject< TDimension >::GetNumberOfChildren unsigned int  depth = 0,
char *  name = NULL
const [inherited]
 

Returns the number of children currently assigned to the object.

unsigned int itk::SpatialObject< TDimension >::GetObjectDimension void   )  const [inline, inherited]
 

Get the dimensionality of the object

Definition at line 150 of file itkSpatialObject.h.

unsigned long itk::SpatialObject< TDimension >::GetObjectMTime void   )  const [inline, inherited]
 

Returns the latest modified time of the spatial object, but not the modification time of the children

Definition at line 230 of file itkSpatialObject.h.

const TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform void   )  const [inherited]
 

Transforms points from the object specific physical space* to the physical space of its parent object* TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform void   )  [inherited]
 

const TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform void   )  const [inherited]
 

TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform void   )  [inherited]
 

virtual const TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform  )  [virtual, inherited]
 

virtual TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform  )  [virtual, inherited]
 

simplifies the implementation of* some data accessing algorithms* const OffsetValueType* itk::SpatialObject< TDimension >::GetOffsetTable  )  const [inline, inherited]
 

Definition at line 291 of file itkSpatialObject.h.

virtual Self* itk::SpatialObject< TDimension >::GetParent void   )  [virtual, inherited]
 

Return a pointer to the parent object in the hierarchy tree

virtual const Self* itk::SpatialObject< TDimension >::GetParent void   )  const [virtual, inherited]
 

Return a pointer to the parent object in the hierarchy tree

virtual const int& itk::SpatialObject< TDimension >::GetParentId void   )  [virtual, inherited]
 

const PropertyType* itk::SpatialObject< TDimension >::GetProperty void   )  const [inline, inherited]
 

Definition at line 382 of file itkSpatialObject.h.

Returns a pointer to the property object applied to this class* PropertyType* itk::SpatialObject< TDimension >::GetProperty void   )  [inherited]
 

virtual const double& itk::CylinderSpatialObject::GetRadius  )  [virtual]
 

virtual const RegionType& itk::SpatialObject< TDimension >::GetRequestedRegion  )  const [inline, virtual, inherited]
 

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

See also:
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

Definition at line 279 of file itkSpatialObject.h.

virtual const double* itk::SpatialObject< TDimension >::GetSpacing  )  const [inline, virtual, inherited]
 

Get the spacing of the spatial object.

Definition at line 417 of file itkSpatialObject.h.

virtual std::string itk::SpatialObject< TDimension >::GetSpatialObjectTypeAsString  )  const [virtual, inherited]
 

Return the type of the spatial object as a string This is used by the SpatialObjectFactory

unsigned long itk::SpatialObject< TDimension >::GetTransformMTime void   )  [inherited]
 

Return the Modified time of the LocalToWorldTransform

virtual const TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode  )  [virtual, inherited]
 

Return a raw pointer to the node container* virtual TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode  )  [virtual, inherited]
 

virtual const char* itk::SpatialObject< TDimension >::GetTypeName void   )  const [inline, virtual, inherited]
 

Get the typename of the SpatialObject

Definition at line 142 of file itkSpatialObject.h.

unsigned long itk::SpatialObject< TDimension >::GetWorldTransformMTime void   )  [inherited]
 

Return the Modified time of the WorldToLocalTransform

virtual bool itk::SpatialObject< TDimension >::HasParent void   )  const [virtual, inherited]
 

Return true if the object has a parent object. Basically, only the root object , or some isolated objects should return false.

virtual bool itk::CylinderSpatialObject::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.

Reimplemented from itk::SpatialObject< 3 >.

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

virtual bool itk::CylinderSpatialObject::IsInside const PointType point,
unsigned int  depth,
char * 
const [virtual]
 

Test whether a point is inside or outside the object

Reimplemented from itk::SpatialObject< 3 >.

itk::SpatialObject< TDimension >::itkStaticConstMacro ObjectDimension  ,
unsigned  int,
TDimension 
[inherited]
 

Dimension of the object. This constant is used by functions that are templated over SpatialObject type when they need compile time access to the dimension of the object.

itk::SpatialObject< TDimension >::itkStaticConstMacro MaximumDepth  ,
unsigned  int,
9999999 
[inherited]
 

itk::CylinderSpatialObject::itkStaticConstMacro NumberOfDimension  ,
unsigned  int,
 

static Pointer itk::CylinderSpatialObject::New void   )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< 3 >.

Transform points from the internal data coordinate system* of the itk::SpatialObject< TDimension >::object typically the indices of the image from which *the object was  defined  )  [inherited]
 

virtual void itk::CylinderSpatialObject::PrintSelf std::ostream &  os,
Indent  indent
const [protected, virtual]
 

Print the object informations in a stream.

Reimplemented from itk::SpatialObject< 3 >.

void itk::SpatialObject< TDimension >::RemoveSpatialObject Self object  )  [inherited]
 

Remove the object passed as arguments from the list of children. May this function should return a false value if the object to remove is not found in the list.

virtual bool itk::SpatialObject< TDimension >::RequestedRegionIsOutsideOfTheBufferedRegion  )  [virtual, inherited]
 

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is meaning that* the bounding box for the object and all its recursive children is computed* This depth can be itk::SpatialObject< TDimension >::set before calling  ComputeBoundingBox  )  [inherited]
 

virtual void itk::SpatialObject< TDimension >::SetAffineGeometryFrame AffineGeometryFrameType _arg  )  [virtual, inherited]
 

Set Get the depth at which the bounding box is computed* virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenDepth unsigned int  _arg  )  [virtual, inherited]
 

Set Get the name of the children to consider when computing the* bounding box* virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenName std::string  _arg  )  [virtual, inherited]
 

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is meaning that* the bounding box for the object and all its recursive children is computed* This depth can be it is possible to* restrict the bounding box computation to objects of a specified* type or family of types The spatial objects included in the* computation are those whose typenames as their initial the string specified via itk::SpatialObject< TDimension >::SetBoundingBoxChildrenName  )  [inherited]
 

virtual void itk::SpatialObject< TDimension >::SetBufferedRegion const RegionType region  )  [virtual, inherited]
 

Set the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also:
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

void itk::SpatialObject< TDimension >::SetChildren ChildrenListType children  )  [inherited]
 

Set the list of pointers to children to the list passed as argument.

virtual void itk::SpatialObject< TDimension >::SetDimension unsigned int  _arg  )  [protected, virtual, inherited]
 

Set Get the height* virtual void itk::CylinderSpatialObject::SetHeight double  _arg  )  [virtual]
 

virtual void itk::SpatialObject< TDimension >::SetId int  _arg  )  [virtual, inherited]
 

virtual void itk::SpatialObject< TDimension >::SetLargestPossibleRegion const RegionType region  )  [virtual, inherited]
 

Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also:
ImageRegion, SetBufferedRegion(), SetRequestedRegion()

These function are just calling the node container transforms* void itk::SpatialObject< TDimension >::SetNodeToParentNodeTransform TransformType transform  )  [inherited]
 

Transforms points from the object specific physical space* to the physical space of its parent object* void itk::SpatialObject< TDimension >::SetObjectToParentTransform TransformType transform  )  [inherited]
 

This defines the transformation from the global coordinate frame* By setting this the local transform is computed* void itk::SpatialObject< TDimension >::SetObjectToWorldTransform TransformType transform  )  [inherited]
 

void itk::SpatialObject< TDimension >::SetParent Self parent  )  [inherited]
 

Set the pointer to the parent object in the tree hierarchy used for the spatial object patter.

Set Get the parent Identification number* virtual void itk::SpatialObject< TDimension >::SetParentId int  _arg  )  [virtual, inherited]
 

void itk::SpatialObject< TDimension >::SetProperty PropertyType property  )  [inherited]
 

Set the property applied to the object.

Set Get the radius* virtual void itk::CylinderSpatialObject::SetRadius double  _arg  )  [virtual]
 

virtual void itk::SpatialObject< TDimension >::SetRequestedRegion DataObject data  )  [virtual, inherited]
 

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase.

virtual void itk::SpatialObject< TDimension >::SetRequestedRegion const RegionType region  )  [virtual, inherited]
 

Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

See also:
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

virtual void itk::SpatialObject< TDimension >::SetRequestedRegionToLargestPossibleRegion  )  [virtual, inherited]
 

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

void itk::SpatialObject< TDimension >::SetSpacing const double  spacing[itkGetStaticConstMacro(ObjectDimension)]  )  [inline, inherited]
 

Set the spacing of the spatial object.

Definition at line 412 of file itkSpatialObject.h.

virtual void itk::SpatialObject< TDimension >::SetTreeNode TreeNodeType _arg  )  [virtual, inherited]
 

Set the tree container

virtual void itk::SpatialObject< TDimension >::SetTypeName std::string  _arg  )  [protected, virtual, inherited]
 

itk::SpatialObject< TDimension >::SpatialObject  )  [protected, inherited]
 

Constructor.

virtual void itk::SpatialObject< TDimension >::Update void   )  [virtual, inherited]
 

Specify that the object has been updated

virtual void itk::SpatialObject< TDimension >::UpdateOutputInformation  )  [virtual, inherited]
 

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. This method calls its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc.

Set Get the default outside itk::SpatialObject< TDimension >::value ValueAt()   )  [inherited]
 

Set Get the default inside itk::SpatialObject< TDimension >::value ValueAt()   )  [inherited]
 

virtual bool itk::CylinderSpatialObject::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.

Reimplemented from itk::SpatialObject< 3 >.

virtual bool itk::SpatialObject< TDimension >::VerifyRequestedRegion  )  [virtual, inherited]
 

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possible satisfy the request. This method returns true if the request can be satisfied and returns fails if the request cannot. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception is the requested region is not within the LargestPossibleRegion.


Member Data Documentation

Get the offset table The offset table gives increments for* moving from one pixel to next in the current * etc This table if of because its* values are computed progressively itk::SpatialObject< TDimension >::as [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected* itk::SpatialObject< TDimension >::children [inherited]
 

Definition at line 484 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current itk::SpatialObject< TDimension >::column [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is meaning that* the bounding box for the object and all its recursive children is computed* This depth can be it is possible to* restrict the bounding box computation to objects of a specified* type or family of types The spatial objects included in the* computation are those whose typenames as their initial the string specified via then it is not included in the bounding box* itk::SpatialObject< TDimension >::computation [inherited]
 

Definition at line 500 of file itkSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After itk::SpatialObject< TDimension >::computation [inherited]
 

Definition at line 484 of file itkSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By itk::SpatialObject< TDimension >::default [inherited]
 

Definition at line 484 of file itkSpatialObject.h.

double itk::CylinderSpatialObject::m_Height [protected]
 

Definition at line 100 of file itkCylinderSpatialObject.h.

double itk::CylinderSpatialObject::m_Radius [protected]
 

Definition at line 99 of file itkCylinderSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is itk::SpatialObject< TDimension >::maximum [inherited]
 

Definition at line 484 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current * etc This table if of because its* values are computed progressively itk::SpatialObject< TDimension >::N1 [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current * etc This table if of because its* values are computed progressively N1* itk::SpatialObject< TDimension >::N2 [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current * etc This table if of because its* values are computed progressively N1 * N1* N2* itk::SpatialObject< TDimension >::N3 [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

Transform points from the internal data coordinate system* of the itk::SpatialObject< TDimension >::orientation [inherited]
 

Definition at line 424 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current itk::SpatialObject< TDimension >::row [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is meaning that* the bounding box for the object and all its recursive children is computed* This depth can be it is possible to* restrict the bounding box computation to objects of a specified* type or family of types The spatial objects included in the* computation are those whose typenames itk::SpatialObject< TDimension >::share [inherited]
 

Definition at line 495 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current * etc This table if of itk::SpatialObject< TDimension >::size[VImageDimension+1] [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

Get the offset table The offset table gives increments for* moving from one pixel to next in the current itk::SpatialObject< TDimension >::slice [inherited]
 

Definition at line 280 of file itkSpatialObject.h.

* Compute an axis aligned bounding box for an object and its selected down to a specified depth After the* resulting bounding box is stored in this m_Bounds* * By the bounding box children depth is meaning that* the bounding box for the object and all its recursive children is computed* This depth can be it is possible to* restrict the bounding box computation to objects of a specified* type or family of types The spatial objects included in the* computation are those whose typenames as their initial* itk::SpatialObject< TDimension >::substring [inherited]
 

Definition at line 495 of file itkSpatialObject.h.

This defines the transformation from the global coordinate frame* By setting this itk::SpatialObject< TDimension >::transform [inherited]
 

Definition at line 160 of file itkSpatialObject.h.


The documentation for this class was generated from the following file:
Generated at Sun Jul 9 19:28:08 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000