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

#include <itkArrowSpatialObject.h>

Detailed Description

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

Representation of a Arrow based on the spatial object classes.

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

Definition at line 37 of file itkArrowSpatialObject.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using MatrixType = typename TransformType::MatrixType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< double, TDimension >
 
using ScalarType = double
 
using Self = ArrowSpatialObject
 
using Superclass = SpatialObject< TDimension >
 
using VectorType = Vector< double, TDimension >
 
- Public Types inherited from itk::SpatialObject< 3 >
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 VectorType GetDirectionInObjectSpace () const
 
VectorType GetDirectionInWorldSpace () const
 
virtual const double & GetLengthInObjectSpace () const
 
double GetLengthInWorldSpace () const
 
const char * GetNameOfClass () const override
 
virtual PointType GetPositionInObjectSpace () const
 
PointType GetPositionInWorldSpace () const
 
bool IsInsideInObjectSpace (const PointType &point) const override
 
virtual void SetDirectionInObjectSpace (VectorType _arg)
 
virtual void SetLengthInObjectSpace (double _arg)
 
virtual void SetPositionInObjectSpace (PointType _arg)
 
- Public Member Functions inherited from itk::SpatialObject< 3 >
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 void Clear ()
 
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 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
 
virtual bool IsInsideInObjectSpace (const PointType &point) 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 CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
const char * GetNameOfClass () const override
 
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 bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
void UpdateSource () const
 
virtual bool VerifyRequestedRegion ()
 
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 *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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
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) 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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::SpatialObject< 3 >
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 ()
 

Protected Member Functions

 ArrowSpatialObject ()
 
void ComputeMyBoundingBox () override
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ArrowSpatialObject () override=default
 
- Protected Member Functions inherited from itk::SpatialObject< 3 >
virtual void ComputeMyBoundingBox ()
 
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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

VectorType m_DirectionInObjectSpace {}
 
double m_LengthInObjectSpace {}
 
PointType m_PositionInObjectSpace {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialObject< 3 >
static constexpr unsigned int MaximumDepth
 
static constexpr ObjectDimensionType ObjectDimension
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 45 of file itkArrowSpatialObject.h.

◆ MatrixType

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

Definition at line 50 of file itkArrowSpatialObject.h.

◆ Pointer

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

Definition at line 44 of file itkArrowSpatialObject.h.

◆ PointType

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

Definition at line 48 of file itkArrowSpatialObject.h.

◆ ScalarType

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

Definition at line 46 of file itkArrowSpatialObject.h.

◆ Self

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

Definition at line 42 of file itkArrowSpatialObject.h.

◆ Superclass

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

Definition at line 43 of file itkArrowSpatialObject.h.

◆ VectorType

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

Definition at line 47 of file itkArrowSpatialObject.h.

Constructor & Destructor Documentation

◆ ArrowSpatialObject()

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

◆ ~ArrowSpatialObject()

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

Member Function Documentation

◆ Clear()

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

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

Reimplemented from itk::SpatialObject< 3 >.

◆ ComputeMyBoundingBox()

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

Compute the Object bounding box.

Reimplemented from itk::SpatialObject< 3 >.

◆ GetDirectionInObjectSpace()

template<unsigned int TDimension = 3>
virtual VectorType itk::ArrowSpatialObject< TDimension >::GetDirectionInObjectSpace ( ) const
virtual

Get the direction of the arrow : this is the direction from the point

◆ GetDirectionInWorldSpace()

template<unsigned int TDimension = 3>
VectorType itk::ArrowSpatialObject< TDimension >::GetDirectionInWorldSpace ( ) const

◆ GetLengthInObjectSpace()

template<unsigned int TDimension = 3>
virtual const double & itk::ArrowSpatialObject< TDimension >::GetLengthInObjectSpace ( ) const
virtual

Get the length of the arrow

◆ GetLengthInWorldSpace()

template<unsigned int TDimension = 3>
double itk::ArrowSpatialObject< TDimension >::GetLengthInWorldSpace ( ) const

◆ GetNameOfClass()

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

Reimplemented from itk::DataObject.

◆ GetPositionInObjectSpace()

template<unsigned int TDimension = 3>
virtual PointType itk::ArrowSpatialObject< TDimension >::GetPositionInObjectSpace ( ) const
virtual

Get the position of the arrow : this is the point of the arrow

◆ GetPositionInWorldSpace()

template<unsigned int TDimension = 3>
PointType itk::ArrowSpatialObject< TDimension >::GetPositionInWorldSpace ( ) const

◆ InternalClone()

template<unsigned int TDimension = 3>
LightObject::Pointer itk::ArrowSpatialObject< 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::ArrowSpatialObject< TDimension >::IsInsideInObjectSpace ( const PointType point) const
override

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

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetDirectionInObjectSpace()

template<unsigned int TDimension = 3>
virtual void itk::ArrowSpatialObject< TDimension >::SetDirectionInObjectSpace ( VectorType  _arg)
virtual

Set the direction of the arrow : this is the direction from the point

◆ SetLengthInObjectSpace()

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

Set the length of the arrow

◆ SetPositionInObjectSpace()

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

Set the position of the arrow : this is the point of the arrow

Member Data Documentation

◆ m_DirectionInObjectSpace

template<unsigned int TDimension = 3>
VectorType itk::ArrowSpatialObject< TDimension >::m_DirectionInObjectSpace {}
private

Definition at line 110 of file itkArrowSpatialObject.h.

◆ m_LengthInObjectSpace

template<unsigned int TDimension = 3>
double itk::ArrowSpatialObject< TDimension >::m_LengthInObjectSpace {}
private

Definition at line 112 of file itkArrowSpatialObject.h.

◆ m_PositionInObjectSpace

template<unsigned int TDimension = 3>
PointType itk::ArrowSpatialObject< TDimension >::m_PositionInObjectSpace {}
private

Definition at line 111 of file itkArrowSpatialObject.h.


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