itkCenteredAffineTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkCenteredAffineTransform_h
#define __itkCenteredAffineTransform_h

#include "itkAffineTransform.h"

namespace itk
{
template <
  class TScalarType = double,      // Data type for scalars
  unsigned int NDimensions = 3>
// Number of dimensions in the input space
class ITK_EXPORT CenteredAffineTransform : public AffineTransform<TScalarType,
                                                                  NDimensions>
{
public:
  typedef CenteredAffineTransform                   Self;
  typedef AffineTransform<TScalarType, NDimensions> Superclass;
  typedef SmartPointer<Self>                        Pointer;
  typedef SmartPointer<const Self>                  ConstPointer;

  itkTypeMacro(CenteredAffineTransform, AffineTransform);

  itkNewMacro(Self);

  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);
  itkStaticConstMacro( ParametersDimension, unsigned int,
                       NDimensions * ( NDimensions + 2 ) );

  typedef typename Superclass::ParametersType      ParametersType;
  typedef typename Superclass::ParametersValueType ParametersValueType;
  typedef typename Superclass::JacobianType        JacobianType;
  typedef typename Superclass::ScalarType          ScalarType;
  typedef typename Superclass::InputVectorType     InputVectorType;
  typedef typename Superclass::OutputVectorType    OutputVectorType;
  typedef typename Superclass::InputCovariantVectorType
  InputCovariantVectorType;
  typedef typename Superclass::OutputCovariantVectorType
  OutputCovariantVectorType;

  typedef typename Superclass::InputVnlVectorType    InputVnlVectorType;
  typedef typename Superclass::OutputVnlVectorType   OutputVnlVectorType;
  typedef typename Superclass::InputPointType        InputPointType;
  typedef typename Superclass::InputPointValueType   InputPointValueType;
  typedef typename Superclass::OutputVectorValueType OutputVectorValueType;
  typedef typename Superclass::OutputPointType       OutputPointType;
  typedef typename Superclass::MatrixType            MatrixType;
  typedef typename Superclass::MatrixValueType       MatrixValueType;
  typedef typename Superclass::OffsetType            OffsetType;

  typedef typename Superclass::InverseTransformBaseType InverseTransformBaseType;
  typedef typename InverseTransformBaseType::Pointer    InverseTransformBasePointer;

  void SetParameters(const ParametersType & parameters);

  const ParametersType & GetParameters(void) const;

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

  bool GetInverse(Self *inverse) const;

  virtual InverseTransformBasePointer GetInverseTransform() const;

protected:
  CenteredAffineTransform();

  virtual ~CenteredAffineTransform();
private:
  CenteredAffineTransform(const Self & other);
  const Self & operator=(const Self &);

}; // class CenteredAffineTransform
}  // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_CenteredAffineTransform(_, EXPORT, TypeX, TypeY)                       \
  namespace itk                                                                             \
  {                                                                                         \
  _( 2 ( class EXPORT CenteredAffineTransform<ITK_TEMPLATE_2 TypeX> ) )                   \
  namespace Templates                                                                       \
  {                                                                                         \
  typedef CenteredAffineTransform<ITK_TEMPLATE_2 TypeX> CenteredAffineTransform##TypeY; \
  }                                                                                         \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkCenteredAffineTransform+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkCenteredAffineTransform.hxx"
#endif

#endif /* __itkCenteredAffineTransform_h */