itkStatisticsImageFilter.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 itkStatisticsImageFilter_h
#define itkStatisticsImageFilter_h
 
#include "itkImageSink.h"
#include "itkNumericTraits.h"
#include "itkArray.h"
#include "itkSimpleDataObjectDecorator.h"
#include <mutex>
#include "itkCompensatedSummation.h"
 
namespace itk
{
template <typename TInputImage>
class ITK_TEMPLATE_EXPORT StatisticsImageFilter : public ImageSink<TInputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StatisticsImageFilter);

  using Self = StatisticsImageFilter;
  using Superclass = ImageSink<TInputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(StatisticsImageFilter);

  using InputImagePointer = typename TInputImage::Pointer;
 
  using RegionType = typename TInputImage::RegionType;
  using SizeType = typename TInputImage::SizeType;
  using IndexType = typename TInputImage::IndexType;
  using PixelType = typename TInputImage::PixelType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using RealType = typename NumericTraits<PixelType>::RealType;

  using DataObjectPointer = DataObject::Pointer;

  using RealObjectType = SimpleDataObjectDecorator<RealType>;
  using PixelObjectType = SimpleDataObjectDecorator<PixelType>;

  itkGetDecoratedOutputMacro(Minimum, PixelType);

  itkGetDecoratedOutputMacro(Maximum, PixelType);

  itkGetDecoratedOutputMacro(Mean, RealType);

  itkGetDecoratedOutputMacro(Sigma, RealType);

  itkGetDecoratedOutputMacro(Variance, RealType);

  itkGetDecoratedOutputMacro(Sum, RealType);

  itkGetDecoratedOutputMacro(SumOfSquares, RealType);
 
  // Change the access from protected to public to expose streaming option, a using statement can not be used due to
  // limitations of wrapping.
  void
  SetNumberOfStreamDivisions(const unsigned int n) override
  {
    Superclass::SetNumberOfStreamDivisions(n);
  }
  [[nodiscard]] unsigned int
  GetNumberOfStreamDivisions() const override
  {
    return Superclass::GetNumberOfStreamDivisions();
  }

  using DataObjectIdentifierType = ProcessObject::DataObjectIdentifierType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(const DataObjectIdentifierType & name) override;
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<PixelType>));
 
protected:
  StatisticsImageFilter();
  ~StatisticsImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  BeforeStreamedGenerateData() override;

  void
  AfterStreamedGenerateData() override;
 
  void
  ThreadedStreamedGenerateData(const RegionType &) override;
 
  itkSetDecoratedOutputMacro(Minimum, PixelType);
  itkSetDecoratedOutputMacro(Maximum, PixelType);
  itkSetDecoratedOutputMacro(Mean, RealType);
  itkSetDecoratedOutputMacro(Sigma, RealType);
  itkSetDecoratedOutputMacro(Variance, RealType);
  itkSetDecoratedOutputMacro(Sum, RealType);
  itkSetDecoratedOutputMacro(SumOfSquares, RealType);
 
private:
  CompensatedSummation<RealType> m_ThreadSum{ 1 };
  CompensatedSummation<RealType> m_SumOfSquares{ 1 };
 
  SizeValueType m_Count{ 1 };
  PixelType     m_ThreadMin{ 1 };
  PixelType     m_ThreadMax{ 1 };
 
  std::mutex m_Mutex{};
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkStatisticsImageFilter.hxx"
#endif
 
#endif