mitkParameterFitImageGeneratorBase.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 __MITK_PARAMETER_FIT_IMAGE_GENERATOR_BASE_H_
#define __MITK_PARAMETER_FIT_IMAGE_GENERATOR_BASE_H_

#include <map>

#include <mitkImage.h>

#include "mitkModelBase.h"

#include "MitkModelFitExports.h"

namespace mitk
{
  class MITKMODELFIT_EXPORT ParameterFitImageGeneratorBase: public ::itk::Object
  {
  public:
    mitkClassMacroItkParent(ParameterFitImageGeneratorBase, ::itk::Object);

    using ParameterImagePixelType = ScalarType;

    using ModelBaseType = ModelBase;
    using ParameterNameType = ModelBaseType::ParameterNameType;
    using ParameterNamesType = ModelBaseType::ParameterNamesType;

    using ParameterImageMapType = std::map<ParameterNameType,Image::Pointer>;

    virtual double GetProgress() const = 0;

    void Generate();

    ParameterImageMapType GetParameterImages();

    ParameterImageMapType GetDerivedParameterImages();

    ParameterImageMapType GetCriterionImages();

    ParameterImageMapType GetEvaluationParameterImages();

    virtual ParameterNamesType GetParameterNames() const = 0;

    virtual ParameterNamesType GetDerivedParameterNames() const = 0;

    virtual ParameterNamesType GetCriterionNames() const = 0;

    virtual ParameterNamesType GetEvaluationParameterNames() const = 0;

  protected:
    ParameterFitImageGeneratorBase() {};
    ~ParameterFitImageGeneratorBase() override {};

    virtual bool HasOutdatedResult() const;
    virtual void CheckValidInputs() const;
    virtual void DoFitAndGetResults(ParameterImageMapType& parameterImages, ParameterImageMapType& derivedParameterImages, ParameterImageMapType& criterionImages, ParameterImageMapType& evaluationParameterImages) = 0;

    itk::TimeStamp m_GenerationTimeStamp;

  private:

    ParameterImageMapType m_ParameterImageMap;
    ParameterImageMapType m_DerivedParameterImageMap;
    ParameterImageMapType m_CriterionImageMap;
    ParameterImageMapType m_EvaluationParameterImageMap;
  };

}

#endif // __MITK_PARAMETER_FIT_IMAGE_GENERATOR_H_