itkImageToHistogramFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkImageToHistogramFilter_h
#define itkImageToHistogramFilter_h

#include <mutex>

#include "itkHistogram.h"
#include "itkImageTransformer.h"
#include "itkSimpleDataObjectDecorator.h"
#include "itkProgressReporter.h"

namespace itk
{
namespace Statistics
{
template< typename TImage >
class ITK_TEMPLATE_EXPORT ImageToHistogramFilter:public ImageTransformer<TImage>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageToHistogramFilter);

  using Self = ImageToHistogramFilter;
  using Superclass = ImageTransformer<TImage>;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(ImageToHistogramFilter, ImageTransformer);

  itkNewMacro(Self);

  using ImageType = TImage;
  using PixelType = typename ImageType::PixelType;
  using RegionType = typename ImageType::RegionType;
  using ValueType = typename NumericTraits< PixelType >::ValueType;
  using ValueRealType = typename NumericTraits< ValueType >::RealType;

  using HistogramType = Histogram< ValueRealType >;
  using HistogramPointer = typename HistogramType::Pointer;
  using HistogramConstPointer = typename HistogramType::ConstPointer;
  using HistogramSizeType = typename HistogramType::SizeType;
  using HistogramMeasurementType = typename HistogramType::MeasurementType;
  using HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType;

public:

  const HistogramType * GetOutput() const;
  HistogramType * GetOutput();

  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 *output);

protected:
  ImageToHistogramFilter();
  ~ImageToHistogramFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void GenerateData() override;
  void BeforeThreadedGenerateData() override;
  void AfterThreadedGenerateData() override;

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObject::Pointer  MakeOutput(DataObjectPointerArraySizeType) override;

  virtual void ThreadedComputeHistogram(const RegionType &);
  virtual void ThreadedComputeMinimumAndMaximum( const RegionType & inputRegionForThread );


  virtual void ThreadedMergeHistogram( HistogramPointer &&histogram );

  std::mutex m_Mutex;

  HistogramPointer m_MergeHistogram;

  HistogramMeasurementVectorType m_Minimum;
  HistogramMeasurementVectorType m_Maximum;

private:
  void ApplyMarginalScale( HistogramMeasurementVectorType & min, HistogramMeasurementVectorType & max, HistogramSizeType & size );


};
} // end of namespace Statistics
} // end of namespace itk

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

#endif