/*=========================================================================
 *
 *  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 itkWatershedRelabeler_h
#define itkWatershedRelabeler_h

#include "itkWatershedSegmentTree.h"
#include "itkWatershedSegmenter.h"

namespace itk
{
namespace watershed
{
/**
 * \class Relabeler
 *
 * This filter implements the final step in the watershed segmentation
 * algorithm.  It is responsible for relabeling a segmented image according to
 * a specified saliency level (flood level) in a merge tree.  (See
 * itk::WatershedImageFilter for information on terminology used in this
 * documentation.)
 *
 * \par Inputs
 * There are two inputs to this filter.  The first input is a labeled image of
 * unsigned long integers, such as is produced by itk::watershed::Segmenter.
 * The second input is an itk::watershed::SegmentTree, which is the merge tree
 * data structure produced by the itk::watershed::SegmentTreeGenerator
 * filter.  The merge tree represents the hierarchy of merges among adjacent
 * segments in the initial segmentation image.
 *
 * \par Output
 * The output of this filter is a relabeled image of unsigned long integers of
 * dimension and size matching the input.
 *
 * \par Parameters
 * There is a single parameter FloodLevel for this filter.  FloodLevel is
 * given in percentage points (0.0 - 1.0) of the maximum saliency found in the
 * merge tree.  A FloodLevel of 0.0 will produce an output in which no
 * segments are relabeled (merged).  A FloodLevel of 1.0 will produce an
 * output in which all the entries in the merge tree are used to relabel the
 * image.  FloodLevel controls which level in the segmentation hierarchy to
 * produce on the output.
 *
 * \ingroup WatershedSegmentation
 * \sa itk::WatershedImageFilter
 * \sa itk::EquivalencyTable
 * \sa itk::watershed::SegmentTree
 * \ingroup ITKWatersheds
 */
template <typename TScalar, unsigned int TImageDimension>
class ITK_TEMPLATE_EXPORT Relabeler : public ProcessObject
{
public:
  /** Define smart pointers for this object */
  using Self = Relabeler;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);
  itkOverrideGetNameOfClassMacro(Relabeler);

  /** Expose the ImageDimension template parameter at run time */
  static constexpr unsigned int ImageDimension = TImageDimension;

  /** Some convenient type alias */
  using ScalarType = TScalar;
  using ImageType = Image<IdentifierType, TImageDimension>;
  using SegmentTreeType = SegmentTree<ScalarType>;
  using SegmenterType = Segmenter<Image<ScalarType, TImageDimension>>;
  using DataObjectPointer = DataObject::Pointer;

  /** Standard itk::ProcessObject subclass method. */
  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType idx) override;

  /** Set/Get the input image */
  void
  SetInputImage(ImageType * img)
  {
    this->ProcessObject::SetNthInput(0, img);
  }

  ImageType *
  GetInputImage()
  {
    return itkDynamicCastInDebugMode<ImageType *>(this->ProcessObject::GetInput(0));
  }

  /** Set/Get the output image */
  void
  SetOutputImage(ImageType * img)
  {
    this->ProcessObject::SetNthOutput(0, img);
  }

  ImageType *
  GetOutputImage()
  {
    return itkDynamicCastInDebugMode<ImageType *>(this->ProcessObject::GetOutput(0));
  }

  /** Set/Get the input tree that defines segment merges */
  void
  SetInputSegmentTree(SegmentTreeType * et)
  {
    this->ProcessObject::SetNthInput(1, et);
  }

  SegmentTreeType *
  GetInputSegmentTree()
  {
    return itkDynamicCastInDebugMode<SegmentTreeType *>(this->ProcessObject::GetInput(1));
  }

  /** Standard non-threaded pipeline method */
  void
  GenerateData() override;

  /** Set/Get the percentage of the maximum saliency level
   * to merge to. */
  itkSetClampMacro(FloodLevel, double, 0.0, 1.0);
  itkGetConstMacro(FloodLevel, double);

  /** Standard ProcessObject method used in implementing mini-pipelines */
  void
  GraftOutput(ImageType * graft);

  void
  GraftNthOutput(unsigned int idx, ImageType * graft);

protected:
  Relabeler();
  ~Relabeler() override = default;
  Relabeler(const Self &) {}
  void
  operator=(const Self &)
  {}
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  double m_FloodLevel{ 0.0 };
  void
  GenerateOutputRequestedRegion(DataObject * output) override;

  void
  GenerateInputRequestedRegion() override;
};
} // end namespace watershed
} // end namespace itk

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

#endif
