Medical Imaging Interaction Toolkit  2021.02.99-89548602 Medical Imaging Interaction Toolkit
mitk::TimeGeometry Class Referenceabstract

#include <mitkTimeGeometry.h>

Inheritance diagram for mitk::TimeGeometry:
Collaboration diagram for mitk::TimeGeometry:

Public Types

typedef TimeGeometry Self

typedef itk::Object Superclass

typedef itk::SmartPointer< SelfPointer

typedef itk::SmartPointer< const SelfConstPointer

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const

virtual const char * GetClassName () const

Pointer Clone () const

itkCreateAnotherMacro (Self)

virtual TimeStepType CountTimeSteps () const =0
Returns the number of time steps. More...

virtual TimePointType GetMinimumTimePoint () const =0
Returns the first time point for which the object is valid. More...

virtual TimePointType GetMaximumTimePoint () const =0
Returns the last time point for which the object is valid. More...

virtual TimePointType GetMinimumTimePoint (TimeStepType step) const =0
Returns the first time point for which the object is valid. More...

virtual TimePointType GetMaximumTimePoint (TimeStepType step) const =0
Returns the last time point for which the object is valid. More...

virtual TimeBounds GetTimeBounds () const =0
Get the time bounds (in ms) More...

virtual TimeBounds GetTimeBounds (TimeStepType step) const =0
Get the time bounds for the given TimeStep (in ms) More...

virtual bool IsValidTimePoint (TimePointType timePoint) const =0
Tests if a given time point is covered by this object. More...

virtual bool IsValidTimeStep (TimeStepType timeStep) const =0
Test for the given time step if a geometry is availible. More...

virtual TimePointType TimeStepToTimePoint (TimeStepType timeStep) const =0
Converts a time step to a time point. More...

virtual TimeStepType TimePointToTimeStep (TimePointType timePoint) const =0
Converts a time point to the corresponding time step. More...

virtual BaseGeometry::Pointer GetGeometryForTimePoint (TimePointType timePoint) const =0
Returns the geometry of a specific time point. More...

virtual BaseGeometry::Pointer GetGeometryForTimeStep (TimeStepType timeStep) const =0
Returns the geometry which corresponds to the given time step. More...

virtual BaseGeometry::Pointer GetGeometryCloneForTimeStep (TimeStepType timeStep) const =0
Returns a clone of the geometry of a specific time point. More...

virtual void SetTimeStepGeometry (BaseGeometry *geometry, TimeStepType timeStep)=0
Sets the geometry for a given time step. More...

virtual void Expand (TimeStepType size)=0
Expands to the given number of time steps. More...

virtual void ReplaceTimeStepGeometries (const BaseGeometry *geometry)=0
Replaces the geometry instances with clones ot the passed geometry. More...

virtual bool IsValid () const =0
Tests if all necessary informations are set and the object is valid. More...

Point3D GetCornerPointInWorld (int id) const
Get the position of the corner number id (in world coordinates) More...

Point3D GetCornerPointInWorld (bool xFront=true, bool yFront=true, bool zFront=true) const
Get the position of a corner (in world coordinates) More...

Point3D GetCenterInWorld () const
Get the center of the bounding-box in mm. More...

double GetDiagonalLength2InWorld () const
Get the squared length of the diagonal of the bounding-box in mm. More...

double GetDiagonalLengthInWorld () const
Get the length of the diagonal of the bounding-box in mm. More...

bool IsWorldPointInside (const mitk::Point3D &p) const
Test whether the point p (world coordinates in mm) is inside the bounding box. More...

void UpdateBoundingBox ()
Updates the bounding box to cover the area used in all time steps. More...

BoundingBoxGetBoundingBoxInWorld () const
Returns a bounding box that covers all time steps. More...

BoundingBox::BoundsArrayType GetBoundsInWorld () const
Returns the world bounds of the object that cover all time steps. More...

ScalarType GetExtentInWorld (unsigned int direction) const
Returns the Extend of the bounding in the given direction. More...

virtual void Initialize ()
Initializes the TimeGeometry. More...

void Update ()

virtual void UpdateWithoutBoundingBox ()
Updates everything except the Bounding box. More...

void ExecuteOperation (Operation *op) override
Executes the given operation on all time steps. More...

void PrintSelf (std::ostream &os, itk::Indent indent) const override

Public Member Functions inherited from mitk::OperationActor
itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()

Static Public Member Functions

static const char * GetStaticNameOfClass ()

Protected Member Functions

TimeGeometry ()

~TimeGeometry () override

LightObject::Pointer InternalClone () const override
Makes a deep copy of the current object. More...

Protected Attributes

BoundingBox::Pointer m_BoundingBox
Contains a bounding box which includes all time steps. More...

Detailed Description

Definition at line 43 of file mitkTimeGeometry.h.

◆ ConstPointer

 typedef itk::SmartPointer mitk::TimeGeometry::ConstPointer

Definition at line 60 of file mitkTimeGeometry.h.

◆ Pointer

Definition at line 60 of file mitkTimeGeometry.h.

◆ Self

 typedef TimeGeometry mitk::TimeGeometry::Self

Definition at line 60 of file mitkTimeGeometry.h.

◆ Superclass

 typedef itk::Object mitk::TimeGeometry::Superclass

Definition at line 60 of file mitkTimeGeometry.h.

◆ TimeGeometry()

 mitk::TimeGeometry::TimeGeometry ( )
protected

◆ ~TimeGeometry()

 mitk::TimeGeometry::~TimeGeometry ( )
overrideprotected

◆ Clone()

 Pointer mitk::TimeGeometry::Clone ( ) const

◆ CountTimeSteps()

 virtual TimeStepType mitk::TimeGeometry::CountTimeSteps ( ) const
pure virtual

Returns the number of time steps.

Returns the number of time steps for which geometries are saved. The number of time steps is also the upper bound of the time steps. The minimum time steps is always 0.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ ExecuteOperation()

 void mitk::TimeGeometry::ExecuteOperation ( Operation * op )
overridevirtual

Executes the given operation on all time steps.

Implements mitk::OperationActor.

◆ Expand()

 virtual void mitk::TimeGeometry::Expand ( TimeStepType size )
pure virtual

Expands to the given number of time steps.

Expands to the given number of time steps. Each new created time step is filled with an empty geometry. Shrinking is not supported!

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetBoundingBoxInWorld()

 BoundingBox* mitk::TimeGeometry::GetBoundingBoxInWorld ( ) const
inline

Returns a bounding box that covers all time steps.

Definition at line 263 of file mitkTimeGeometry.h.

◆ GetBoundsInWorld()

 BoundingBox::BoundsArrayType mitk::TimeGeometry::GetBoundsInWorld ( ) const
inline

Returns the world bounds of the object that cover all time steps.

Definition at line 267 of file mitkTimeGeometry.h.

◆ GetCenterInWorld()

 Point3D mitk::TimeGeometry::GetCenterInWorld ( ) const

Get the center of the bounding-box in mm.

◆ GetClassHierarchy()

 virtual std::vector mitk::TimeGeometry::GetClassHierarchy ( ) const
inlinevirtual

Reimplemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

Definition at line 60 of file mitkTimeGeometry.h.

◆ GetClassName()

 virtual const char* mitk::TimeGeometry::GetClassName ( ) const
virtual

◆ GetCornerPointInWorld() [1/2]

 Point3D mitk::TimeGeometry::GetCornerPointInWorld ( int id ) const

Get the position of the corner number id (in world coordinates)

See SetImageGeometry for how a corner is defined on images.

◆ GetCornerPointInWorld() [2/2]

 Point3D mitk::TimeGeometry::GetCornerPointInWorld ( bool xFront = true, bool yFront = true, bool zFront = true ) const

Get the position of a corner (in world coordinates)

See SetImageGeometry for how a corner is defined on images.

◆ GetDiagonalLength2InWorld()

 double mitk::TimeGeometry::GetDiagonalLength2InWorld ( ) const

Get the squared length of the diagonal of the bounding-box in mm.

◆ GetDiagonalLengthInWorld()

 double mitk::TimeGeometry::GetDiagonalLengthInWorld ( ) const

Get the length of the diagonal of the bounding-box in mm.

◆ GetExtentInWorld()

 ScalarType mitk::TimeGeometry::GetExtentInWorld ( unsigned int direction ) const

Returns the Extend of the bounding in the given direction.

◆ GetGeometryCloneForTimeStep()

 virtual BaseGeometry::Pointer mitk::TimeGeometry::GetGeometryCloneForTimeStep ( TimeStepType timeStep ) const
pure virtual

Returns a clone of the geometry of a specific time point.

If an invalid time step is given (e.g. no geometry is defined for this time step) a null-pointer will be returned.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetGeometryForTimePoint()

 virtual BaseGeometry::Pointer mitk::TimeGeometry::GetGeometryForTimePoint ( TimePointType timePoint ) const
pure virtual

Returns the geometry of a specific time point.

Returns the geometry which defines the given time point. If the given time point is invalid an null-pointer is returned.

The pointer to the returned geometry may point to the saved geometry but this is not necessarily the case. So a change to the returned geometry may or may not afflict the geometry for the time point or all time points depending on the used implementation of TimeGeometry.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetGeometryForTimeStep()

 virtual BaseGeometry::Pointer mitk::TimeGeometry::GetGeometryForTimeStep ( TimeStepType timeStep ) const
pure virtual

Returns the geometry which corresponds to the given time step.

Returns the geometry which defines the given time step. If the given time step is invalid an null-pointer is returned.

The pointer to the returned geometry may point to the saved geometry but this is not necessarily the case. So a change to the returned geometry may or may not afflict the geometry for the time step or all time steps depending on the used implementation of TimeGeometry.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetMaximumTimePoint() [1/2]

 virtual TimePointType mitk::TimeGeometry::GetMaximumTimePoint ( ) const
pure virtual

Returns the last time point for which the object is valid.

Gives the last time point for which a valid geometrie is saved in this time geometry. The time point is given in ms.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetMaximumTimePoint() [2/2]

 virtual TimePointType mitk::TimeGeometry::GetMaximumTimePoint ( TimeStepType step ) const
pure virtual

Returns the last time point for which the object is valid.

Gives the last time point for the Geometry specified by the given TimeStep. The time point is given in ms.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetMinimumTimePoint() [1/2]

 virtual TimePointType mitk::TimeGeometry::GetMinimumTimePoint ( ) const
pure virtual

Returns the first time point for which the object is valid.

Returns the first valid time point for this geometry. If only one time steps available it usually goes from -max to +max. The time point is given in ms.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetMinimumTimePoint() [2/2]

 virtual TimePointType mitk::TimeGeometry::GetMinimumTimePoint ( TimeStepType step ) const
pure virtual

Returns the first time point for which the object is valid.

Returns the first valid time point for the given TimeStep. The time point is given in ms.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetStaticNameOfClass()

 static const char* mitk::TimeGeometry::GetStaticNameOfClass ( )
inlinestatic

Definition at line 60 of file mitkTimeGeometry.h.

◆ GetTimeBounds() [1/2]

 virtual TimeBounds mitk::TimeGeometry::GetTimeBounds ( ) const
pure virtual

Get the time bounds (in ms)

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ GetTimeBounds() [2/2]

 virtual TimeBounds mitk::TimeGeometry::GetTimeBounds ( TimeStepType step ) const
pure virtual

Get the time bounds for the given TimeStep (in ms)

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ Initialize()

 virtual void mitk::TimeGeometry::Initialize ( )
virtual

◆ InternalClone()

 LightObject::Pointer mitk::TimeGeometry::InternalClone ( ) const
overrideprotected

Makes a deep copy of the current object.

◆ IsValid()

 virtual bool mitk::TimeGeometry::IsValid ( ) const
pure virtual

Tests if all necessary informations are set and the object is valid.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ IsValidTimePoint()

 virtual bool mitk::TimeGeometry::IsValidTimePoint ( TimePointType timePoint ) const
pure virtual

Tests if a given time point is covered by this object.

Returns true if a geometry can be returned for the given time point and falls if not. The time point must be given in ms.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ IsValidTimeStep()

 virtual bool mitk::TimeGeometry::IsValidTimeStep ( TimeStepType timeStep ) const
pure virtual

Test for the given time step if a geometry is availible.

Returns true if a geometry is defined for the given time step. Otherwise false is returned. The time step is defined as positiv number.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

Referenced by mitk::GenerateTimeInInputRegion().

◆ IsWorldPointInside()

 bool mitk::TimeGeometry::IsWorldPointInside ( const mitk::Point3D & p ) const

Test whether the point p (world coordinates in mm) is inside the bounding box.

◆ itkCreateAnotherMacro()

 mitk::TimeGeometry::itkCreateAnotherMacro ( Self )

◆ PrintSelf()

 void mitk::TimeGeometry::PrintSelf ( std::ostream & os, itk::Indent indent ) const
override

◆ ReplaceTimeStepGeometries()

 virtual void mitk::TimeGeometry::ReplaceTimeStepGeometries ( const BaseGeometry * geometry )
pure virtual

Replaces the geometry instances with clones ot the passed geometry.

Replaces the geometries of all time steps with clones of the passed geometry. Replacment strategy depends on the implementation of TimeGeometry sub class.

Remarks
The time points itself stays untouched. Use this method if you want to change the spatial properties of a TimeGeometry and preserve the time "grid".

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ SetTimeStepGeometry()

 virtual void mitk::TimeGeometry::SetTimeStepGeometry ( BaseGeometry * geometry, TimeStepType timeStep )
pure virtual

Sets the geometry for a given time step.

Sets the geometry for the given time steps. This may also afflects other time steps, depending on the implementation of TimeGeometry.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

◆ TimePointToTimeStep()

 virtual TimeStepType mitk::TimeGeometry::TimePointToTimeStep ( TimePointType timePoint ) const
pure virtual

Converts a time point to the corresponding time step.

Converts a time point to a time step in a way that the new time step indicates the same geometry as the time point. If a negativ invalid time point is given always time step 0 is returned. If an positiv invalid time step is given an invalid time step will be returned.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

Referenced by mitk::GenerateTimeInInputRegion().

◆ TimeStepToTimePoint()

 virtual TimePointType mitk::TimeGeometry::TimeStepToTimePoint ( TimeStepType timeStep ) const
pure virtual

Converts a time step to a time point.

Converts a time step to a time point in a way that the new time point indicates the same geometry as the time step. If the original time steps does not point to a valid geometry, a time point is calculated that also does not point to a valid geometry, but no exception is raised.

Implemented in mitk::ArbitraryTimeGeometry, and mitk::ProportionalTimeGeometry.

Referenced by mitk::GenerateTimeInInputRegion().

◆ Update()

 void mitk::TimeGeometry::Update ( )

◆ UpdateBoundingBox()

 void mitk::TimeGeometry::UpdateBoundingBox ( )

Updates the bounding box to cover the area used in all time steps.

The bounding box is updated by this method. The new bounding box covers an area which includes all bounding boxes during all times steps.

◆ UpdateWithoutBoundingBox()

 virtual void mitk::TimeGeometry::UpdateWithoutBoundingBox ( )
inlinevirtual

Updates everything except the Bounding box.

This class should be overwritten by child classes. The method is called when Update() is required.

Definition at line 289 of file mitkTimeGeometry.h.

References mitk::eps, mitk::Equal(), and MITKCORE_EXPORT.

◆ m_BoundingBox

 BoundingBox::Pointer mitk::TimeGeometry::m_BoundingBox
protected

Contains a bounding box which includes all time steps.

Definition at line 52 of file mitkTimeGeometry.h.

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