itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.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 itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor_h
#define itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor_h
 
#include "itkTransformParametersAdaptor.h"
 
namespace itk
{
template <typename TTransform>
class ITK_TEMPLATE_EXPORT TimeVaryingBSplineVelocityFieldTransformParametersAdaptor
  : public TransformParametersAdaptor<TTransform>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TimeVaryingBSplineVelocityFieldTransformParametersAdaptor);

  using Self = TimeVaryingBSplineVelocityFieldTransformParametersAdaptor;
  using Superclass = TransformParametersAdaptor<TTransform>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(TimeVaryingBSplineVelocityFieldTransformParametersAdaptor);

  using TransformType = TTransform;
  using TransformPointer = typename TransformType::Pointer;
  using ParametersType = typename TransformType::ParametersType;
  using ParametersValueType = typename TransformType::ParametersValueType;
  using FixedParametersType = typename TransformType::FixedParametersType;
  using FixedParametersValueType = typename TransformType::FixedParametersValueType;
 
  using TimeVaryingVelocityFieldControlPointLatticeType =
    typename TransformType::TimeVaryingVelocityFieldControlPointLatticeType;
  using TimeVaryingVelocityFieldControlPointLatticePointer =
    typename TimeVaryingVelocityFieldControlPointLatticeType::Pointer;
  using RegionType = typename TimeVaryingVelocityFieldControlPointLatticeType::RegionType;
  using IndexType = typename TimeVaryingVelocityFieldControlPointLatticeType::IndexType;
  using VectorType = typename TimeVaryingVelocityFieldControlPointLatticeType::PixelType;
  using OriginType = typename TimeVaryingVelocityFieldControlPointLatticeType::PointType;
  using SpacingType = typename TimeVaryingVelocityFieldControlPointLatticeType::SpacingType;
  using SizeType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType;
  using SizeValueType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeValueType;
  using MeshSizeType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType;
  using DirectionType = typename TimeVaryingVelocityFieldControlPointLatticeType::DirectionType;

  static constexpr unsigned int TotalDimension = TransformType::Dimension + 1;

  itkSetMacro(SplineOrder, SizeValueType);

  itkGetConstMacro(SplineOrder, SizeValueType);

  void
  SetRequiredTransformDomainMeshSize(const MeshSizeType &);

  itkGetConstReferenceMacro(RequiredTransformDomainMeshSize, MeshSizeType);

  void
  SetRequiredTransformDomainSize(const SizeType &);

  itkGetConstReferenceMacro(RequiredTransformDomainSize, SizeType);

  void
  SetRequiredTransformDomainSpacing(const SpacingType &);

  itkGetConstReferenceMacro(RequiredTransformDomainSpacing, SpacingType);

  void
  SetRequiredTransformDomainOrigin(const OriginType &);

  itkGetConstReferenceMacro(RequiredTransformDomainOrigin, OriginType);

  void
  SetRequiredTransformDomainDirection(const DirectionType &);

  itkGetConstReferenceMacro(RequiredTransformDomainDirection, DirectionType);

  const OriginType
  GetRequiredControlPointLatticeOrigin() const
  {
    OriginType requiredLatticeOrigin;
    for (SizeValueType i = 0; i < TotalDimension; ++i)
    {
      requiredLatticeOrigin[i] = this->m_RequiredFixedParameters[TotalDimension + i];
    }
    return requiredLatticeOrigin;
  }

  const SpacingType
  GetRequiredControlPointLatticeSpacing() const
  {
    SpacingType requiredLatticeSpacing;
    for (SizeValueType i = 0; i < TotalDimension; ++i)
    {
      const FixedParametersValueType domainPhysicalDimensions =
        static_cast<FixedParametersValueType>(this->m_RequiredTransformDomainSize[i] - 1.0) *
        this->m_RequiredTransformDomainSpacing[i];
      requiredLatticeSpacing[i] =
        domainPhysicalDimensions / static_cast<FixedParametersValueType>(this->m_RequiredTransformDomainMeshSize[i]);
    }
    return requiredLatticeSpacing;
  }

  const SizeType
  GetRequiredControlPointLatticeSize() const
  {
    SizeType requiredLatticeSize;
    for (SizeValueType i = 0; i < TotalDimension; ++i)
    {
      requiredLatticeSize[i] = static_cast<SizeValueType>(this->m_RequiredFixedParameters[i]);
    }
    return requiredLatticeSize;
  }

  const DirectionType
  GetRequiredControlPointLatticeDirection() const
  {
    return this->m_RequiredTransformDomainDirection;
  }

  void
  AdaptTransformParameters() override;
 
  void
  SetRequiredFixedParameters(const FixedParametersType) override;
 
protected:
  TimeVaryingBSplineVelocityFieldTransformParametersAdaptor();
  ~TimeVaryingBSplineVelocityFieldTransformParametersAdaptor() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  void
  UpdateRequiredFixedParameters();
 
  MeshSizeType  m_RequiredTransformDomainMeshSize{};
  OriginType    m_RequiredTransformDomainOrigin{};
  DirectionType m_RequiredTransformDomainDirection{};
  SpacingType   m_RequiredTransformDomainSpacing{};
  SizeType      m_RequiredTransformDomainSize{};
 
  SizeValueType m_SplineOrder{};
 
}; // class TimeVaryingBSplineVelocityFieldTransformParametersAdaptor
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.hxx"
#endif
 
#endif /* itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor_h */