mitkTimeGeometry.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 TimeGeometry_h
#define TimeGeometry_h

// ITK
#include <itkObject.h>
// MITK
#include "mitkOperationActor.h"
#include <MitkCoreExports.h>
#include <mitkBaseGeometry.h>
#include <mitkCommon.h>

namespace mitk
{
  typedef mitk::ScalarType TimePointType;
  typedef std::size_t TimeStepType;

  class MITKCORE_EXPORT TimeGeometry : public itk::Object, public OperationActor
  {
  protected:
    TimeGeometry();
    ~TimeGeometry() override;

    BoundingBox::Pointer m_BoundingBox;

    LightObject::Pointer InternalClone() const override;

  public:
    mitkClassMacroItkParent(TimeGeometry, itk::Object);
    itkCloneMacro(Self);
    itkCreateAnotherMacro(Self);

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

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

    virtual TimeBounds GetTimeBounds() const = 0;

    virtual TimeBounds GetTimeBounds(TimeStepType step) const = 0;
    virtual bool IsValidTimePoint(TimePointType timePoint) const = 0;
    virtual bool IsValidTimeStep(TimeStepType timeStep) const = 0;

    virtual TimePointType TimeStepToTimePoint(TimeStepType timeStep) const = 0;
    virtual TimeStepType TimePointToTimeStep(TimePointType timePoint) const = 0;

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

    virtual BaseGeometry::Pointer GetGeometryCloneForTimeStep(TimeStepType timeStep) const = 0;

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

    virtual void Expand(TimeStepType size) = 0;

    virtual void ReplaceTimeStepGeometries(const BaseGeometry *geometry) = 0;

    virtual bool IsValid() const = 0;
    Point3D GetCornerPointInWorld(int id) const;

    Point3D GetCornerPointInWorld(bool xFront = true, bool yFront = true, bool zFront = true) const;

    Point3D GetCenterInWorld() const;

    double GetDiagonalLength2InWorld() const;

    double GetDiagonalLengthInWorld() const;

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

    void UpdateBoundingBox();

    BoundingBox *GetBoundingBoxInWorld() const { return m_BoundingBox; }
    BoundingBox::BoundsArrayType GetBoundsInWorld() const { return m_BoundingBox->GetBounds(); }
    ScalarType GetExtentInWorld(unsigned int direction) const;

    virtual void Initialize();

    void Update();

    virtual void UpdateWithoutBoundingBox(){};

    void ExecuteOperation(Operation *op) override;

    void PrintSelf(std::ostream &os, itk::Indent indent) const override;
  }; // end class TimeGeometry

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

  MITKCORE_EXPORT bool Equal(const mitk::TimeGeometry& leftHandSide,
    const mitk::TimeGeometry& rightHandSide,
    ScalarType coordinateEps,
    ScalarType directionEps,
    bool verbose);

} // end namespace MITK
#endif // TimeGeometry_h