itkScalarImageToRunLengthMatrixFilter.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 itkScalarImageToRunLengthMatrixFilter_h
#define itkScalarImageToRunLengthMatrixFilter_h

#include "itkImage.h"
#include "itkHistogram.h"
#include "itkNumericTraits.h"
#include "itkVectorContainer.h"
#include "itkProcessObject.h"

namespace itk
{
namespace Statistics
{

template<typename TImageType, typename THistogramFrequencyContainer =
  DenseFrequencyContainer2>
class ITK_TEMPLATE_EXPORT ScalarImageToRunLengthMatrixFilter : public ProcessObject
{
public:
  using Self = ScalarImageToRunLengthMatrixFilter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro( ScalarImageToRunLengthMatrixFilter, ProcessObject );

  itkNewMacro( Self );

  using ImageType = TImageType;
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using PixelType = typename ImageType::PixelType;
  using IndexType = typename ImageType::IndexType;
  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 PointType = typename ImageType::PointType;

  using MeasurementType = typename NumericTraits<PixelType>::RealType;
  using RealType = 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 ImageDimension = TImageType::ImageDimension;

  static constexpr unsigned int DefaultBinsPerAxis = 256;

  itkSetObjectMacro( Offsets, OffsetVector );

  void SetOffset( const OffsetType offset );

  itkGetModifiableObjectMacro(Offsets, OffsetVector );

  itkSetMacro( NumberOfBinsPerAxis, unsigned int );

  itkGetConstMacro( NumberOfBinsPerAxis, unsigned int );

  void SetPixelValueMinMax( PixelType min, PixelType max );

  itkGetConstMacro( Min, PixelType );

  itkGetConstMacro( Max, PixelType );

  void SetDistanceValueMinMax( RealType min, RealType max );

  itkGetConstMacro( MinDistance, RealType );

  itkGetConstMacro( MaxDistance, RealType );

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

  const ImageType * GetInput() const;

  void SetMaskImage( const ImageType *image );

  const ImageType * GetMaskImage() const;

  const HistogramType * GetOutput() const;

  itkSetMacro( InsidePixelValue, PixelType );
  itkGetConstMacro( InsidePixelValue, PixelType );

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

  using DataObjectPointer = DataObject::Pointer;

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

  void GenerateData() override;

  void NormalizeOffsetDirection(OffsetType &offset);

private:

  unsigned int             m_NumberOfBinsPerAxis;
  PixelType                m_Min;
  PixelType                m_Max;
  RealType                 m_MinDistance;
  RealType                 m_MaxDistance;
  PixelType                m_InsidePixelValue;

  MeasurementVectorType    m_LowerBound;
  MeasurementVectorType    m_UpperBound;
  OffsetVectorPointer      m_Offsets;

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

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

#endif