mitkDataCollection.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.

===================================================================*/
#pragma warning (disable : 4996)

#ifndef mitkDataCollection_H_
#define mitkDataCollection_H_

#include <itkLightObject.h>
#include <itkDataObject.h>
#include "itkObjectFactory.h"
#include "mitkCommon.h"
#include <mitkImage.h>
#include <mitkDataNode.h>

#include<mitkBaseData.h>

#include <MitkDataCollectionExports.h>

namespace mitk
{
  class MITKDATACOLLECTION_EXPORT DataCollection  : public BaseData
  {
  public:

    mitkClassMacro(DataCollection, BaseData)

      itkFactorylessNewMacro(Self)
      itkCloneMacro(Self)

      // Needed methods from Basedata
      virtual void UpdateOutputInformation();
    virtual void SetRequestedRegionToLargestPossibleRegion();
    virtual bool RequestedRegionIsOutsideOfTheBufferedRegion();
    virtual bool VerifyRequestedRegion();
    virtual void SetRequestedRegion(const itk::DataObject *);

    void Init(std::string name);

    size_t AddData(DataObject::Pointer data, std::string name, std::string filePath = "");

    void SetName(std::string name);

    std::string GetName() const;

    std::string GetDataFilePath(size_t index) const;

    size_t NameToIndex(std::string name);

    std::string IndexToName(size_t index) const;

    bool HasElement(std::string name);

    bool HasElement(size_t index);

    size_t Size() const;

    void SetData(itk::DataObject::Pointer data, size_t index);

    void SetData(itk::DataObject::Pointer data, std::string name);

    itk::DataObject::Pointer GetData(size_t index);

    itk::DataObject::Pointer GetData(std::string name);

    mitk::Image::Pointer GetMitkImage(size_t index);

    mitk::Image::Pointer GetMitkImage(std::string name);

    template <class ImageType>
    ImageType GetItkImage(size_t index, ImageType* itkImage);

    template <class ImageType>
    ImageType GetItkImage(std::string name, ImageType* itkImage);

    itk::DataObject::Pointer& operator[](size_t index);

    itk::DataObject::Pointer& operator[](std::string &name);

    void SetNameForIndex(size_t index, std::string &name);

    void SetXMLFile(std::string absoluteXMlFile);

    std::string GetXMLFile();

    void SetParent(mitk::DataCollection* parent);

    mitk::DataCollection* GetParent();

    bool RemoveIndex(size_t index);

    bool RemoveElement(std::string& name);

    void Clear();

    mitk::DataNode::Pointer GetDataNode(size_t index);

    mitk::DataNode::Pointer GetDataNode(std::string name);

    mitk::Image::Pointer GetProbabilityMap(std::vector<std::string> probabilityNamesVector);

  protected:

    DataCollection();
    virtual ~DataCollection();

  private:
    // DATA
    std::string m_Name;
    std::vector<itk::DataObject::Pointer> m_DataVector;
    std::vector<std::string> m_NameVector;
    std::vector<std::string> m_FilePathVector;
    std::map<std::string, size_t> m_DataNames;

    mitk::DataCollection * m_Parent;

    std::string m_XMLFile; // is only filled for the hightest layer when loading a data collection
  };
} // end namespace
#endif