itkStatisticalModelTransformBase.h

/*
 * This file is part of the statismo library.
 *
 * Author: Marcel Luethi (marcel.luethi@unibas.ch)
 *
 * Copyright (c) 2011 University of Basel
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of the project's author nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __itkStatisticalModelTransform_h
#define __itkStatisticalModelTransform_h

#include <iostream>

#include <itkImage.h>
#include <itkTransform.h>
#include <itkVector.h>

#include "Representer.h"

#include "itkStatisticalModel.h"

namespace itk {

template <class TDataset, class TScalarType,  unsigned int TInputDimension, unsigned int TOutputDimension = TInputDimension  >
class ITK_EXPORT StatisticalModelTransformBase :
    public itk::Transform< TScalarType , TInputDimension, TOutputDimension> {
  public:
    /* Standard class typedefs. */
    typedef StatisticalModelTransformBase            Self;
    typedef itk::Transform< TScalarType , TInputDimension, TOutputDimension>  Superclass;
    typedef SmartPointer<Self>                Pointer;
    typedef SmartPointer<const Self>          ConstPointer;

    typedef vnl_vector<statismo::ScalarType> VectorType;
    typedef vnl_matrix<statismo::ScalarType> MatrixType;


    virtual void CopyBaseMembers(StatisticalModelTransformBase* another) const {
        another->m_StatisticalModel = m_StatisticalModel;
        another->m_coeff_vector = m_coeff_vector;
        another->m_usedNumberCoefficients = m_usedNumberCoefficients;
        another->m_FixedParameters = m_FixedParameters;
        another->m_Parameters = this->m_Parameters;
    }


    itkTypeMacro( StatisticalModelTransformBase, Superclass );

    /* Dimension of parameters. */
    itkStaticConstMacro(SpaceDimension, unsigned int, TInputDimension);
    itkStaticConstMacro(InputSpaceDimension, unsigned int, TInputDimension);
    itkStaticConstMacro(OutputSpaceDimension, unsigned int, TOutputDimension);


    /* Parameters Type   */
    typedef typename Superclass::ParametersType         ParametersType;
    typedef typename Superclass::JacobianType           JacobianType;
    typedef typename Superclass::ScalarType             ScalarType;
    typedef typename Superclass::InputPointType         InputPointType;
    typedef typename Superclass::OutputPointType        OutputPointType;
    typedef typename Superclass::InputVectorType        InputVectorType;
    typedef typename Superclass::OutputVectorType       OutputVectorType;
    typedef typename Superclass::InputVnlVectorType     InputVnlVectorType;
    typedef typename Superclass::OutputVnlVectorType    OutputVnlVectorType;
    typedef typename Superclass::InputCovariantVectorType
    InputCovariantVectorType;
    typedef typename Superclass::OutputCovariantVectorType
    OutputCovariantVectorType;

    typedef statismo::Representer<TDataset> RepresenterType;
    typedef itk::StatisticalModel<TDataset> StatisticalModelType;


    virtual void ComputeJacobianWithRespectToParameters(const InputPointType  &pt, JacobianType & jacobian) const;

    virtual OutputPointType  TransformPoint(const InputPointType &pt) const = 0;

    virtual void SetIdentity(void);

    virtual void SetParameters( const ParametersType & );

    virtual const ParametersType& GetParameters(void) const;

    virtual void SetFixedParameters( const ParametersType &p ) {
        // there no fixed parameters

    }

    virtual const ParametersType& GetFixedParameters(void) const {
        return this->m_FixedParameters;
    };

    virtual VectorType GetCoefficients() const {
        return m_coeff_vector;
    }

    virtual void SetCoefficients( VectorType& coefficients) {
        m_coeff_vector = coefficients;
    }

    void SetStatisticalModel(const StatisticalModelType* model);

    typename StatisticalModelType::ConstPointer GetStatisticalModel() const;

    void SetUsedNumberOfCoefficients(unsigned n) {
        m_usedNumberCoefficients = n;
    }

    unsigned GetUsedNumberOfCoefficients() {
        return m_usedNumberCoefficients;
    }

  protected:

    StatisticalModelTransformBase();
    virtual ~StatisticalModelTransformBase() {};

    void PrintSelf(std::ostream &os, Indent indent) const;

    typename StatisticalModelType::ConstPointer m_StatisticalModel;
    VectorType m_coeff_vector;
    unsigned m_usedNumberCoefficients;
    ParametersType m_FixedParameters;

    StatisticalModelTransformBase(const Self& obj);// : Superclass(obj) {} //purposely not implemented
    void operator=(const Self& rhs);// { return Superclass::operator=(rhs); } //purposely not implemented



};


}  // namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
# include "itkStatisticalModelTransformBase.hxx"
#endif

#endif /* __itkStatisticalModelTransform_h */