ITK  4.12.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::ContourSpatialObject< TDimension > Class Template Reference

#include <itkContourSpatialObject.h>

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

Detailed Description

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

Representation of a Contour based on the spatial object classes.

The Contour is basically defined by a set of points which are inside this blob

See Also
SpatialObjectPoint

Definition at line 39 of file itkContourSpatialObject.h.

Public Types

typedef Superclass::BoundingBoxType BoundingBoxType
 
typedef SmartPointer< const SelfConstPointer
 
typedef std::vector
< ControlPointType
ControlPointListType
 
typedef
ContourSpatialObjectPoint
< TDimension > 
ControlPointType
 
typedef std::vector
< InterpolatedPointType
InterpolatedPointListType
 
typedef SpatialObjectPoint
< TDimension > 
InterpolatedPointType
 
enum  InterpolationType {
  NO_INTERPOLATION = 0,
  EXPLICIT_INTERPOLATION,
  BEZIER_INTERPOLATION,
  LINEAR_INTERPOLATION
}
 
typedef SmartPointer
< PointContainerType
PointContainerPointer
 
typedef VectorContainer
< IdentifierType, PointType
PointContainerType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef double ScalarType
 
typedef ContourSpatialObject Self
 
typedef
Superclass::SpatialObjectPointType 
SpatialObjectPointType
 
typedef
PointBasedSpatialObject
< TDimension > 
Superclass
 
typedef Superclass::TransformType TransformType
 
- Public Types inherited from itk::PointBasedSpatialObject< TDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::CovariantVectorType 
CovariantVectorType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef double ScalarType
 
typedef PointBasedSpatialObject Self
 
typedef SpatialObjectPoint
< TDimension > 
SpatialObjectPointType
 
typedef SpatialObject< TDimension > Superclass
 
typedef Superclass::TransformType TransformType
 
typedef Superclass::VectorType 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 SmartPointer< const SelfConstPointer
 
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 SmartPointer< SelfPointer
 
typedef PointTypePointPointer
 
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 TransformTypeTransformConstPointer
 
typedef TransformType::Pointer TransformPointer
 
typedef
ScalableAffineTransform
< double, VDimension > 
TransformType
 
typedef SpatialObjectTreeNode
< VDimension > 
TreeNodeType
 
typedef VectorContainer
< IdentifierType, PointType
VectorContainerType
 
typedef VectorTypeVectorPointer
 
typedef Vector< ScalarType,
VDimension > 
VectorType
 

Public Member Functions

bool ComputeLocalBoundingBox (void) const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const ControlPointTypeGetControlPoint (IdentifierType id) const
 
ControlPointTypeGetControlPoint (IdentifierType id)
 
ControlPointListTypeGetControlPoints ()
 
const ControlPointListTypeGetControlPoints () const
 
const InterpolatedPointTypeGetInterpolatedPoint (IdentifierType id) const
 
InterpolatedPointTypeGetInterpolatedPoint (IdentifierType id)
 
InterpolatedPointListTypeGetInterpolatedPoints ()
 
const InterpolatedPointListTypeGetInterpolatedPoints () const
 
virtual const char * GetNameOfClass () const
 
SizeValueType GetNumberOfControlPoints (void) const
 
SizeValueType GetNumberOfInterpolatedPoints (void) const
 
bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const override
 
bool IsInside (const PointType &point, unsigned int depth, char *name) const override
 
virtual bool IsInside (const PointType &point) const
 
void SetControlPoints (ControlPointListType &newPoints)
 
void SetInterpolatedPoints (InterpolatedPointListType &newPoints)
 
bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const override
 
InterpolationType GetInterpolationType () const
 
void SetInterpolationType (InterpolationType interpolation)
 
virtual void SetClosed (bool _arg)
 
virtual bool GetClosed () const
 
virtual void SetDisplayOrientation (int _arg)
 
virtual int GetDisplayOrientation () const
 
virtual void SetAttachedToSlice (int _arg)
 
virtual int GetAttachedToSlice () const
 
- Public Member Functions inherited from itk::PointBasedSpatialObject< TDimension >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual SpatialObjectPointTypeitkWarningMacro (<< "PointBasedSpatialObject::GetPoint() is not implemented"<< " in the base class"<< std::endl)
 
virtual const
SpatialObjectPointType
GetPoint (IdentifierType) const
 
virtual SizeValueType GetNumberOfPoints (void) const
 
bool ComputeLocalBoundingBox () const override
 
- Public Member Functions inherited from itk::SpatialObject< TDimension >
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 BoundingBoxTypeGetBoundingBox () const
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=nullptr) const
 
const TransformTypeGetIndexToObjectTransform () const
 
TransformTypeGetIndexToObjectTransform (void)
 
virtual const TransformTypeGetIndexToWorldTransform () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
unsigned int GetMaximumDepth () const
 
TransformTypeGetModifiableIndexToObjectTransform (void)
 
virtual TransformTypeGetModifiableIndexToWorldTransform ()
 
virtual TreeNodeTypeGetModifiableTreeNode ()
 
virtual ModifiedTimeType GetMTime (void) const override
 
TransformTypeGetNodeToParentNodeTransform ()
 
const TransformTypeGetNodeToParentNodeTransform () const
 
unsigned int GetNumberOfChildren (unsigned int depth=0, char *name=nullptr) const
 
unsigned int GetObjectDimension (void) const
 
ModifiedTimeType GetObjectMTime (void) const
 
TransformTypeGetObjectToNodeTransform ()
 
const TransformTypeGetObjectToNodeTransform () const
 
TransformTypeGetObjectToParentTransform ()
 
const TransformTypeGetObjectToParentTransform () const
 
virtual const SelfGetParent () const
 
virtual SelfGetParent ()
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const double * GetSpacing () const
 
virtual std::string GetSpatialObjectTypeAsString () const
 
ModifiedTimeType GetTransformMTime ()
 
virtual const TreeNodeTypeGetTreeNode () const
 
virtual const char * GetTypeName (void) const
 
ModifiedTimeType GetWorldTransformMTime ()
 
virtual bool HasParent () 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 void SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
 
virtual AffineGeometryFrameTypeGetModifiableAffineGeometryFrame ()
 
virtual const
AffineGeometryFrameType
GetAffineGeometryFrame () const
 
void SetObjectToWorldTransform (TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToWorldTransform ()
 
virtual const TransformTypeGetObjectToWorldTransform () const
 
const OffsetValueTypeGetOffsetTable () 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
 
PropertyTypeGetProperty ()
 
const PropertyTypeGetProperty (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
 
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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::PointBasedSpatialObject< TDimension >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::SpatialObject< TDimension >
static Pointer New ()
 

Protected Member Functions

 ContourSpatialObject ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ContourSpatialObject ()
 
- Protected Member Functions inherited from itk::PointBasedSpatialObject< TDimension >
 PointBasedSpatialObject ()
 
virtual ~PointBasedSpatialObject ()
 
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
void ComputeOffsetTable ()
 
virtual const BoundingBoxTypeGetBounds () const
 
virtual const unsigned int & GetDimension () const
 
virtual const TransformTypeGetInternalInverseTransform () const
 
virtual BoundingBoxTypeGetModifiableBounds ()
 
virtual TransformTypeGetModifiableInternalInverseTransform ()
 
virtual void SetDimension (unsigned int _arg)
 
bool SetInternalInverseTransformToWorldToIndexTransform () const
 
virtual void SetTypeName (std::string _arg)
 
 SpatialObject ()
 
virtual ~SpatialObject ()
 

Protected Attributes

int m_AttachedToSlice
 
bool m_Closed
 
ControlPointListType m_ControlPoints
 
int m_DisplayOrientation
 
InterpolatedPointListType m_InterpolatedPoints
 
InterpolationType m_InterpolationType
 

Additional Inherited Members

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

Member Typedef Documentation

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

Definition at line 57 of file itkContourSpatialObject.h.

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

Definition at line 47 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
typedef std::vector< ControlPointType > itk::ContourSpatialObject< TDimension >::ControlPointListType

Definition at line 51 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
typedef ContourSpatialObjectPoint< TDimension > itk::ContourSpatialObject< TDimension >::ControlPointType

Definition at line 49 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
typedef std::vector< InterpolatedPointType > itk::ContourSpatialObject< TDimension >::InterpolatedPointListType

Definition at line 52 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SpatialObjectPoint< TDimension > itk::ContourSpatialObject< TDimension >::InterpolatedPointType

Definition at line 50 of file itkContourSpatialObject.h.

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

Definition at line 59 of file itkContourSpatialObject.h.

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

Definition at line 58 of file itkContourSpatialObject.h.

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

Definition at line 46 of file itkContourSpatialObject.h.

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

Definition at line 55 of file itkContourSpatialObject.h.

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

Definition at line 48 of file itkContourSpatialObject.h.

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

Definition at line 44 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::SpatialObjectPointType itk::ContourSpatialObject< TDimension >::SpatialObjectPointType

Definition at line 54 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
typedef PointBasedSpatialObject< TDimension > itk::ContourSpatialObject< TDimension >::Superclass

Definition at line 45 of file itkContourSpatialObject.h.

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

Definition at line 56 of file itkContourSpatialObject.h.

Member Enumeration Documentation

template<unsigned int TDimension = 3>
enum itk::ContourSpatialObject::InterpolationType
Enumerator
NO_INTERPOLATION 
EXPLICIT_INTERPOLATION 
BEZIER_INTERPOLATION 
LINEAR_INTERPOLATION 

Definition at line 109 of file itkContourSpatialObject.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::ContourSpatialObject< TDimension >::ContourSpatialObject ( )
protected
template<unsigned int TDimension = 3>
virtual itk::ContourSpatialObject< TDimension >::~ContourSpatialObject ( )
protectedvirtual

Member Function Documentation

template<unsigned int TDimension = 3>
bool itk::ContourSpatialObject< TDimension >::ComputeLocalBoundingBox ( void  ) const
overridevirtual

Compute the boundaries of the Contour.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual::itk::LightObject::Pointer itk::ContourSpatialObject< TDimension >::CreateAnother ( ) const
template<unsigned int TDimension = 3>
virtual int itk::ContourSpatialObject< TDimension >::GetAttachedToSlice ( ) const
virtual

Set/Get the slice attached to the contour if any -1 is returned if no contour attached.

template<unsigned int TDimension = 3>
virtual bool itk::ContourSpatialObject< TDimension >::GetClosed ( ) const
virtual

Set/Get if the contour is closed

template<unsigned int TDimension = 3>
const ControlPointType* itk::ContourSpatialObject< TDimension >::GetControlPoint ( IdentifierType  id) const
inline

Return a control point in the list given the index

Definition at line 77 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
ControlPointType* itk::ContourSpatialObject< TDimension >::GetControlPoint ( IdentifierType  id)
inline

Return a control point in the list given the index

Definition at line 81 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
ControlPointListType& itk::ContourSpatialObject< TDimension >::GetControlPoints ( )

Returns a reference to the list of the control points.

template<unsigned int TDimension = 3>
const ControlPointListType& itk::ContourSpatialObject< TDimension >::GetControlPoints ( ) const

Returns a reference to the list of the control points.

template<unsigned int TDimension = 3>
virtual int itk::ContourSpatialObject< TDimension >::GetDisplayOrientation ( ) const
virtual

Set/Get the display orientation of the contour

template<unsigned int TDimension = 3>
const InterpolatedPointType* itk::ContourSpatialObject< TDimension >::GetInterpolatedPoint ( IdentifierType  id) const
inline

Return a interpolated point in the list given the index

Definition at line 98 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
InterpolatedPointType* itk::ContourSpatialObject< TDimension >::GetInterpolatedPoint ( IdentifierType  id)
inline

Return a interpolated point in the list given the index

Definition at line 102 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
InterpolatedPointListType& itk::ContourSpatialObject< TDimension >::GetInterpolatedPoints ( )

Returns a reference to the list of the interpolated points.

template<unsigned int TDimension = 3>
const InterpolatedPointListType& itk::ContourSpatialObject< TDimension >::GetInterpolatedPoints ( ) const

Returns a reference to the list of the interpolated points.

template<unsigned int TDimension = 3>
InterpolationType itk::ContourSpatialObject< TDimension >::GetInterpolationType ( ) const
inline

Set/Get the interpolation type

Definition at line 114 of file itkContourSpatialObject.h.

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

Method for creation through the object factory.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
SizeValueType itk::ContourSpatialObject< TDimension >::GetNumberOfControlPoints ( void  ) const
inline

Return the number of control points in the list

Definition at line 85 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
SizeValueType itk::ContourSpatialObject< TDimension >::GetNumberOfInterpolatedPoints ( void  ) const
inline

Return the number of interpolated points in the list

Definition at line 106 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
bool itk::ContourSpatialObject< TDimension >::IsEvaluableAt ( const PointType point,
unsigned int  depth = 0,
char *  name = nullptr 
) const
overridevirtual

Returns true if the Contour is evaluable at the requested point, false otherwise.

Note: For this class, this will always return false. -GH

Reimplemented from itk::SpatialObject< TDimension >.

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

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

Reimplemented from itk::SpatialObject< TDimension >.

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

Method for creation through the object factory.

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

Method to print the object.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual void itk::ContourSpatialObject< TDimension >::SetAttachedToSlice ( int  _arg)
virtual

Set/Get the slice attached to the contour if any -1 is returned if no contour attached.

template<unsigned int TDimension = 3>
virtual void itk::ContourSpatialObject< TDimension >::SetClosed ( bool  _arg)
virtual

Set/Get if the contour is closed

template<unsigned int TDimension = 3>
void itk::ContourSpatialObject< TDimension >::SetControlPoints ( ControlPointListType newPoints)

Set the list of control points.

template<unsigned int TDimension = 3>
virtual void itk::ContourSpatialObject< TDimension >::SetDisplayOrientation ( int  _arg)
virtual

Set/Get the display orientation of the contour

template<unsigned int TDimension = 3>
void itk::ContourSpatialObject< TDimension >::SetInterpolatedPoints ( InterpolatedPointListType newPoints)

Set the list of interpolated points.

template<unsigned int TDimension = 3>
void itk::ContourSpatialObject< TDimension >::SetInterpolationType ( InterpolationType  interpolation)
inline

Set/Get the interpolation type

Definition at line 116 of file itkContourSpatialObject.h.

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

Returns the value of the Contour at that point. Currently this function returns a binary value, but it might want to return a degree of membership in case of fuzzy Contours.

Reimplemented from itk::SpatialObject< TDimension >.

Member Data Documentation

template<unsigned int TDimension = 3>
int itk::ContourSpatialObject< TDimension >::m_AttachedToSlice
protected

Definition at line 171 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
bool itk::ContourSpatialObject< TDimension >::m_Closed
protected

Definition at line 169 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
ControlPointListType itk::ContourSpatialObject< TDimension >::m_ControlPoints
protected

Definition at line 164 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
int itk::ContourSpatialObject< TDimension >::m_DisplayOrientation
protected

Definition at line 170 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
InterpolatedPointListType itk::ContourSpatialObject< TDimension >::m_InterpolatedPoints
protected

Definition at line 167 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>
InterpolationType itk::ContourSpatialObject< TDimension >::m_InterpolationType
protected

Definition at line 168 of file itkContourSpatialObject.h.


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