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

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkNumericTraits.h"
#include "itkSimpleDataObjectDecorator.h"
#include "itkProgressReporter.h"

namespace itk
{

/**
 * \class HistogramThresholdCalculator
 * \brief Base class to compute a threshold value based on the histogram of an image
 *
 * \author Richard Beare. Department of Medicine, Monash University,
 * Melbourne, Australia.
 * \author Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
 *
 * This implementation was taken from the Insight Journal paper:
 * https://www.insight-journal.org/browse/publication/811
 *
 * \ingroup Operators
 * \ingroup ITKThresholding
 */
template <typename THistogram, typename TOutput>
class HistogramThresholdCalculator : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HistogramThresholdCalculator);

  /** Standard class type aliases. */
  using Self = HistogramThresholdCalculator;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

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

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(HistogramThresholdCalculator);

  /** Type definition for the input histogram. */
  using HistogramType = THistogram;

  /** output object type */
  using OutputType = TOutput;
  using DecoratedOutputType = SimpleDataObjectDecorator<OutputType>;

  void
  SetInput(const HistogramType * input)
  {
    // Process object is not const-correct so the const_cast is required here
    this->ProcessObject::SetNthInput(0, const_cast<HistogramType *>(input));
  }

  const HistogramType *
  GetInput() const
  {
    if (this->GetNumberOfInputs() < 1)
    {
      return nullptr;
    }
    return static_cast<const HistogramType *>(this->ProcessObject::GetInput(0));
  }

  DecoratedOutputType *
  GetOutput()
  {
    if (this->GetNumberOfOutputs() < 1)
    {
      return nullptr;
    }
    return static_cast<DecoratedOutputType *>(this->ProcessObject::GetOutput(0));
  }

  using Superclass::MakeOutput;
  typename DataObject::Pointer MakeOutput(DataObjectPointerArraySizeType) override
  {
    return DecoratedOutputType::New().GetPointer();
  }

  const OutputType &
  GetThreshold()
  {
    if (this->GetNumberOfOutputs() < 1)
    {
      itkExceptionMacro("No output available.");
    }
    return static_cast<DecoratedOutputType *>(this->ProcessObject::GetOutput(0))->Get();
  }

protected:
  HistogramThresholdCalculator()
  {
    this->ProcessObject::SetNumberOfRequiredOutputs(1);
    this->ProcessObject::SetNthOutput(0, this->MakeOutput(0));
  }
  ~HistogramThresholdCalculator() override = default;
  using ProcessObject::SetInput;
};

} // end namespace itk

#endif
