ITK  6.0.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::EllipseSpatialObject< TDimension > Class Template Reference
Group Core » Module ITKSpatialObjects

#include <itkEllipseSpatialObject.h>

Detailed Description

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

ITK Sphinx Examples:
Examples
Examples/Filtering/SpatialObjectToImage1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, Examples/SpatialObjects/EllipseSpatialObject.cxx, Examples/SpatialObjects/GroupSpatialObject.cxx, Examples/SpatialObjects/ReadWriteSpatialObject.cxx, Examples/SpatialObjects/SceneSpatialObject.cxx, Examples/SpatialObjects/SpatialObjectToImageStatisticsCalculator.cxx, SphinxExamples/src/Core/SpatialObjects/ConvertSpatialObjectToImage/Code.cxx, SphinxExamples/src/Core/SpatialObjects/Ellipse/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesAffine/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesBSpline/Code.cxx, and SphinxExamples/src/Registration/Common/GlobalRegistrationOfTwoImages/Code.cxx.

Definition at line 38 of file itkEllipseSpatialObject.h.

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

Public Types

using ArrayType = FixedArray< double, TDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using PointContainerPointer = SmartPointer< PointContainerType >
 
using PointContainerType = VectorContainer< PointType >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = double
 
using Self = EllipseSpatialObject
 
using Superclass = SpatialObject< TDimension >
 
using SuperclassPointer = SmartPointer< Superclass >
 
- 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< 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 const PointType & GetCenterInObjectSpace () const
 
const char * GetNameOfClass () const override
 
virtual const ArrayType & GetRadiusInObjectSpace () const
 
bool IsInsideInObjectSpace (const PointType &point) const override
 
virtual void SetCenterInObjectSpace (PointType _arg)
 
virtual void SetRadiusInObjectSpace (ArrayType _arg)
 
void SetRadiusInObjectSpace (double radius)
 
- 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 RegionType & GetBufferedRegion () const
 
virtual ChildrenListType * GetChildren (unsigned int depth=0, const std::string &name="") const
 
virtual std::string GetClassNameAndDimension () const
 
virtual ChildrenConstListType * GetConstChildren (unsigned int depth=0, const std::string &name="") const
 
virtual const BoundingBoxType * GetFamilyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxType * GetFamilyBoundingBoxInWorldSpace () const
 
virtual const RegionType & GetLargestPossibleRegion () const
 
unsigned int GetMaximumDepth () const
 
ModifiedTimeType GetMTime () const override
 
virtual const BoundingBoxType * GetMyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxType * GetMyBoundingBoxInWorldSpace () 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 Self * GetParent ()
 
virtual const Self * GetParent () const
 
PropertyType & GetProperty ()
 
const PropertyType & GetProperty () const
 
virtual const RegionType & GetRequestedRegion () const
 
virtual 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 TransformType * GetModifiableObjectToWorldTransform ()
 
const TransformType * GetObjectToWorldTransformInverse () const
 
void SetObjectToParentTransform (const TransformType *transform)
 
virtual TransformType * GetModifiableObjectToParentTransform ()
 
const TransformType * GetObjectToParentTransformInverse () 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< ProcessObject > GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierType & GetSourceOutputName () 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 ModifiedTimeType & GetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStamp & GetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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::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 unsigned int ObjectDimension = TDimension
 
- Static Public Attributes inherited from itk::SpatialObject< TDimension >
static constexpr unsigned int MaximumDepth
 
static constexpr ObjectDimensionType ObjectDimension
 

Protected Member Functions

void ComputeMyBoundingBox () override
 
 EllipseSpatialObject ()
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~EllipseSpatialObject () override=default
 
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
BoundingBoxType * GetModifiableMyBoundingBoxInObjectSpace ()
 
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

PointType m_CenterInObjectSpace {}
 
ArrayType m_RadiusInObjectSpace {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ArrayType

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

Definition at line 55 of file itkEllipseSpatialObject.h.

◆ ConstPointer

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

Definition at line 46 of file itkEllipseSpatialObject.h.

◆ PointContainerPointer

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

Definition at line 53 of file itkEllipseSpatialObject.h.

◆ PointContainerType

template<unsigned int TDimension = 3>
using itk::EllipseSpatialObject< TDimension >::PointContainerType = VectorContainer<PointType>

Definition at line 52 of file itkEllipseSpatialObject.h.

◆ Pointer

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

Definition at line 45 of file itkEllipseSpatialObject.h.

◆ ScalarType

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

Definition at line 44 of file itkEllipseSpatialObject.h.

◆ Self

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

Definition at line 43 of file itkEllipseSpatialObject.h.

◆ Superclass

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

Definition at line 47 of file itkEllipseSpatialObject.h.

◆ SuperclassPointer

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

Definition at line 48 of file itkEllipseSpatialObject.h.

Constructor & Destructor Documentation

◆ EllipseSpatialObject()

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

◆ ~EllipseSpatialObject()

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

Member Function Documentation

◆ Clear()

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

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

Reimplemented from itk::SpatialObject< TDimension >.

◆ ComputeMyBoundingBox()

template<unsigned int TDimension = 3>
void itk::EllipseSpatialObject< TDimension >::ComputeMyBoundingBox ( )
overrideprotectedvirtual

Get the boundaries of a specific object. This function needs to be called every time one of the object's components is changed.

Reimplemented from itk::SpatialObject< TDimension >.

◆ GetCenterInObjectSpace()

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

Get center in object space

◆ GetNameOfClass()

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

Reimplemented from itk::DataObject.

◆ GetRadiusInObjectSpace()

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

Get radii via an array of radius values

◆ InternalClone()

template<unsigned int TDimension = 3>
LightObject::Pointer itk::EllipseSpatialObject< 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.

◆ IsInsideInObjectSpace()

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

Test whether a point is inside the object.

For computational speed purposes, it is faster if the method does not check the name of the class and the current depth.

Reimplemented from itk::SpatialObject< TDimension >.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetCenterInObjectSpace()

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

Set center point in object space.

◆ SetRadiusInObjectSpace() [1/2]

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

Set radii via an array of radius values

◆ SetRadiusInObjectSpace() [2/2]

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

Set all radii to the same radius value

Each radius is half the length of one axis of the ellipse.

The ellipse is formed by setting the ObjectToParentTransform.

Member Data Documentation

◆ m_CenterInObjectSpace

template<unsigned int TDimension = 3>
PointType itk::EllipseSpatialObject< TDimension >::m_CenterInObjectSpace {}
private

Definition at line 142 of file itkEllipseSpatialObject.h.

◆ m_RadiusInObjectSpace

template<unsigned int TDimension = 3>
ArrayType itk::EllipseSpatialObject< TDimension >::m_RadiusInObjectSpace {}
private

Definition at line 141 of file itkEllipseSpatialObject.h.

◆ ObjectDimension

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

Definition at line 57 of file itkEllipseSpatialObject.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16