itkHistogramToImageFilter.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 itkHistogramToImageFilter_h
#define itkHistogramToImageFilter_h
 
#include "itkImageSource.h"
#include "itkConceptChecking.h"
#include "itkHistogram.h"
#include "itkImageRegionIteratorWithIndex.h"
#include "itkSimpleDataObjectDecorator.h"
 
namespace itk
{
 
template <typename THistogram, typename TImage, typename TFunction>
class ITK_TEMPLATE_EXPORT HistogramToImageFilter : public ImageSource<TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HistogramToImageFilter);

  using FunctorType = TFunction;
  using Self = HistogramToImageFilter;
  using Superclass = ImageSource<TImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using OutputImageType = TImage;
  using OutputImagePointer = typename Superclass::Pointer;
  using SpacingType = typename OutputImageType::SpacingType;
  using PointType = typename OutputImageType::PointType;
  using OutputPixelType = typename OutputImageType::PixelType;
 
  // Define an iterator to iterate through the image
  using ImageIteratorType = itk::ImageRegionIteratorWithIndex<OutputImageType>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(HistogramToImageFilter);

  using typename Superclass::OutputImageRegionType;

  using HistogramType = THistogram;
  using MeasurementVectorType = typename HistogramType::MeasurementVectorType;
  using HistogramSizeType = typename HistogramType::SizeType;
  using SizeType = typename OutputImageType::SizeType;

  static constexpr unsigned int ImageDimension = OutputImageType::ImageDimension;

  using Superclass::SetInput;
  virtual void
  SetInput(const HistogramType * input);
 
  const HistogramType *
  GetInput();

  void
  SetFunctor(const FunctorType & functor)
  {
    m_Functor = functor;
    this->Modified();
  }


  FunctorType &
  GetFunctor()
  {
    return m_Functor;
  }
  const FunctorType &
  GetFunctor() const
  {
    return m_Functor;
  }

 
  void
  SetTotalFrequency(SizeValueType n);
 
protected:
  HistogramToImageFilter();
  ~HistogramToImageFilter() override = default;
 
  void
  GenerateOutputInformation() override;
 
  void
  GenerateData() override;
 
  FunctorType m_Functor{};
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHistogramToImageFilter.hxx"
#endif
 
#endif