itkIsoContourDistanceImageFilter.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 itkIsoContourDistanceImageFilter_h
#define itkIsoContourDistanceImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkNarrowBand.h"
#include "itkNeighborhoodIterator.h"
#include "itkNumericTraits.h"
#include <mutex>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT IsoContourDistanceImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(IsoContourDistanceImageFilter);
 
  using Self = IsoContourDistanceImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(IsoContourDistanceImageFilter);
 
  using typename Superclass::InputImageType;
  using typename Superclass::OutputImageType;
 
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
 
  using PixelType = typename OutputImageType::PixelType;
  using InputPixelType = typename InputImageType::PixelType;
  using PixelRealType = typename NumericTraits<InputPixelType>::RealType;
 
  using OutputImageRegionType = typename OutputImageType::RegionType;
 
  using InputSizeType = typename InputImageType::SizeType;
  using SizeType = typename OutputImageType::SizeType;
 
  using InputIndexType = typename InputImageType::IndexType;
  using IndexType = typename OutputImageType::IndexType;
 
  using InputSpacingType = typename InputImageType::SpacingType;
 
  using BandNodeType = BandNode<IndexType, PixelType>;
  using NarrowBandType = NarrowBand<BandNodeType>;
  using NarrowBandPointer = typename NarrowBandType::Pointer;
  using RegionType = typename NarrowBandType::RegionType;
  using ConstBandIterator = typename NarrowBandType::ConstIterator;
  using BandIterator = typename NarrowBandType::Iterator;
 
  itkSetMacro(LevelSetValue, PixelRealType);
  itkGetConstMacro(LevelSetValue, PixelRealType);
  itkSetMacro(FarValue, PixelType);
  itkGetConstMacro(FarValue, PixelType);
  itkSetMacro(NarrowBanding, bool);
  itkGetConstMacro(NarrowBanding, bool);
  itkBooleanMacro(NarrowBanding);
  void
  SetNarrowBand(NarrowBandType * ptr);
 
  NarrowBandPointer
  GetNarrowBand() const
  {
    return m_NarrowBand;
  }
 
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(InputEqualityComparableCheck, (Concept::EqualityComparable<InputPixelType>));
  itkConceptMacro(OutputEqualityComparableCheck, (Concept::EqualityComparable<PixelType>));
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, PixelType>));
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputPixelType, PixelType>));
  itkConceptMacro(OutputAdditiveOperatorsCheck, (Concept::AdditiveOperators<PixelType>));
  itkConceptMacro(InputOStreamWritableCheck, (Concept::OStreamWritable<InputPixelType>));
  itkConceptMacro(OutputOStreamWritableCheck, (Concept::OStreamWritable<PixelType>));
  // End concept checking
#endif
 
protected:
  IsoContourDistanceImageFilter();
  ~IsoContourDistanceImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType &) override
  {
    itkExceptionMacro("This class requires threadId so it must use classic multi-threading model");
  }
 
  void
  GenerateData() override;
 
  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ThreaderFullCallback(void * arg);
 
  void
  ThreadedGenerateDataFull(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId);
 
  void
  ThreadedGenerateDataBand(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId);
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  GenerateInputRequestedRegion() override;
 
  void
  EnlargeOutputRequestedRegion(DataObject *) override;
 
  using InputNeighbordIteratorType = ConstNeighborhoodIterator<InputImageType>;
  using OutputNeighborhoodIteratorType = NeighborhoodIterator<OutputImageType>;
 
  void
  ComputeValue(const InputNeighbordIteratorType &   inNeigIt,
               OutputNeighborhoodIteratorType &     outNeigIt,
               unsigned int                         center,
               const std::vector<OffsetValueType> & stride);
 
private:
  PixelRealType m_LevelSetValue{};
  PixelType     m_FarValue{};
 
  InputSpacingType m_Spacing{};
 
  bool                    m_NarrowBanding{};
  NarrowBandPointer       m_NarrowBand{};
  std::vector<RegionType> m_NarrowBandRegion{};
 
  std::mutex m_Mutex{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkIsoContourDistanceImageFilter.hxx"
#endif
 
#endif