ITK  5.2.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>

+ 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 TransformType = typename Superclass::TransformType
 
using VectorType = Vector< double, TDimension >
 
- Public Types inherited from itk::SpatialObject< TDimension >
using BoundingBoxPointer = typename BoundingBoxType::Pointer
 
using BoundingBoxType = BoundingBox< IdentifierType, VDimension, ScalarType, VectorContainerType >
 
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 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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual VectorType GetDirectionInObjectSpace () const
 
VectorType GetDirectionInWorldSpace () const
 
virtual const double & GetLengthInObjectSpace () const
 
double GetLengthInWorldSpace () const
 
virtual const char * GetNameOfClass () const
 
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< TDimension >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
unsigned int GetMaximumDepth () const
 
unsigned int GetObjectDimension () const
 
void SetId (int id)
 
virtual const int & GetId () const
 
virtual void SetTypeName (std::string _arg)
 
virtual const std::string GetTypeName () const
 
virtual std::string GetClassNameAndDimension () const
 
void SetProperty (const PropertyType &property)
 
const PropertyTypeGetProperty () const
 
PropertyTypeGetProperty ()
 
ModifiedTimeType GetMTime () const override
 
ModifiedTimeType GetMyMTime () const
 
void SetObjectToWorldTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToWorldTransform ()
 
virtual const TransformTypeGetObjectToWorldTransform () const
 
const TransformTypeGetObjectToWorldTransformInverse () const
 
void SetObjectToParentTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToParentTransform ()
 
virtual const TransformTypeGetObjectToParentTransform () const
 
const TransformTypeGetObjectToParentTransformInverse () const
 
void ComputeObjectToParentTransform ()
 
bool IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const
 
virtual bool IsInsideInObjectSpace (const PointType &point) const
 
void Update () override
 
virtual bool ValueAtInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInObjectSpace (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 ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual void SetDefaultInsideValue (double _arg)
 
virtual double GetDefaultInsideValue () const
 
virtual void SetDefaultOutsideValue (double _arg)
 
virtual double GetDefaultOutsideValue () const
 
virtual bool ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsInsideInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual void DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=1)
 
virtual void DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=1)
 
void SetParent (Self *parent)
 
virtual bool HasParent () const
 
virtual const SelfGetParent () const
 
virtual SelfGetParent ()
 
virtual void SetParentId (int _arg)
 
virtual const int & GetParentId () const
 
void SetChildren (ChildrenListType &children)
 
void AddChild (Self *pointer)
 
bool RemoveChild (Self *pointer)
 
void RemoveAllChildren (unsigned int depth=MaximumDepth)
 
virtual ChildrenListTypeGetChildren (unsigned int depth=0, const std::string &name="") const
 
virtual void AddChildrenToList (ChildrenListType *childrenList, unsigned int depth=0, const std::string &name="") const
 
unsigned int GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const
 
SpatialObject< VDimension > * GetObjectById (int id)
 
bool FixParentChildHierarchyUsingParentIds ()
 
bool CheckIdValidity () const
 
void FixIdValidity ()
 
int GetNextAvailableId () const
 
virtual const BoundingBoxTypeGetMyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetMyBoundingBoxInWorldSpace () const
 
virtual bool ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInWorldSpace () const
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual const RegionTypeGetRequestedRegion () const
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void UpdateOutputInformation () override
 
void CopyInformation (const DataObject *data) override
 
bool Evaluate (const PointType &point) const
 
- Public Member Functions inherited from itk::DataObject
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual void Initialize ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void UpdateOutputData ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual void PrepareForNewData ()
 
virtual void DataHasBeenGenerated ()
 
virtual void Graft (const DataObject *)
 
- 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
 
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::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 ()
 

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

VectorType m_DirectionInObjectSpace
 
double m_LengthInObjectSpace
 
PointType m_PositionInObjectSpace
 

Additional Inherited Members

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

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.

Examples
Examples/SpatialObjects/ArrowSpatialObject.cxx.

Definition at line 37 of file itkArrowSpatialObject.h.

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.

◆ TransformType

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

Definition at line 49 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< TDimension >.

◆ ComputeMyBoundingBox()

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

Compute the Object bounding box

Reimplemented from itk::SpatialObject< TDimension >.

◆ CreateAnother()

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

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ 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>
virtual const char* itk::ArrowSpatialObject< TDimension >::GetNameOfClass ( ) const
virtual

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

◆ 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

Method to print the object.

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 111 of file itkArrowSpatialObject.h.

◆ m_LengthInObjectSpace

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

Definition at line 113 of file itkArrowSpatialObject.h.

◆ m_PositionInObjectSpace

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

Definition at line 112 of file itkArrowSpatialObject.h.


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