#include <mitkTimeGeometry.h>

Inheritance diagram for mitk::TimeGeometry:

[legend]

Collaboration diagram for mitk::TimeGeometry:

Public Member Functions
	mitkClassMacroItkParent (TimeGeometry, itk::Object)

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 available. 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 information 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 ()
	Recompute the bounding box to cover all time steps. More...

BoundingBox *	GetBoundingBoxInWorld () const
	Get the bounding box that covers all time steps. More...

BoundingBox::BoundsArrayType	GetBoundsInWorld () const
	Get the bounds array of the aggregate bounding box. More...

ScalarType	GetExtentInWorld (unsigned int direction) const
	Get the extent of the aggregate bounding box in the given direction. More...

virtual void	Initialize ()
	Initialize the TimeGeometry to its default state. More...

void	Update ()
	Update the geometry (bounding box and subclass-specific data). More...

virtual void	UpdateWithoutBoundingBox ()
	Hook for subclass-specific updates that do not involve the bounding box. More...

void	ExecuteOperation (Operation *op) override
	Execute 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()

Protected Member Functions
	TimeGeometry ()

	TimeGeometry (const TimeGeometry &other)

	~TimeGeometry () override

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

Detailed Description

Definition at line 54 of file mitkTimeGeometry.h.

Constructor & Destructor Documentation

◆ TimeGeometry() [1/2]

mitk::TimeGeometry::TimeGeometry ( )

protected

◆ TimeGeometry() [2/2]

mitk::TimeGeometry::TimeGeometry ( const TimeGeometry & other )

protected

◆ ~TimeGeometry()

mitk::TimeGeometry::~TimeGeometry ( )

overrideprotected

Member Function Documentation

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ ExecuteOperation()

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

overridevirtual

Execute the given operation on all time steps.

Iterates over every time step and calls ExecuteOperation() on each step's geometry.

Parameters

[in] op The operation to execute.

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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ GetBoundingBoxInWorld()

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

inline

Get the bounding box that covers all time steps.

Returns: Pointer to the aggregate bounding box (world coordinates, mm).

Definition at line 272 of file mitkTimeGeometry.h.

◆ GetBoundsInWorld()

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

inline

Get the bounds array of the aggregate bounding box.

Returns: BoundsArrayType [xmin,xmax,ymin,ymax,zmin,zmax] in world coordinates.

Definition at line 279 of file mitkTimeGeometry.h.

◆ GetCenterInWorld()

Point3D mitk::TimeGeometry::GetCenterInWorld ( ) const

Get the center of the bounding-box in mm.

◆ GetCornerPointInWorld() [1/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.

◆ GetCornerPointInWorld() [2/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.

◆ 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

Get the extent of the aggregate bounding box in the given direction.

Parameters

[in] direction The axis (0=x, 1=y, 2=z).

Returns: Extent in mm.

Precondition: direction must be < 3.

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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 geometry is saved in this time geometry. The time point is given in ms.

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

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ GetTimeBounds() [1/2]

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

pure virtual

Get the time bounds (in ms)

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

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ Initialize()

virtual void mitk::TimeGeometry::Initialize ( )

virtual

Initialize the TimeGeometry to its default state.

The default implementation is empty; subclasses should override to set up initial time steps and geometries.

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

◆ IsValid()

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

pure virtual

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

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

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ IsValidTimeStep()

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

pure virtual

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

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

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

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 )

◆ mitkClassMacroItkParent()

mitk::TimeGeometry::mitkClassMacroItkParent	(	TimeGeometry	,
		itk::Object
	)

◆ 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. Replacement 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

◆ 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 negative invalid time point is given always time step 0 is returned. If an positive invalid time step is given an invalid time step will be returned.

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

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::ProportionalTimeGeometry, and mitk::ArbitraryTimeGeometry.

Referenced by mitk::GenerateTimeInInputRegion().

◆ Update()

void mitk::TimeGeometry::Update ( )

Update the geometry (bounding box and subclass-specific data).

Calls UpdateBoundingBox() followed by UpdateWithoutBoundingBox().

◆ UpdateBoundingBox()

void mitk::TimeGeometry::UpdateBoundingBox ( )

Recompute the bounding box to cover all time steps.

Iterates over all time steps, collects the eight corner points of each step's geometry, and computes an axis-aligned bounding box that encloses all of them.

◆ UpdateWithoutBoundingBox()

virtual void mitk::TimeGeometry::UpdateWithoutBoundingBox ( )

inlinevirtual

Hook for subclass-specific updates that do not involve the bounding box.

Called by Update() after UpdateBoundingBox(). Subclasses should override this to perform any additional update logic.

Definition at line 311 of file mitkTimeGeometry.h.

Member Data Documentation

◆ m_BoundingBox

BoundingBox::Pointer mitk::TimeGeometry::m_BoundingBox

protected

Contains a bounding box which includes all time steps.

Definition at line 64 of file mitkTimeGeometry.h.

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

mitkTimeGeometry.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeGeometry() [1/2]

◆ TimeGeometry() [2/2]

◆ ~TimeGeometry()

Member Function Documentation

◆ Clone()

◆ CountTimeSteps()

◆ ExecuteOperation()

◆ Expand()

◆ GetBoundingBoxInWorld()

◆ GetBoundsInWorld()

◆ GetCenterInWorld()

◆ GetCornerPointInWorld() [1/2]

◆ GetCornerPointInWorld() [2/2]

◆ GetDiagonalLength2InWorld()

◆ GetDiagonalLengthInWorld()

◆ GetExtentInWorld()

◆ GetGeometryCloneForTimeStep()

◆ GetGeometryForTimePoint()

◆ GetGeometryForTimeStep()

◆ GetMaximumTimePoint() [1/2]

◆ GetMaximumTimePoint() [2/2]

◆ GetMinimumTimePoint() [1/2]

◆ GetMinimumTimePoint() [2/2]

◆ GetTimeBounds() [1/2]

◆ GetTimeBounds() [2/2]

◆ Initialize()

◆ IsValid()

◆ IsValidTimePoint()

◆ IsValidTimeStep()

◆ IsWorldPointInside()

◆ itkCreateAnotherMacro()

◆ mitkClassMacroItkParent()

◆ PrintSelf()

◆ ReplaceTimeStepGeometries()

◆ SetTimeStepGeometry()

◆ TimePointToTimeStep()

◆ TimeStepToTimePoint()

◆ Update()

◆ UpdateBoundingBox()

◆ UpdateWithoutBoundingBox()

Member Data Documentation

◆ m_BoundingBox