animaMultiCompartmentModel.h

Go to the documentation of this file.

#pragma once

#include <animaBaseCompartment.h>
#include <AnimaMCMBaseExport.h>

#include <itkLightObject.h>
#include <itkObjectFactory.h>

namespace anima
{

class ANIMAMCMBASE_EXPORT MultiCompartmentModel : public itk::LightObject
{
public:
    // Useful typedefs
    typedef MultiCompartmentModel Self;
    typedef itk::LightObject Superclass;
    typedef itk::SmartPointer<Self> Pointer;
    typedef itk::SmartPointer<const Self> ConstPointer;

    itkTypeMacro(MultiCompartmentModel, itk::LightObject)

    itkNewMacro(Self)

    typedef BaseCompartment::Pointer BaseCompartmentPointer;
    typedef BaseCompartment::Vector3DType Vector3DType;
    typedef BaseCompartment::ListType ListType;
    typedef BaseCompartment::ModelOutputVectorType ModelOutputVectorType;

    itk::LightObject::Pointer InternalClone() const ITK_OVERRIDE;

    void AddCompartment(double weight, BaseCompartment *compartment);

    unsigned int GetNumberOfCompartments() {return m_Compartments.size();}
    itkGetMacro(NumberOfIsotropicCompartments, unsigned int)

    BaseCompartment *GetCompartment(unsigned int i);

    ListType &GetParametersAsVector();
    void SetParametersFromVector(ListType &params);

    const ListType &GetCompartmentWeights() {return m_CompartmentWeights;}
    double GetCompartmentWeight(unsigned int i);
    void SetCompartmentWeights(const ListType &weights);

    ModelOutputVectorType &GetModelVector();

    void SetModelVector(const itk::VariableLengthVector <float> &mcmVec);
    void SetModelVector(const ModelOutputVectorType &mcmVec);

    double GetPredictedSignal(double smallDelta, double bigDelta, double gradientStrength, const Vector3DType &gradient);
    ListType &GetSignalJacobian(double smallDelta, double bigDelta, double gradientStrength, const Vector3DType &gradient);
    double GetDiffusionProfile(Vector3DType &sample);

    ListType &GetParameterLowerBounds();
    ListType &GetParameterUpperBounds();

    unsigned int GetNumberOfParameters();

    unsigned int GetNumberOfOptimizedWeights();

    unsigned int GetSize();

    void Reorient(vnl_matrix <double> &orientationMatrix, bool affineTransform);

    void SetOptimizeWeights(bool val) {m_OptimizeWeights = val;}
    itkGetMacro(OptimizeWeights, bool)

    void SetCommonDiffusivityParameters(bool val) {m_CommonDiffusivityParameters = val;}
    itkGetMacro(CommonDiffusivityParameters, bool)

    void SetCommonConcentrationParameters(bool val) {m_CommonConcentrationParameters = val;}
    itkGetMacro(CommonConcentrationParameters, bool)

    void SetCommonExtraAxonalFractionParameters(bool val) {m_CommonExtraAxonalFractionParameters = val;}
    itkGetMacro(CommonExtraAxonalFractionParameters, bool)

    void SetNegativeWeightBounds(bool val) {m_NegativeWeightBounds = val;}
    itkGetMacro(NegativeWeightBounds, bool)

protected:
    MultiCompartmentModel();
    ~MultiCompartmentModel();

private:
    std::vector <BaseCompartmentPointer> m_Compartments;
    ListType m_CompartmentWeights;

    bool m_OptimizeWeights;
    bool m_CommonDiffusivityParameters;
    bool m_CommonConcentrationParameters;
    bool m_CommonExtraAxonalFractionParameters;

    unsigned int m_NumberOfIsotropicCompartments;

    bool m_NegativeWeightBounds;

    ListType m_JacobianVector;

    ListType m_ParametersVector;

    ListType m_WorkVector;

    ListType m_ParametersLowerBoundsVector;

    ListType m_ParametersUpperBoundsVector;

    ModelOutputVectorType m_ModelVector;
};

} // end namespace anima