itkSpatialObjectToImageFilter.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 itkSpatialObjectToImageFilter_h
#define itkSpatialObjectToImageFilter_h
 
#include "itkImageSource.h"
#include "itkConceptChecking.h"
 
namespace itk
{
template <typename TInputSpatialObject, typename TOutputImage>
class ITK_TEMPLATE_EXPORT SpatialObjectToImageFilter : public ImageSource<TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SpatialObjectToImageFilter);

  using Self = SpatialObjectToImageFilter;
  using Superclass = ImageSource<TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using OutputImageType = TOutputImage;
  using IndexType = typename OutputImageType::IndexType;
  using SizeType = typename OutputImageType::SizeType;
  using PointType = typename OutputImageType::PointType;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using ValueType = typename OutputImageType::ValueType;
  using SpacingType = typename OutputImageType::SpacingType;
  using DirectionType = typename OutputImageType::DirectionType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SpatialObjectToImageFilter);

  using typename Superclass::OutputImageRegionType;

  using InputSpatialObjectType = TInputSpatialObject;
  using InputSpatialObjectPointer = typename InputSpatialObjectType::Pointer;
  using InputSpatialObjectConstPointer = typename InputSpatialObjectType::ConstPointer;
  using ChildrenListType = typename TInputSpatialObject::ChildrenListType;

  static constexpr unsigned int ObjectDimension = InputSpatialObjectType::ObjectDimension;
 
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  using Superclass::SetInput;
  virtual void
  SetInput(const InputSpatialObjectType * input);
 
  virtual void
  SetInput(unsigned int, const InputSpatialObjectType * object);
 
  const InputSpatialObjectType *
  GetInput();
 
  const InputSpatialObjectType *
  GetInput(unsigned int idx);

  template <class TReferenceImage>
  void
  SetReferenceImage(TReferenceImage * refImage)
  {
    this->SetOrigin(refImage->GetOrigin());
    this->SetSpacing(refImage->GetSpacing());
    this->SetDirection(refImage->GetDirection());
    this->SetIndex(refImage->GetLargestPossibleRegion().GetIndex());
    this->SetSize(refImage->GetLargestPossibleRegion().GetSize());
  }


  virtual void
  SetSpacing(const SpacingType & spacing);
 
  virtual void
  SetSpacing(const double * spacing);
 
  virtual void
  SetSpacing(const float * spacing);
 
  virtual const double *
  GetSpacing() const;
 
  virtual const SpacingType &
  GetSpacingVector() const;

  virtual void
  SetDirection(const DirectionType & dir);
 
  virtual const DirectionType &
  GetDirection() const;

  itkSetMacro(InsideValue, ValueType);
  itkGetConstMacro(InsideValue, ValueType);

  itkSetMacro(OutsideValue, ValueType);
  itkGetConstMacro(OutsideValue, ValueType);

  virtual void
  SetOrigin(const PointType & origin);
 
  virtual void
  SetOrigin(const double * origin);
 
  virtual void
  SetOrigin(const float * origin);
 
  virtual const double *
  GetOrigin() const;
 
  virtual const PointType &
  GetOriginPoint() const;

  itkSetMacro(Index, IndexType);
  itkGetConstMacro(Index, IndexType);

  itkSetMacro(ChildrenDepth, unsigned int);
  itkGetConstMacro(ChildrenDepth, unsigned int);

  itkSetMacro(Size, SizeType);
  itkGetConstMacro(Size, SizeType);

  itkSetMacro(UseObjectValue, bool);
  itkGetConstMacro(UseObjectValue, bool);
  itkBooleanMacro(UseObjectValue);
 
protected:
  SpatialObjectToImageFilter();
  ~SpatialObjectToImageFilter() override = default;
 
  void
  GenerateOutputInformation() override
  {} // do nothing
  void
  GenerateData() override;
 
  IndexType     m_Index{};
  SizeType      m_Size{};
  double        m_Spacing[OutputImageDimension]{};
  double        m_Origin[OutputImageDimension]{};
  DirectionType m_Direction{};
 
  mutable SpacingType m_SpacingVector{};
  mutable PointType   m_OriginPoint{};
 
  unsigned int m_ChildrenDepth{};
 
  ValueType m_InsideValue{};
  ValueType m_OutsideValue{};
 
  bool m_UseObjectValue{};
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSpatialObjectToImageFilter.hxx"
#endif
 
#endif