rtkFieldOfViewImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK Consortium
 *
 *  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 rtkFieldOfViewImageFilter_h
#define rtkFieldOfViewImageFilter_h

#include <itkInPlaceImageFilter.h>

#include "rtkThreeDCircularProjectionGeometry.h"
#include "rtkConfiguration.h"

struct _lprec;

namespace rtk
{

template <class TInputImage, class TOutputImage>
class ITK_TEMPLATE_EXPORT FieldOfViewImageFilter : public itk::InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FieldOfViewImageFilter);

  using Self = FieldOfViewImageFilter;
  using Superclass = itk::ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using OutputImageRegionType = typename TOutputImage::RegionType;
  using ProjectionsStackType = typename TInputImage::Superclass;
  using ProjectionsStackPointer = typename ProjectionsStackType::Pointer;
  using GeometryType = rtk::ThreeDCircularProjectionGeometry;
  using GeometryConstPointer = typename GeometryType::ConstPointer;
  using FOVRadiusType = enum { RADIUSINF, RADIUSSUP, RADIUSBOTH };


  itkNewMacro(Self);

#ifdef itkOverrideGetNameOfClassMacro
  itkOverrideGetNameOfClassMacro(FieldOfViewImageFilter);
#else
  itkTypeMacro(FieldOfViewImageFilter, InPlaceImageFilter);
#endif


  itkGetConstObjectMacro(Geometry, GeometryType);
  itkSetConstObjectMacro(Geometry, GeometryType);

  itkGetMacro(Mask, bool);
  itkSetMacro(Mask, bool);

  itkGetMacro(ProjectionsStack, ProjectionsStackPointer);
  itkSetObjectMacro(ProjectionsStack, ProjectionsStackType);

  itkGetMacro(DisplacedDetector, bool);
  itkSetMacro(DisplacedDetector, bool);

  itkGetMacro(InsideValue, double);
  itkSetMacro(InsideValue, double);

  itkGetMacro(OutsideValue, double);
  itkSetMacro(OutsideValue, double);

  virtual bool
  ComputeFOVRadius(const FOVRadiusType type, double & x, double & z, double & r);

  void
  AddCollimationConstraints(const FOVRadiusType type, _lprec * lp);

protected:
  FieldOfViewImageFilter();
  ~FieldOfViewImageFilter() override = default;

  void
  VerifyPreconditions() const override;

  void
  BeforeThreadedGenerateData() override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

private:
  GeometryConstPointer    m_Geometry{ nullptr };
  bool                    m_Mask{ false };
  ProjectionsStackPointer m_ProjectionsStack;
  double                  m_Radius{ -1 };
  double                  m_CenterX{ 0. };
  double                  m_CenterZ{ 0. };
  double                  m_HatTangentInf;
  double                  m_HatTangentSup;
  double                  m_HatHeightInf;
  double                  m_HatHeightSup;
  bool                    m_DisplacedDetector{ false };
  double                  m_InsideValue{ 1. };
  double                  m_OutsideValue{ 0. };
};

} // end namespace rtk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "rtkFieldOfViewImageFilter.hxx"
#endif

#endif