itkScaleTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 VDimension = 3>
class ITK_TEMPLATE_EXPORT ScaleTransform
  : public MatrixOffsetTransformBase<TParametersValueType, VDimension, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScaleTransform);

  using Self = ScaleTransform;
  using Superclass = MatrixOffsetTransformBase<TParametersValueType, VDimension, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ScaleTransform);

  static constexpr unsigned int SpaceDimension = VDimension;
  static constexpr unsigned int ParametersDimension = VDimension;

  using typename Superclass::ScalarType;

  using typename Superclass::FixedParametersType;
  using typename Superclass::ParametersType;

  using typename Superclass::JacobianType;
  using typename Superclass::JacobianPositionType;
  using typename Superclass::InverseJacobianPositionType;

  using ScaleType = FixedArray<TParametersValueType, VDimension>;

  using InputVectorType = Vector<TParametersValueType, VDimension>;
  using OutputVectorType = Vector<TParametersValueType, VDimension>;

  using InputCovariantVectorType = CovariantVector<TParametersValueType, VDimension>;
  using OutputCovariantVectorType = CovariantVector<TParametersValueType, VDimension>;

  using InputVnlVectorType = vnl_vector_fixed<TParametersValueType, VDimension>;
  using OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, VDimension>;

  using InputPointType = Point<TParametersValueType, VDimension>;
  using OutputPointType = Point<TParametersValueType, VDimension>;

  using InverseTransformBaseType = typename Superclass::InverseTransformBaseType;
  using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer;
 
  using typename Superclass::MatrixType;

  void
  SetParameters(const ParametersType & parameters) override;

  const ParametersType &
  GetParameters() const override;

  void
  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & j) const override;

  void
  ComputeJacobianWithRespectToPosition(const InputPointType & x, JacobianPositionType & jac) const override;
  using Superclass::ComputeJacobianWithRespectToPosition;

  void
  SetScale(const ScaleType & scale);
 
  void
  ComputeMatrix() override;

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

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

  OutputPointType
  TransformPoint(const InputPointType & point) const override;
 
  using Superclass::TransformVector;
  OutputVectorType
  TransformVector(const InputVectorType & vect) const override;
 
  OutputVnlVectorType
  TransformVector(const InputVnlVectorType & vect) const override;
 
  using Superclass::TransformCovariantVector;
  OutputCovariantVectorType
  TransformCovariantVector(const InputCovariantVectorType & vect) const override;

  inline InputPointType
  BackTransform(const OutputPointType & point) const;
 
  inline InputVectorType
  BackTransform(const OutputVectorType & vect) const;
 
  inline InputVnlVectorType
  BackTransform(const OutputVnlVectorType & vect) const;
 
  inline InputCovariantVectorType
  BackTransform(const OutputCovariantVectorType & vect) const;

  bool
  GetInverse(Self * inverse) const;

  InverseTransformBasePointer
  GetInverseTransform() const override;

  void
  SetIdentity() override;

  itkGetConstReferenceMacro(Scale, ScaleType);
 
protected:
  ScaleTransform();

  ~ScaleTransform() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  ScaleType m_Scale{}; // Scales of the transformation
 
}; // class ScaleTransform
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScaleTransform.hxx"
#endif
 
#endif /* itkScaleTransform_h */