mitkModelFitInfo.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 mitkModelFitInfo_h
#define mitkModelFitInfo_h
 
#include <mitkDataStorage.h>
 
#include <mitkModelFitConstants.h>
#include <mitkModelFitParameter.h>
#include <mitkModelFitStaticParameterMap.h>
#include <mitkScalarListLookupTable.h>
#include <mitkModelParameterizerBase.h>
#include <mitkModelTraitsInterface.h>
 
#include <MitkModelFitExports.h>
 
namespace mitk
{
 
  namespace modelFit
  {
    class MITKMODELFIT_EXPORT ModelFitInfo : public itk::LightObject
    {
    public:
      typedef std::string UIDType;
      typedef std::vector<Parameter::Pointer> ParamListType;
      typedef ParamListType::const_iterator ConstIterType;
 
      mitkClassMacroItkParent(ModelFitInfo, itk::LightObject);
      itkSimpleNewMacro(ModelFitInfo);
 
      ModelFitInfo() :
        x(mitk::ModelFitConstants::MODEL_X_VALUE_DEFAULT()),
        xAxisName(mitk::ModelFitConstants::XAXIS_NAME_VALUE_DEFAULT()),
        yAxisName(mitk::ModelFitConstants::YAXIS_NAME_VALUE_DEFAULT())
      {
      }
 
      void AddParameter(Parameter::Pointer p);
 
      Parameter::ConstPointer GetParameter(const std::string& name, const Parameter::Type& type)
      const;
 
      void DeleteParameter(const std::string& name, const Parameter::Type& type);
 
      const ParamListType& GetParameters() const;
 
      std::string modelName;
      std::string modelType;
      std::string function;
      std::string functionClassID;
      std::string x;
 
      std::string xAxisName;
      std::string xAxisUnit;
 
      std::string yAxisName;
      std::string yAxisUnit;
 
      UIDType uid;
      std::string fitName;
      std::string fitType;
      StaticParameterMap staticParamMap;
      UIDType roiUID;
      ScalarListLookupTable inputData;
      mitk::Image::ConstPointer inputImage;
 
    private:
      typedef ParamListType::iterator IterType;
      typedef std::lock_guard<std::mutex> LockType;
 
      ParamListType parameterList;
      std::mutex mutex;
    };
 
    MITKMODELFIT_EXPORT const std::string GetMandatoryProperty(const mitk::DataNode* node,
        const std::string& prop);
 
    MITKMODELFIT_EXPORT const std::string GetMandatoryProperty(const mitk::BaseData* data,
      const std::string& prop);
 
    MITKMODELFIT_EXPORT ModelFitInfo::Pointer CreateFitInfoFromNode(const ModelFitInfo::UIDType& uid,
        const mitk::DataStorage* storage);
 
    MITKMODELFIT_EXPORT ModelFitInfo::Pointer CreateFitInfoFromModelParameterizer(
      const ModelParameterizerBase* usedParameterizer, mitk::BaseData* inputImage,
      const std::string& fitType, const std::string& fitName = "", const ModelFitInfo::UIDType& roiUID = "");
 
    MITKMODELFIT_EXPORT ModelFitInfo::Pointer CreateFitInfoFromModelParameterizer(
      const ModelParameterizerBase* usedParameterizer, mitk::BaseData* inputImage,
      const std::string& fitType, const ScalarListLookupTable& inputData, const std::string& fitName = "",
      const ModelFitInfo::UIDType& roiUID = "");
 
    MITKMODELFIT_EXPORT DataStorage::SetOfObjects::ConstPointer GetNodesOfFit(
      const ModelFitInfo::UIDType& fitUID,
      const mitk::DataStorage* storage);
 
    typedef std::set<ModelFitInfo::UIDType> NodeUIDSetType;
 
    MITKMODELFIT_EXPORT NodeUIDSetType GetFitUIDsOfNode(const mitk::DataNode* node,
        const mitk::DataStorage* storage);
 
  }
}
 
#endif