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

#include <itkBoxSpatialObject.h>

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

Detailed Description

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

The class may be used to represent N-dimensional boxes. In two dimensions it is a rectangle, In three dimensions it is a cuboid...

Examples:
Examples/RegistrationITKv3/ModelToImageRegistration2.cxx, and Examples/RegistrationITKv4/ModelToImageRegistration2.cxx.

Definition at line 36 of file itkBoxSpatialObject.h.

Public Types

using BoundingBoxType = typename Superclass::BoundingBoxType
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using PointsContainerType = typename BoundingBoxType::PointsContainer
 
using PointType = typename Superclass::PointType
 
using ScalarType = double
 
using Self = BoxSpatialObject
 
using SizeType = FixedArray< double, TDimension >
 
using Superclass = SpatialObject< TDimension >
 
using SuperclassPointer = SmartPointer< Superclass >
 
using TransformType = typename Superclass::TransformType
 
- 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

bool ComputeMyBoundingBox () const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual const PointTypeGetPositionInObjectSpace () const
 
virtual const SizeTypeGetSizeInObjectSpace () const
 
bool IsInsideInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const override
 
virtual void SetPositionInObjectSpace (PointType _arg)
 
virtual void SetSizeInObjectSpace (SizeType _arg)
 
- Public Member Functions inherited from itk::SpatialObject< TDimension >
void AddChild (Self *pointer)
 
virtual void AddChildrenToList (ChildrenListType *children, 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 ComputeObjectToWorldTransform ()
 
void CopyInformation (const DataObject *data) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &spacing=1)
 
virtual void DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &spacing=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 (void) 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
 
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 const SelfGetParent () const
 
virtual SelfGetParent ()
 
const PropertyTypeGetProperty () const
 
PropertyTypeGetProperty ()
 
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
 
virtual 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, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsInsideInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
void RemoveAllChildren (unsigned int depth=MaximumDepth)
 
bool RemoveChild (Self *object)
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetBufferedRegion (const RegionType &region)
 
void SetChildren (ChildrenListType &children)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
void SetParent (Self *parent)
 
void SetProperty (const PropertyType &property)
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegion (const DataObject *data) override
 
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
 
virtual 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 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
 
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 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 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
 
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 noexceptoverride
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 BoxSpatialObject ()
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BoxSpatialObject () override=default
 
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
BoundingBoxTypeGetModifiableMyBoundingBoxInObjectSpace () const
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialObject ()
 
 ~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 &time)
 
 ~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_PositionInObjectSpace
 
SizeType m_SizeInObjectSpace
 

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
 

Member Typedef Documentation

template<unsigned int TDimension = 3>
using itk::BoxSpatialObject< TDimension >::BoundingBoxType = typename Superclass::BoundingBoxType

Definition at line 50 of file itkBoxSpatialObject.h.

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

Definition at line 45 of file itkBoxSpatialObject.h.

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

Definition at line 44 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3>
using itk::BoxSpatialObject< TDimension >::PointsContainerType = typename BoundingBoxType::PointsContainer

Definition at line 52 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3>
using itk::BoxSpatialObject< TDimension >::PointType = typename Superclass::PointType

Definition at line 48 of file itkBoxSpatialObject.h.

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

Definition at line 43 of file itkBoxSpatialObject.h.

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

Definition at line 42 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3>
using itk::BoxSpatialObject< TDimension >::SizeType = FixedArray< double, TDimension >

Definition at line 51 of file itkBoxSpatialObject.h.

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

Definition at line 46 of file itkBoxSpatialObject.h.

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

Definition at line 47 of file itkBoxSpatialObject.h.

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

Definition at line 49 of file itkBoxSpatialObject.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<unsigned int TDimension = 3>
bool itk::BoxSpatialObject< TDimension >::ComputeMyBoundingBox ( ) const
overridevirtual

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

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

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

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< TDimension >.

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

Get the position of the box spatial object in object space.

template<unsigned int TDimension = 3>
virtual const SizeType& itk::BoxSpatialObject< TDimension >::GetSizeInObjectSpace ( ) const
virtual

Get the size of the box spatial object in object space.

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

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

Reimplemented from itk::LightObject.

template<unsigned int TDimension = 3>
bool itk::BoxSpatialObject< TDimension >::IsInsideInObjectSpace ( const PointType point,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
override

Test whether a point is inside or outside the object

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

Print the object informations in a stream.

Reimplemented from itk::DataObject.

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

Set the position of the box spatial object in object space.

template<unsigned int TDimension = 3>
virtual void itk::BoxSpatialObject< TDimension >::SetSizeInObjectSpace ( SizeType  _arg)
virtual

Set the size of the box spatial object in object space.

Member Data Documentation

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

Definition at line 90 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3>
SizeType itk::BoxSpatialObject< TDimension >::m_SizeInObjectSpace
private

object space

Definition at line 89 of file itkBoxSpatialObject.h.


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