mitkModelFactoryBase.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 __MODEL_FACTORY_BASE_H
#define __MODEL_FACTORY_BASE_H

#include <itkObject.h>

#include "mitkModelBase.h"
#include "mitkModelTraitsInterface.h"
#include "mitkModelParameterizerBase.h"
#include "mitkModelFitInfo.h"
#include "mitkConstraintCheckerBase.h"

#include "MitkModelFitExports.h"

namespace mitk
{
  class MITKMODELFIT_EXPORT ModelFactoryBase : public itk::Object, public ModelTraitsInterface
  {
  public:
    /*typedef ModelFactoryBase Self;
    typedef itk::Object Superclass;
    typedef itk::SmartPointer< Self >                            Pointer;
    typedef itk::SmartPointer< const Self >                      ConstPointer;
*/
    mitkClassMacroItkParent(ModelFactoryBase, itk::Object);

    typedef ModelBase ModelBaseType;
    typedef ModelBaseType::Pointer ModelBasePointer;

    typedef ModelTraitsInterface::ParameterNameType ParameterNameType;
    typedef ModelTraitsInterface::ParameterNamesType ParameterNamesType;
    typedef ModelTraitsInterface::ParametersSizeType ParametersSizeType;

    typedef ModelTraitsInterface::ParamterScaleMapType ParamterScaleMapType;
    typedef ModelTraitsInterface::ParamterUnitMapType ParamterUnitMapType;
    typedef ModelTraitsInterface::FunctionStringType FunctionStringType;
    typedef ModelTraitsInterface::ModellClassIDType ModellClassIDType;

    typedef ModelTraitsInterface::DerivedParameterNamesType DerivedParameterNamesType;
    typedef ModelTraitsInterface::DerivedParametersSizeType DerivedParametersSizeType;
    typedef ModelTraitsInterface::DerivedParamterScaleMapType DerivedParamterScaleMapType;
    typedef ModelTraitsInterface::DerivedParamterUnitMapType DerivedParamterUnitMapType;

    virtual ModelBasePointer CreateModel() const = 0;

    ModelParameterizerBase::Pointer CreateParameterizer(const modelFit::ModelFitInfo* fit) const;

    virtual ConstraintCheckerBase::Pointer CreateDefaultConstraints() const = 0;

    virtual ParametersType GetDefaultInitialParameterization() const = 0;

   protected:
    virtual ModelParameterizerBase::Pointer DoCreateParameterizer(const modelFit::ModelFitInfo* fit)
    const = 0;

    ModelFactoryBase();
    ~ModelFactoryBase() override;

  private:

    //No copy constructor allowed
    ModelFactoryBase(const Self& source);
    void operator=(const Self&);  //purposely not implemented
  };
}

#endif // __MODEL_FACTORY_BASE_H