itkScalarImageToCooccurrenceMatrixFilter.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 itkScalarImageToCooccurrenceMatrixFilter_h
#define itkScalarImageToCooccurrenceMatrixFilter_h
 
#include "itkImage.h"
#include "itkHistogram.h"
#include "itkVectorContainer.h"
#include "itkNumericTraits.h"
#include "itkProcessObject.h"
 
namespace itk
{
namespace Statistics
{
 
template <typename TImageType,
          typename THistogramFrequencyContainer = DenseFrequencyContainer2,
          typename TMaskImageType = TImageType>
class ITK_TEMPLATE_EXPORT ScalarImageToCooccurrenceMatrixFilter : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScalarImageToCooccurrenceMatrixFilter);

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

  itkOverrideGetNameOfClassMacro(ScalarImageToCooccurrenceMatrixFilter);

  itkNewMacro(Self);
 
  using ImageType = TImageType;
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using PixelType = typename ImageType::PixelType;
  using RegionType = typename ImageType::RegionType;
  using RadiusType = typename ImageType::SizeType;
  using OffsetType = typename ImageType::OffsetType;
  using OffsetVector = VectorContainer<unsigned char, OffsetType>;
  using OffsetVectorPointer = typename OffsetVector::Pointer;
  using OffsetVectorConstPointer = typename OffsetVector::ConstPointer;
  using MaskImageType = TMaskImageType;
  using MaskPointer = typename MaskImageType::Pointer;
  using MaskConstPointer = typename MaskImageType::ConstPointer;
  using MaskPixelType = typename MaskImageType::PixelType;
 
  using MeasurementType = typename NumericTraits<PixelType>::RealType;
 
  using HistogramType = Histogram<MeasurementType, THistogramFrequencyContainer>;
  using HistogramPointer = typename HistogramType::Pointer;
  using HistogramConstPointer = typename HistogramType::ConstPointer;
  using MeasurementVectorType = typename HistogramType::MeasurementVectorType;
 
  static constexpr unsigned int DefaultBinsPerAxis = 256;

  itkSetConstObjectMacro(Offsets, OffsetVector);
  itkGetConstObjectMacro(Offsets, OffsetVector);
 
  void
  SetOffset(const OffsetType offset);

  itkSetMacro(NumberOfBinsPerAxis, unsigned int);
  itkGetConstMacro(NumberOfBinsPerAxis, unsigned int);

  void
  SetPixelValueMinMax(PixelType min, PixelType max);
 
  itkGetConstMacro(Min, PixelType);
  itkGetConstMacro(Max, PixelType);

  itkSetMacro(Normalize, bool);
  itkGetConstMacro(Normalize, bool);
  itkBooleanMacro(Normalize);

  using Superclass::SetInput;
  void
  SetInput(const ImageType * image);
 
  const ImageType *
  GetInput() const;

  void
  SetMaskImage(const MaskImageType * image);
 
  const MaskImageType *
  GetMaskImage() const;

  const HistogramType *
  GetOutput() const;

  itkSetMacro(InsidePixelValue, MaskPixelType);
  itkGetConstMacro(InsidePixelValue, MaskPixelType);
 
protected:
  ScalarImageToCooccurrenceMatrixFilter();
  ~ScalarImageToCooccurrenceMatrixFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  virtual void
  FillHistogram(RadiusType radius, RegionType region);
 
  virtual void
  FillHistogramWithMask(RadiusType radius, RegionType region, const MaskImageType * maskImage);

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

  void
  GenerateData() override;
 
private:
  void
  NormalizeHistogram();
 
  OffsetVectorConstPointer m_Offsets{};
  PixelType                m_Min{};
  PixelType                m_Max{};
 
  unsigned int          m_NumberOfBinsPerAxis{};
  MeasurementVectorType m_LowerBound{};
  MeasurementVectorType m_UpperBound{};
  bool                  m_Normalize{};
 
  MaskPixelType m_InsidePixelValue{};
};
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarImageToCooccurrenceMatrixFilter.hxx"
#endif
 
#endif