itkScalarImageToHistogramGenerator.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 itkScalarImageToHistogramGenerator_h
#define itkScalarImageToHistogramGenerator_h
 
#include "itkImageToListSampleAdaptor.h"
#include "itkSampleToHistogramFilter.h"
#include "itkHistogram.h"
#include "itkObject.h"
 
namespace itk
{
namespace Statistics
{
template <typename TImageType>
class ITK_TEMPLATE_EXPORT ScalarImageToHistogramGenerator : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScalarImageToHistogramGenerator);

  using Self = ScalarImageToHistogramGenerator;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ScalarImageToHistogramGenerator);

  itkNewMacro(Self);
 
  using ImageType = TImageType;
  using AdaptorType = itk::Statistics::ImageToListSampleAdaptor<ImageType>;
  using AdaptorPointer = typename AdaptorType::Pointer;
  using PixelType = typename ImageType::PixelType;
  using RealPixelType = typename NumericTraits<PixelType>::RealType;
 
  using HistogramType = itk::Statistics::Histogram<double>;
  using GeneratorType = itk::Statistics::SampleToHistogramFilter<AdaptorType, HistogramType>;
 
  using GeneratorPointer = typename GeneratorType::Pointer;
 
  using HistogramPointer = typename HistogramType::Pointer;
  using HistogramConstPointer = typename HistogramType::ConstPointer;
 
public:
  void
  Compute();

  void
  SetInput(const ImageType *);

  const HistogramType *
  GetOutput() const;

  void
  SetNumberOfBins(unsigned int numberOfBins);

  void
  SetMarginalScale(double marginalScale);

  void
  SetHistogramMin(RealPixelType minimumValue);

  void
  SetHistogramMax(RealPixelType maximumValue);

  void
  SetAutoHistogramMinimumMaximum(bool autoOnOff);
 
protected:
  ScalarImageToHistogramGenerator();
  ~ScalarImageToHistogramGenerator() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  AdaptorPointer m_ImageToListSampleAdaptor{};
 
  GeneratorPointer m_HistogramGenerator{};
};
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarImageToHistogramGenerator.hxx"
#endif
 
#endif