itkGenerateImageSource.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 itkGenerateImageSource_h
#define itkGenerateImageSource_h
 
#include "itkImageSource.h"
 
namespace itk
{

template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT GenerateImageSource : public ImageSource<TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GenerateImageSource);
 
  using Self = GenerateImageSource;
  using Superclass = ImageSource<TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using PixelType = typename OutputImageType::PixelType;
  using RegionType = typename OutputImageType::RegionType;
  using SpacingType = typename OutputImageType::SpacingType;
  using PointType = typename OutputImageType::PointType;
  using DirectionType = typename OutputImageType::DirectionType;
  using IndexType = typename OutputImageType::IndexType;

  using ReferenceImageBaseType = ImageBase<TOutputImage::ImageDimension>;
 
  using SizeType = typename TOutputImage::SizeType;
  using SizeValueType = typename TOutputImage::SizeValueType;

  static constexpr unsigned int NDimensions = TOutputImage::ImageDimension;

  itkOverrideGetNameOfClassMacro(GenerateImageSource);
 
  itkSetMacro(UseReferenceImage, bool);
  itkBooleanMacro(UseReferenceImage);
  itkGetConstMacro(UseReferenceImage, bool);

  itkSetMacro(Size, SizeType);
  itkGetConstReferenceMacro(Size, SizeType);
  itkSetVectorMacro(Size, SizeValueType, NDimensions);
  itkSetMacro(Spacing, SpacingType);
  itkGetConstReferenceMacro(Spacing, SpacingType);
  itkSetVectorMacro(Spacing, const float, NDimensions);

  itkSetMacro(Origin, PointType);
  itkGetConstReferenceMacro(Origin, PointType);
  itkSetVectorMacro(Origin, const float, NDimensions);
  itkSetMacro(Direction, DirectionType);
  itkGetConstReferenceMacro(Direction, DirectionType);
  itkSetMacro(StartIndex, IndexType);
  itkGetConstReferenceMacro(StartIndex, IndexType);
  void
  SetOutputParametersFromImage(const ReferenceImageBaseType * image);

  itkSetInputMacro(ReferenceImage, ReferenceImageBaseType);

  itkGetInputMacro(ReferenceImage, ReferenceImageBaseType);
 
protected:
  GenerateImageSource();
  ~GenerateImageSource() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateOutputInformation() override;
 
private:
  SizeType      m_Size{}; // size of the output image
  SpacingType   m_Spacing{};
  PointType     m_Origin{};
  DirectionType m_Direction{};
  IndexType     m_StartIndex{};
  bool          m_UseReferenceImage{ false };
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGenerateImageSource.hxx"
#endif
 
#endif // itkGenerateImageSource_h