itkScaleTransform.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 itkScaleTransform_h
#define itkScaleTransform_h

#include "itkMatrixOffsetTransformBase.h"
#include "itkMacro.h"
#include "itkMatrix.h"

namespace itk
{
template<typename TParametersValueType=float,
          unsigned int NDimensions=3>
class ScaleTransform : public MatrixOffsetTransformBase<TParametersValueType,
                                                        NDimensions,
                                                        NDimensions>
{
public:
  typedef ScaleTransform                                                            Self;
  typedef MatrixOffsetTransformBase<TParametersValueType, NDimensions, NDimensions> Superclass;
  typedef SmartPointer<Self>                                                        Pointer;
  typedef SmartPointer<const Self>                                                  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ScaleTransform, Transform);

  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);
  itkStaticConstMacro(ParametersDimension, unsigned int, NDimensions);

  typedef typename Superclass::ScalarType ScalarType;

  typedef typename Superclass::FixedParametersType FixedParametersType;
  typedef typename Superclass::ParametersType      ParametersType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef FixedArray<TParametersValueType, NDimensions> ScaleType;

  typedef Vector<TParametersValueType, NDimensions> InputVectorType;
  typedef Vector<TParametersValueType, NDimensions> OutputVectorType;

  typedef CovariantVector<TParametersValueType, NDimensions> InputCovariantVectorType;
  typedef CovariantVector<TParametersValueType, NDimensions> OutputCovariantVectorType;

  typedef vnl_vector_fixed<TParametersValueType, NDimensions> InputVnlVectorType;
  typedef vnl_vector_fixed<TParametersValueType, NDimensions> OutputVnlVectorType;

  typedef Point<TParametersValueType, NDimensions> InputPointType;
  typedef Point<TParametersValueType, NDimensions> OutputPointType;

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

  typedef typename Superclass::MatrixType MatrixType;

  virtual void SetParameters(const ParametersType & parameters) ITK_OVERRIDE;

  virtual const ParametersType & GetParameters() const ITK_OVERRIDE;


#if !defined( ITK_LEGACY_REMOVE )

  virtual void SetFixedParameters(const FixedParametersType &params) ITK_OVERRIDE
    {
      if (params.GetSize() != NDimensions)
        {
        itkWarningMacro(<< "The ScaleTransform now has " << NDimensions << " fixed parameters for the Center. Ignoring fixed parameters provided.");
        return;
        }
      Superclass::SetFixedParameters(params);
    }
#endif


  virtual void ComputeJacobianWithRespectToParameters(const InputPointType & point, JacobianType & j) const ITK_OVERRIDE;

  virtual void ComputeJacobianWithRespectToPosition(const InputPointType  & x, JacobianType & jac) const ITK_OVERRIDE;

  void SetScale(const ScaleType & scale);

  virtual void ComputeMatrix(void) ITK_OVERRIDE;

  void Compose(const Self *other, bool pre = false);

  void Scale(const ScaleType & scale, bool pre = false);

  OutputPointType     TransformPoint(const InputPointType  & point) const ITK_OVERRIDE;

  using Superclass::TransformVector;
  OutputVectorType    TransformVector(const InputVectorType & vector) const ITK_OVERRIDE;

  OutputVnlVectorType TransformVector(const InputVnlVectorType & vector) const ITK_OVERRIDE;

  using Superclass::TransformCovariantVector;
  OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType & vector) const ITK_OVERRIDE;

  inline InputPointType     BackTransform(const OutputPointType  & point) const;

  inline InputVectorType    BackTransform(const OutputVectorType & vector) const;

  inline InputVnlVectorType BackTransform(const OutputVnlVectorType & vector) const;

  inline InputCovariantVectorType BackTransform(const OutputCovariantVectorType & vector) const;

  bool GetInverse(Self *inverse) const;

  virtual InverseTransformBasePointer GetInverseTransform() const ITK_OVERRIDE;

  void SetIdentity() ITK_OVERRIDE;

  itkGetConstReferenceMacro(Scale, ScaleType);

protected:
  ScaleTransform();

  ~ScaleTransform();

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

private:
  ScaleTransform(const Self & other);   // purposely not implemented
  const Self & operator=(const Self &); // purposely not implemented

  ScaleType m_Scale;    // Scales of the transformation

};                         // class ScaleTransform

} // end namespace itk

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

#endif /* itkScaleTransform_h */