ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::PolygonSpatialObject< TDimension > Class Template Reference

#include <itkPolygonSpatialObject.h>

Detailed Description

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

TODO.

Examples
Examples/Filtering/SpatialObjectToImage3.cxx.

Definition at line 32 of file itkPolygonSpatialObject.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ObjectDimensionType = unsigned int
 
using Pointer = SmartPointer< Self >
 
using PolygonPointListType = std::vector< PolygonPointType >
 
using PolygonPointType = SpatialObjectPoint< TDimension >
 
using Self = PolygonSpatialObject< TDimension >
 
using Superclass = PointBasedSpatialObject< TDimension >
 
- Public Types inherited from itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = double
 
using Self = PointBasedSpatialObject
 
using SpatialObjectPointListType = std::vector< SpatialObjectPointType >
 
using SpatialObjectPointType = SpatialObjectPoint< TDimension >
 
using Superclass = SpatialObject< TDimension >
 
- Public Types inherited from itk::SpatialObject< TDimension >
using BoundingBoxPointer = typename BoundingBoxType::Pointer
 
using BoundingBoxType = BoundingBox< IdentifierType, VDimension, ScalarType, VectorContainerType >
 
using ChildrenConstListPointer = ChildrenConstListType *
 
using ChildrenConstListType = std::list< ConstPointer >
 
using ChildrenListPointer = ChildrenListType *
 
using ChildrenListType = std::list< Pointer >
 
using ConstPointer = SmartPointer< const Self >
 
using CovariantVectorType = CovariantVector< ScalarType, VDimension >
 
using DerivativeOffsetType = Vector< double, VDimension >
 
using DerivativeVectorPointer = DerivativeVectorType *
 
using DerivativeVectorType = CovariantVector< ScalarType, VDimension >
 
using IndexType = Index< VDimension >
 
using InputType = Point< ScalarType, VDimension >
 
using ObjectConstListType = std::list< ConstPointer >
 
using ObjectDimensionType = unsigned int
 
using ObjectListType = std::list< Pointer >
 
using Pointer = SmartPointer< Self >
 
using PointPointer = PointType *
 
using PointType = Point< ScalarType, VDimension >
 
using PropertyType = SpatialObjectProperty
 
using RegionType = ImageRegion< VDimension >
 
using ScalarType = double
 
using Self = SpatialObject< VDimension >
 
using SizeType = Size< VDimension >
 
using Superclass = DataObject
 
using TransformConstPointer = const TransformType *
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = AffineTransform< ScalarType, VDimension >
 
using VectorContainerType = VectorContainer< IdentifierType, PointType >
 
using VectorPointer = VectorType *
 
using VectorType = Vector< ScalarType, VDimension >
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void Clear () override
 
virtual bool GetIsClosed () const
 
const char * GetNameOfClass () const override
 
int GetOrientationInObjectSpace () const
 
virtual double GetThicknessInObjectSpace () const
 
virtual void IsClosedOn ()
 
bool IsInsideInObjectSpace (const PointType &point) const override
 
double MeasureAreaInObjectSpace () const
 
double MeasurePerimeterInObjectSpace () const
 
double MeasureVolumeInObjectSpace () const
 
virtual void SetIsClosed (bool _arg)
 
virtual void SetThicknessInObjectSpace (double _arg)
 
- Public Member Functions inherited from itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >
virtual void AddPoint (const SpatialObjectPointType &newPoint)
 
void Clear () override
 
SpatialObjectPoint< TDimension > ClosestPointInObjectSpace (const PointType &point) const
 
SpatialObjectPoint< TDimension > ClosestPointInWorldSpace (const PointType &point) const
 
const char * GetNameOfClass () const override
 
virtual SizeValueType GetNumberOfPoints () const
 
virtual SpatialObjectPointTypeGetPoint (IdentifierType id)
 
virtual const SpatialObjectPointTypeGetPoint (IdentifierType id) const
 
virtual SpatialObjectPointListTypeGetPoints ()
 
virtual const SpatialObjectPointListTypeGetPoints () const
 
bool IsInsideInObjectSpace (const PointType &point) const override
 
virtual void RemovePoint (IdentifierType id)
 
virtual void SetPoints (const SpatialObjectPointListType &newPoints)
 
- Public Member Functions inherited from itk::SpatialObject< TDimension >
void AddChild (Self *pointer)
 
virtual void AddChildrenToConstList (ChildrenConstListType *childrenList, unsigned int depth=0, const std::string &name="") const
 
virtual void AddChildrenToList (ChildrenListType *childrenList, unsigned int depth=0, const std::string &name="") const
 
bool CheckIdValidity () const
 
virtual bool ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const
 
void ComputeObjectToParentTransform ()
 
void CopyInformation (const DataObject *data) override
 
virtual void DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))
 
void DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))
 
bool Evaluate (const PointType &point) const
 
void FixIdValidity ()
 
bool FixParentChildHierarchyUsingParentIds ()
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual ChildrenListTypeGetChildren (unsigned int depth=0, const std::string &name="") const
 
virtual std::string GetClassNameAndDimension () const
 
virtual ChildrenConstListTypeGetConstChildren (unsigned int depth=0, const std::string &name="") const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInWorldSpace () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
unsigned int GetMaximumDepth () const
 
ModifiedTimeType GetMTime () const override
 
virtual const BoundingBoxTypeGetMyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetMyBoundingBoxInWorldSpace () const
 
ModifiedTimeType GetMyMTime () const
 
const char * GetNameOfClass () const override
 
int GetNextAvailableId () const
 
unsigned int GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const
 
SpatialObject< VDimension > * GetObjectById (int id)
 
unsigned int GetObjectDimension () const
 
virtual SelfGetParent ()
 
virtual const SelfGetParent () const
 
PropertyTypeGetProperty ()
 
const PropertyTypeGetProperty () const
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const std::string GetTypeName () const
 
virtual bool HasParent () const
 
virtual bool IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
bool IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsInsideChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
bool IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const
 
bool IsInsideInWorldSpace (const PointType &point) const
 
bool IsInsideInWorldSpace (const PointType &point, unsigned int depth, const std::string &name="") const
 
void RemoveAllChildren (unsigned int depth=MaximumDepth)
 
bool RemoveChild (Self *pointer)
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetBufferedRegion (const RegionType &region)
 
void SetChildren (ChildrenListType &children)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
void SetParent (Self *parent)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegionToLargestPossibleRegion () override
 
virtual void SetTypeName (std::string _arg)
 
void Update () override
 
void UpdateOutputInformation () override
 
virtual bool ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool ValueAtInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
bool ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
bool VerifyRequestedRegion () override
 
void SetId (int id)
 
virtual const int & GetId () const
 
void SetProperty (const PropertyType &property)
 
void SetObjectToWorldTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToWorldTransform ()
 
const TransformTypeGetObjectToWorldTransformInverse () const
 
void SetObjectToParentTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToParentTransform ()
 
const TransformTypeGetObjectToParentTransformInverse () const
 
virtual void SetDefaultInsideValue (double _arg)
 
virtual double GetDefaultInsideValue () const
 
virtual void SetDefaultOutsideValue (double _arg)
 
virtual double GetDefaultOutsideValue () const
 
virtual void SetParentId (int _arg)
 
virtual const int & GetParentId () const
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void UpdateOutputData ()
 
void UpdateSource () const
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

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

Static Public Attributes

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

Protected Member Functions

LightObject::Pointer InternalClone () const override
 
 PolygonSpatialObject ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PolygonSpatialObject () override=default
 
- Protected Member Functions inherited from itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >
void ComputeMyBoundingBox () override
 
LightObject::Pointer InternalClone () const override
 
 PointBasedSpatialObject ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PointBasedSpatialObject () override=default
 
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
BoundingBoxTypeGetModifiableMyBoundingBoxInObjectSpace ()
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ProtectedComputeObjectToWorldTransform ()
 
 SpatialObject ()=default
 
 ~SpatialObject () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

bool m_IsClosed {}
 
int m_OrientationInObjectSpace {}
 
ModifiedTimeType m_OrientationInObjectSpaceMTime {}
 
double m_ThicknessInObjectSpace {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >
SpatialObjectPointListType m_Points
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 41 of file itkPolygonSpatialObject.h.

◆ ObjectDimensionType

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::ObjectDimensionType = unsigned int

Definition at line 50 of file itkPolygonSpatialObject.h.

◆ Pointer

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::Pointer = SmartPointer<Self>

Definition at line 40 of file itkPolygonSpatialObject.h.

◆ PolygonPointListType

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::PolygonPointListType = std::vector<PolygonPointType>

Definition at line 44 of file itkPolygonSpatialObject.h.

◆ PolygonPointType

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::PolygonPointType = SpatialObjectPoint<TDimension>

Definition at line 43 of file itkPolygonSpatialObject.h.

◆ Self

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::Self = PolygonSpatialObject<TDimension>

Definition at line 38 of file itkPolygonSpatialObject.h.

◆ Superclass

template<unsigned int TDimension = 3>
using itk::PolygonSpatialObject< TDimension >::Superclass = PointBasedSpatialObject<TDimension>

Definition at line 39 of file itkPolygonSpatialObject.h.

Constructor & Destructor Documentation

◆ PolygonSpatialObject()

template<unsigned int TDimension = 3>
itk::PolygonSpatialObject< TDimension >::PolygonSpatialObject ( )
protected

◆ ~PolygonSpatialObject()

template<unsigned int TDimension = 3>
itk::PolygonSpatialObject< TDimension >::~PolygonSpatialObject ( )
overrideprotecteddefault

Member Function Documentation

◆ Clear()

template<unsigned int TDimension = 3>
void itk::PolygonSpatialObject< TDimension >::Clear ( )
overridevirtual

Reset the spatial object to its initial condition, yet preserves Id, Parent, and Child information

Reimplemented from itk::SpatialObject< TDimension >.

◆ GetIsClosed()

template<unsigned int TDimension = 3>
virtual bool itk::PolygonSpatialObject< TDimension >::GetIsClosed ( ) const
virtual

Get if the contour is closed

◆ GetNameOfClass()

template<unsigned int TDimension = 3>
const char* itk::PolygonSpatialObject< TDimension >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ GetOrientationInObjectSpace()

template<unsigned int TDimension = 3>
int itk::PolygonSpatialObject< TDimension >::GetOrientationInObjectSpace ( ) const

Method returning plane alignment of strand

◆ GetThicknessInObjectSpace()

template<unsigned int TDimension = 3>
virtual double itk::PolygonSpatialObject< TDimension >::GetThicknessInObjectSpace ( ) const
virtual

Method gets the thickness of the current strand

◆ InternalClone()

template<unsigned int TDimension = 3>
LightObject::Pointer itk::PolygonSpatialObject< TDimension >::InternalClone ( ) const
overrideprotectedvirtual

Actual implementation of the clone method. This method should be reimplemented in subclasses to clone the extra required parameters.

Reimplemented from itk::LightObject.

◆ IsClosedOn()

template<unsigned int TDimension = 3>
virtual void itk::PolygonSpatialObject< TDimension >::IsClosedOn ( )
virtual

◆ IsInsideInObjectSpace()

template<unsigned int TDimension = 3>
bool itk::PolygonSpatialObject< TDimension >::IsInsideInObjectSpace ( const PointType point) const
overridevirtual

Test whether a point is inside or outside the object.

Reimplemented from itk::SpatialObject< TDimension >.

◆ MeasureAreaInObjectSpace()

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::MeasureAreaInObjectSpace ( ) const

Method returns area of polygon described by points

◆ MeasurePerimeterInObjectSpace()

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::MeasurePerimeterInObjectSpace ( ) const

Method returns the length of the perimeter

◆ MeasureVolumeInObjectSpace()

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::MeasureVolumeInObjectSpace ( ) const

Method returns the volume of the strand

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::DataObject.

◆ SetIsClosed()

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

Set if the contour is closed

◆ SetThicknessInObjectSpace()

template<unsigned int TDimension = 3>
virtual void itk::PolygonSpatialObject< TDimension >::SetThicknessInObjectSpace ( double  _arg)
virtual

Method sets the thickness of the current strand

Member Data Documentation

◆ m_IsClosed

template<unsigned int TDimension = 3>
bool itk::PolygonSpatialObject< TDimension >::m_IsClosed {}
mutableprivate

Definition at line 112 of file itkPolygonSpatialObject.h.

◆ m_OrientationInObjectSpace

template<unsigned int TDimension = 3>
int itk::PolygonSpatialObject< TDimension >::m_OrientationInObjectSpace {}
mutableprivate

Definition at line 113 of file itkPolygonSpatialObject.h.

◆ m_OrientationInObjectSpaceMTime

template<unsigned int TDimension = 3>
ModifiedTimeType itk::PolygonSpatialObject< TDimension >::m_OrientationInObjectSpaceMTime {}
mutableprivate

Definition at line 114 of file itkPolygonSpatialObject.h.

◆ m_ThicknessInObjectSpace

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::m_ThicknessInObjectSpace {}
private

Definition at line 115 of file itkPolygonSpatialObject.h.

◆ ObjectDimension

template<unsigned int TDimension = 3>
constexpr ObjectDimensionType itk::PolygonSpatialObject< TDimension >::ObjectDimension = TDimension
staticconstexpr

Definition at line 51 of file itkPolygonSpatialObject.h.


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