itkGridScheduleComputer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkGridScheduleComputer_h
#define itkGridScheduleComputer_h
 
#include "itkObject.h"
#include "itkImageBase.h"
#include "itkTransform.h"
 
namespace itk
{

 
template <typename TTransformScalarType, unsigned int VImageDimension>
class ITK_TEMPLATE_EXPORT GridScheduleComputer : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GridScheduleComputer);

  using Self = GridScheduleComputer;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GridScheduleComputer);

  itkStaticConstMacro(Dimension, unsigned int, VImageDimension);

  using TransformScalarType = TTransformScalarType;
  using ImageBaseType = ImageBase<Self::Dimension>;
  using PointType = typename ImageBaseType::PointType;
  using OriginType = typename ImageBaseType::PointType;
  using SpacingType = typename ImageBaseType::SpacingType;
  using DirectionType = typename ImageBaseType::DirectionType;
  using SizeType = typename ImageBaseType::SizeType;
  using RegionType = typename ImageBaseType::RegionType;
  using GridSpacingFactorType = SpacingType;
  using VectorOriginType = std::vector<OriginType>;
  using VectorSpacingType = std::vector<SpacingType>;
  using VectorDirectionType = std::vector<DirectionType>;
  using VectorRegionType = std::vector<RegionType>;
  using VectorGridSpacingFactorType = std::vector<GridSpacingFactorType>;

  using TransformType = Transform<TransformScalarType, Self::Dimension, Self::Dimension>;
  using TransformPointer = typename TransformType::Pointer;
  using TransformConstPointer = typename TransformType::ConstPointer;

  itkSetMacro(ImageOrigin, OriginType);

  itkGetConstMacro(ImageOrigin, OriginType);

  itkSetMacro(ImageSpacing, SpacingType);

  itkGetConstMacro(ImageSpacing, SpacingType);

  itkSetMacro(ImageDirection, DirectionType);

  itkGetConstMacro(ImageDirection, DirectionType);

  itkSetMacro(ImageRegion, RegionType);

  itkGetConstMacro(ImageRegion, RegionType);

  itkSetClampMacro(BSplineOrder, unsigned int, 0, 5);

  itkGetConstMacro(BSplineOrder, unsigned int);

  itkSetMacro(FinalGridSpacing, SpacingType);

  itkGetConstMacro(FinalGridSpacing, SpacingType);

  void
  SetDefaultSchedule(unsigned int numberOfLevels);

  void
  SetSchedule(const VectorGridSpacingFactorType & schedule);

  VectorGridSpacingFactorType
  GetSchedule() const;

  itkSetConstObjectMacro(InitialTransform, TransformType);

  virtual void
  ComputeBSplineGrid();

  void
  GetBSplineGrid(unsigned int    level,
                 RegionType &    gridRegion,
                 SpacingType &   gridSpacing,
                 OriginType &    gridOrigin,
                 DirectionType & gridDirection);
 
protected:
  GridScheduleComputer();

  ~GridScheduleComputer() override = default;

  VectorSpacingType           m_GridSpacings{};
  VectorOriginType            m_GridOrigins{};
  VectorDirectionType         m_GridDirections{};
  VectorRegionType            m_GridRegions{};
  TransformConstPointer       m_InitialTransform{ nullptr };
  VectorGridSpacingFactorType m_GridSpacingFactors{};

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

  itkGetConstMacro(NumberOfLevels, unsigned int);

  void
  ApplyInitialTransform(OriginType &    imageOrigin,
                        SpacingType &   imageSpacing,
                        DirectionType & imageDirection,
                        SpacingType &   finalGridSpacing) const;
 
private:
  OriginType    m_ImageOrigin{};
  SpacingType   m_ImageSpacing{ MakeFilled<SpacingType>(1.0) };
  RegionType    m_ImageRegion{};
  DirectionType m_ImageDirection{ DirectionType::GetIdentity() };
  unsigned int  m_BSplineOrder{ 3 };
  unsigned int  m_NumberOfLevels{};
  SpacingType   m_FinalGridSpacing{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGridScheduleComputer.hxx"
#endif
 
#endif // end #ifndef itkGridScheduleComputer_h