mitkProportionalTimeGeometry.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 ProportionalTimeGeometry_h
#define ProportionalTimeGeometry_h

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

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

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

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

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

    virtual TimeBounds GetTimeBounds() const override;

    virtual TimeBounds GetTimeBounds(TimeStepType step) const override;

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

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

    virtual bool IsValid() const override;

    virtual void Initialize() override;

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

    virtual void ReplaceTimeStepGeometries(const BaseGeometry *geometry) override;

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

    itkGetConstMacro(FirstTimePoint, TimePointType);
    itkSetMacro(FirstTimePoint, TimePointType);
    itkGetConstMacro(StepDuration, TimePointType);
    itkSetMacro(StepDuration, TimePointType);

    //    void SetGeometryForTimeStep(TimeStepType timeStep, BaseGeometry& geometry);
    void ClearAllGeometries();
    //    void AddGeometry(BaseGeometry geometry);
    void ReserveSpaceForGeometries(TimeStepType numberOfGeometries);

    void Initialize(const BaseGeometry *geometry, TimeStepType timeSteps);
    void Initialize(TimeStepType timeSteps);

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

  protected:
    virtual ~ProportionalTimeGeometry();

    std::vector<BaseGeometry::Pointer> m_GeometryVector;
    TimePointType m_FirstTimePoint;
    TimePointType m_StepDuration;
  }; // end class ProportialTimeGeometry

  MITKCORE_EXPORT bool Equal(const mitk::ProportionalTimeGeometry &leftHandSide,
                             const mitk::ProportionalTimeGeometry &rightHandSide,
                             ScalarType eps,
                             bool verbose);

} // end namespace MITK
#endif // ProportionalTimeGeometry_h