itkWatershedImageFilter.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 itkWatershedImageFilter_h
#define itkWatershedImageFilter_h
 
 
#include "itkImageToImageFilter.h"
#include "itkWatershedSegmentTreeGenerator.h"
#include "itkWatershedRelabeler.h"
#include "itkWatershedMiniPipelineProgressCommand.h"
 
namespace itk
{
template <typename TInputImage>
class ITK_TEMPLATE_EXPORT WatershedImageFilter
  : public ImageToImageFilter<TInputImage, Image<IdentifierType, TInputImage::ImageDimension>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(WatershedImageFilter);

  using Self = WatershedImageFilter;

  using InputImageType = TInputImage;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using OutputImageType = Image<IdentifierType, Self::ImageDimension>;

  using RegionType = typename InputImageType::RegionType;
  using SizeType = typename InputImageType::SizeType;
  using IndexType = typename InputImageType::IndexType;

  using Superclass = ImageToImageFilter<InputImageType, OutputImageType>;

  using ScalarType = typename InputImageType::PixelType;

  using Pointer = SmartPointer<Self>;

  itkOverrideGetNameOfClassMacro(WatershedImageFilter);

  itkNewMacro(Self);

  void
  GenerateData() override;

  using Superclass::SetInput;
  void
  SetInput(const InputImageType * input) override
  {
    // if the input is changed, we'll need to clear the cached tree
    // when we execute
    if (input != this->GetInput(0))
    {
      m_InputChanged = true;
    }
 
    // processObject is not const-correct so a const_cast is needed here
    this->ProcessObject::SetNthInput(0, const_cast<InputImageType *>(input));
    m_Segmenter->SetInputImage(const_cast<InputImageType *>(input));
  }
 
  void
  SetInput(unsigned int i, const TInputImage * image) override
  {
    if (i != 0)
    {
      itkExceptionMacro("Filter has only one input.");
    }
    else
    {
      this->SetInput(image);
    }
  }

  void
  SetThreshold(double);
 
  itkGetConstMacro(Threshold, double);

  void
  SetLevel(double);
 
  itkGetConstMacro(Level, double);

  typename watershed::Segmenter<InputImageType>::OutputImageType *
  GetBasicSegmentation()
  {
    m_Segmenter->Update();
    return m_Segmenter->GetOutputImage();
  }

  typename watershed::SegmentTreeGenerator<ScalarType>::SegmentTreeType *
  GetSegmentTree()
  {
    return m_TreeGenerator->GetOutputSegmentTree();
  }
 
  // Override since the filter produces all of its output
  void
  EnlargeOutputRequestedRegion(DataObject * data) override;
 
  itkConceptMacro(InputEqualityComparableCheck, (Concept::EqualityComparable<ScalarType>));
  itkConceptMacro(InputAdditiveOperatorsCheck, (Concept::AdditiveOperators<ScalarType>));
  itkConceptMacro(DoubleInputMultiplyOperatorCheck, (Concept::MultiplyOperator<double, ScalarType, ScalarType>));
  itkConceptMacro(InputLessThanComparableCheck, (Concept::LessThanComparable<ScalarType>));
 
protected:
  WatershedImageFilter();
  ~WatershedImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  PrepareOutputs() override;
 
private:
  double m_Threshold{ 0.0 };

  double m_Level{ 0.0 };

  typename watershed::Segmenter<InputImageType>::Pointer m_Segmenter{};
 
  typename watershed::SegmentTreeGenerator<ScalarType>::Pointer m_TreeGenerator{};
 
  typename watershed::Relabeler<ScalarType, Self::ImageDimension>::Pointer m_Relabeler{};
 
  unsigned long m_ObserverTag{};
 
  bool m_LevelChanged{};
  bool m_ThresholdChanged{};
  bool m_InputChanged{};
 
  TimeStamp m_GenerateDataMTime{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkWatershedImageFilter.hxx"
#endif
 
#endif