mitkArbitraryTimeGeometry.h

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef ArbitraryTimeGeometry_h
#define ArbitraryTimeGeometry_h

// MITK
#include <MitkCoreExports.h>
#include <mitkCommon.h>
#include <mitkTimeGeometry.h>

namespace mitk
{
  class MITKCORE_EXPORT ArbitraryTimeGeometry : public TimeGeometry
  {
  public:
    mitkClassMacro(ArbitraryTimeGeometry, TimeGeometry);

    ArbitraryTimeGeometry();
    typedef ArbitraryTimeGeometry self;
    itkFactorylessNewMacro(Self) itkCloneMacro(Self)

      virtual TimeStepType CountTimeSteps() const;
    virtual TimePointType GetMinimumTimePoint() const;
    virtual TimePointType GetMaximumTimePoint() const;

    virtual TimePointType GetMinimumTimePoint(TimeStepType step) const;
    virtual TimePointType GetMaximumTimePoint(TimeStepType step) const;

    virtual TimeBounds GetTimeBounds() const;

    virtual TimeBounds GetTimeBounds(TimeStepType step) const;

    virtual bool IsValidTimePoint(TimePointType timePoint) const;
    virtual bool IsValidTimeStep(TimeStepType timeStep) const;
    virtual TimePointType TimeStepToTimePoint(TimeStepType timeStep) const;
    virtual TimeStepType TimePointToTimeStep(TimePointType timePoint) const;
    virtual BaseGeometry::Pointer GetGeometryCloneForTimeStep(TimeStepType timeStep) const;

    virtual BaseGeometry::Pointer GetGeometryForTimePoint(TimePointType timePoint) const;
    virtual BaseGeometry::Pointer GetGeometryForTimeStep(TimeStepType timeStep) const;

    virtual bool IsValid() const;

    virtual void Initialize();

    virtual void Expand(TimeStepType size);

    virtual void ReplaceTimeStepGeometries(const BaseGeometry *geometry);

    virtual void SetTimeStepGeometry(BaseGeometry *geometry, TimeStepType timeStep);

    virtual itk::LightObject::Pointer InternalClone() const;

    void ClearAllGeometries();

    void AppendTimeStep(BaseGeometry *geometry, TimePointType maximumTimePoint, TimePointType minimumTimePoint = 0);

    void AppendTimeStepClone(const BaseGeometry *geometry,
                             TimePointType maximumTimePoint,
                             TimePointType minimumTimePoint = 0);

    void ReserveSpaceForGeometries(TimeStepType numberOfGeometries);

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

  protected:
    virtual ~ArbitraryTimeGeometry();

    std::vector<BaseGeometry::Pointer> m_GeometryVector;
    std::vector<TimePointType> m_MaximumTimePoints;
    TimePointType m_MinimumTimePoint;

  }; // end class ArbitraryTimeGeometry

} // end namespace MITK
#endif // ArbitraryTimeGeometry_h