mitkBaseData.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 mitkBaseData_h
#define mitkBaseData_h
 
#include <itkDataObject.h>
 
#include <mitkBaseDataSource.h>
#include <mitkIdentifiable.h>
#include <mitkIPropertyOwner.h>
#include <mitkOperationActor.h>
#include <mitkPropertyList.h>
#include <mitkTimeGeometry.h>
#include <MitkCoreExports.h>
 
namespace mitk
{
  // class BaseProcess;
 
  class MITKCORE_EXPORT BaseData
    : public itk::DataObject, public OperationActor, public Identifiable, public IPropertyOwner
  {
  public:
    mitkClassMacroItkParent(BaseData, itk::DataObject);
 
    // IPropertyProvider
 
    BaseProperty::ConstPointer GetConstProperty(const std::string &propertyKey, const std::string &contextName = "", bool fallBackOnDefaultContext = true) const override;
 
    std::vector<std::string> GetPropertyKeys(const std::string &contextName = "", bool includeDefaultContext = false) const override;
 
    std::vector<std::string> GetPropertyContextNames() const override;
 
    // IPropertyOwner
 
    BaseProperty * GetNonConstProperty(const std::string &propertyKey, const std::string &contextName = "", bool fallBackOnDefaultContext = true) override;
 
    void SetProperty(const std::string &propertyKey, BaseProperty *property, const std::string &contextName = "", bool fallBackOnDefaultContext = false) override;
 
    void RemoveProperty(const std::string &propertyKey, const std::string &contextName = "", bool fallBackOnDefaultContext = false) override;
 
    const mitk::TimeGeometry *GetTimeGeometry() const
    {
      return m_TimeGeometry.GetPointer();
    }
 
    mitk::TimeGeometry *GetTimeGeometry() { return m_TimeGeometry.GetPointer(); }
 
    const mitk::TimeGeometry *GetUpdatedTimeGeometry();
 
    virtual void Expand(unsigned int timeSteps);
 
    const mitk::BaseGeometry *GetUpdatedGeometry(int t = 0);
 
    mitk::BaseGeometry *GetGeometry(int t = 0) const
    {
      if (m_TimeGeometry.IsNull())
        return nullptr;
      return m_TimeGeometry->GetGeometryForTimeStep(t);
    }
 
    void UpdateOutputInformation() override;
 
    void SetRequestedRegionToLargestPossibleRegion() override = 0;
 
    bool RequestedRegionIsOutsideOfTheBufferedRegion() override = 0;
 
    bool VerifyRequestedRegion() override = 0;
 
    void CopyInformation(const itk::DataObject *data) override;
 
    virtual bool IsInitialized() const;
 
    virtual void Clear();
 
    virtual bool IsEmptyTimeStep(unsigned int t) const;
 
    virtual bool IsEmpty() const;
 
    void SetRequestedRegion(const itk::DataObject *data) override = 0;
 
    void ExecuteOperation(Operation *operation) override;
 
    virtual void SetGeometry(BaseGeometry *aGeometry3D);
 
    virtual void SetTimeGeometry(TimeGeometry *geometry);
 
    virtual void SetClonedGeometry(const BaseGeometry *aGeometry3D);
 
    virtual void SetClonedTimeGeometry(const TimeGeometry *geometry);
 
    virtual void SetClonedGeometry(const BaseGeometry *aGeometry3D, unsigned int time);
 
    mitk::PropertyList::Pointer GetPropertyList() const;
 
    void SetPropertyList(PropertyList *propertyList);
 
    mitk::BaseProperty::Pointer GetProperty(const char *propertyKey) const;
 
    void SetProperty(const char *propertyKey, BaseProperty *property);
 
    virtual void SetOrigin(const Point3D &origin);
 
    itk::SmartPointer<mitk::BaseDataSource> GetSource() const;
 
    unsigned int GetTimeSteps() const { return m_TimeGeometry->CountTimeSteps(); }
 
    itk::ModifiedTimeType GetMTime() const override;
 
    void Graft(const DataObject *) override;
 
  protected:
    BaseData();
    BaseData(const BaseData &other);
    ~BaseData() override;
 
    //##Documentation
    //## \brief Initialize the TimeGeometry for a number of time steps.
    //## The TimeGeometry is initialized empty and evenly timed.
    //## In many cases it will be necessary to overwrite this in sub-classes.
    virtual void InitializeTimeGeometry(unsigned int timeSteps = 1);
 
    //##Documentation
    //## @brief reset to non-initialized state, release memory
    virtual void ClearData();
 
    //##Documentation
    //## @brief Pure virtual; Must be used in subclasses to get a data object to a
    //## valid state. Should at least create one empty object and call
    //## Superclass::InitializeTimeGeometry() to ensure an existing valid geometry
    virtual void InitializeEmpty() {}
    void PrintSelf(std::ostream &os, itk::Indent indent) const override;
 
    bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion;
 
    mutable unsigned int m_SourceOutputIndexDuplicate;
 
    bool m_Initialized;
 
  private:
    //##Documentation
    //## @brief PropertyList, f.e. to hold pic-tags, tracking-data,..
    //##
    PropertyList::Pointer m_PropertyList;
 
    TimeGeometry::Pointer m_TimeGeometry;
  };
 
} // namespace mitk
 
#endif