mitkProportionalTimeGeometry.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#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);

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

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

    TimeBounds GetTimeBounds() const override;

    TimeBounds GetTimeBounds(TimeStepType step) const override;

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

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

    bool IsValid() const override;

    void Initialize() override;

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

    void ReplaceTimeStepGeometries(const BaseGeometry *geometry) override;

    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);

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

  protected:
    ~ProportionalTimeGeometry() override;

    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