itkSampleToHistogramFilter.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 itkSampleToHistogramFilter_h
#define itkSampleToHistogramFilter_h
 
#include "itkMacro.h"
#include "itkProcessObject.h"
#include "itkMeasurementVectorTraits.h"
#include "itkSimpleDataObjectDecorator.h"
 
itkDeclareExceptionMacro(SampleToHistogramFilterException, ExceptionObject, "Histogram-related Exception");
itkDeclareExceptionMacro(MissingHistogramSizeInput,
                         SampleToHistogramFilterException,
                         "Histogram Size input is missing");
itkDeclareExceptionMacro(MissingHistogramMarginalScaleInput,
                         SampleToHistogramFilterException,
                         "Histogram marginal scale input is missing");
itkDeclareExceptionMacro(NullSizeHistogramInputMeasurementVectorSize,
                         SampleToHistogramFilterException,
                         "Input sample MeasurementVectorSize is zero");
itkDeclareExceptionMacro(MissingHistogramBinMaximumInput,
                         SampleToHistogramFilterException,
                         "Histogram Bin Maximum input is missing");
itkDeclareExceptionMacro(MissingHistogramBinMinimumInput,
                         SampleToHistogramFilterException,
                         "Histogram Bin Minimum input is missing");
itkDeclareExceptionMacro(HistogramWrongNumberOfComponents,
                         SampleToHistogramFilterException,
                         "Histogram has wrong number of components");
 
namespace itk
{
namespace Statistics
{

 
template <typename TSample, typename THistogram>
class ITK_TEMPLATE_EXPORT SampleToHistogramFilter : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SampleToHistogramFilter);

  using Self = SampleToHistogramFilter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(SampleToHistogramFilter);

  itkNewMacro(Self);

  using SampleType = TSample;
  using HistogramType = THistogram;
  using MeasurementVectorType = typename SampleType::MeasurementVectorType;
  using MeasurementType = typename MeasurementVectorType::ValueType;
  using HistogramSizeType = typename HistogramType::SizeType;
  using HistogramMeasurementType = typename HistogramType::MeasurementType;
  using HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType;

  using typename Superclass::DataObjectPointer;
 
  using Superclass::SetInput;

  virtual void
  SetInput(const SampleType * sample);
 
  virtual const SampleType *
  GetInput() const;

  const HistogramType *
  GetOutput() const;

  using InputHistogramSizeObjectType = SimpleDataObjectDecorator<HistogramSizeType>;

  using InputHistogramMeasurementObjectType = SimpleDataObjectDecorator<HistogramMeasurementType>;

  using InputHistogramMeasurementVectorObjectType = SimpleDataObjectDecorator<HistogramMeasurementVectorType>;

  using InputBooleanObjectType = SimpleDataObjectDecorator<bool>;

  itkSetGetDecoratedInputMacro(HistogramSize, HistogramSizeType);

  itkSetGetDecoratedInputMacro(MarginalScale, HistogramMeasurementType);

  itkSetGetDecoratedInputMacro(HistogramBinMinimum, HistogramMeasurementVectorType);
  itkSetGetDecoratedInputMacro(HistogramBinMaximum, HistogramMeasurementVectorType);

  itkSetGetDecoratedInputMacro(AutoMinimumMaximum, bool);

  virtual void
  GraftOutput(DataObject * graft);
 
protected:
  SampleToHistogramFilter();
  ~SampleToHistogramFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType idx) override;
 
  // Where the histogram is actually computed
  void
  GenerateData() override;
 
private:
  HistogramMeasurementType
  SafeAssign(MeasurementType from) const
  {
    if (NumericTraits<HistogramMeasurementType>::is_integer)
    {
      auto fromMax = static_cast<MeasurementType>(NumericTraits<HistogramMeasurementType>::max());
      auto fromMin = static_cast<MeasurementType>(NumericTraits<HistogramMeasurementType>::min());
 
      if (from >= fromMax)
      {
        return NumericTraits<HistogramMeasurementType>::max();
      }
      if (from <= fromMin)
      {
        return NumericTraits<HistogramMeasurementType>::min();
      }
    }
    return static_cast<HistogramMeasurementType>(from);
  }
 
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSampleToHistogramFilter.hxx"
#endif
 
#endif