ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer > Class Template Reference

#include <itkScalarImageToRunLengthMatrixFilter.h>

Detailed Description

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>
class itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >

This class computes a run length matrix (histogram) from a given image and a mask image if provided. Run length matrices are used for image texture description.

This filters creates a grey-level run length matrix from a N-D scalar image. This is another possible texture description. See the following references. M. M. Galloway. Texture analysis using gray level run lengths. Computer Graphics and Image Processing, 4:172-179, 1975.

A. Chu, C. M. Sehgal, and J. F. Greenleaf. Use of gray value distribution of run lengths for texture analysis. Pattern Recognition Letters, 11:415-420, 1990.

B. R. Dasarathy and E. B. Holder. Image characterizations based on joint gray-level run-length distributions. Pattern Recognition Letters, 12:490-502, 1991.

The basic idea is as follows: Given an image and an offset (e.g. (1, -1) for a 2-d image), each element in the joint histogram describes the frequency for a particular distance/ intensity pair within a given image. This distance/intensity pair can be described as follows: we start at a given voxel which has some intensity. We then "jump" to neighboring pixels in increments provided by the offset(s) as long as the pixel to which we are jumping is within the same intensity bin as the original voxel. The distance component is given by the distance from the original to the final voxel satisfying our jumping criteria.

The offset (or offsets) along which the co-occurrences are calculated can be set by the user. Traditionally, only one offset is used per histogram, and offset components in the range [-1, 1] are used. For rotation-invariant features averages of features computed over several histograms with different offsets are generally used, instead of computing features from one histogram create with several offsets. Additionally, instead of using offsets of two or more pixels in any direction, multi-resolution techniques (e.g. image pyramids) are generally used to deal with texture at different spatial resolutions.

This class calculates a 2-d histogram of all the intensity/distance pairs in the given image's requested region, for a given set of offsets. That is, if a given offset falls outside of the requested region (or outside the mask) at a particular point, that distance/intensity pair will not be added to the matrix.

The number of histogram bins on each axis can be set (defaults to 256). Also, by default the histogram min and max corresponds to the largest and smallest possible pixel value of that pixel type. To customize the histogram bounds for a given image, the max and min pixel values that will be placed in the histogram can be set manually. NB: The min and max are INCLUSIVE.

Further, the type of histogram frequency container used is an optional template parameter. By default, a dense container is used, but for images with little texture or in cases where the user wants more histogram bins, a sparse container can be used for the histogram instead.

WARNING: This probably won't work for pixels of double or long-double type unless you set the histogram min and max manually. This is because the largest histogram bin by default has max value of the largest possible pixel value plus 1. For double and long-double types, whose "RealType" as defined by the NumericTraits class is the same, and thus cannot hold any larger values, this would cause a float overflow.

IJ article: https://doi.org/10.54294/ex0itu

See also
ScalarImageToRunLengthFeaturesFilter
HistogramToRunLengthFeaturesFilter
Author
: Nick Tustison

Definition at line 106 of file itkScalarImageToRunLengthMatrixFilter.h.

+ Inheritance diagram for itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >:
+ Collaboration diagram for itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using HistogramConstPointer = typename HistogramType::ConstPointer
 
using HistogramPointer = typename HistogramType::Pointer
 
using HistogramType = Histogram< MeasurementType, THistogramFrequencyContainer >
 
using ImageConstPointer = typename ImageType::ConstPointer
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = TImageType
 
using IndexType = typename ImageType::IndexType
 
using MeasurementType = typename NumericTraits< PixelType >::RealType
 
using MeasurementVectorType = typename HistogramType::MeasurementVectorType
 
using OffsetType = typename ImageType::OffsetType
 
using OffsetVector = VectorContainer< unsigned char, OffsetType >
 
using OffsetVectorPointer = typename OffsetVector::Pointer
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename ImageType::PointType
 
using RadiusType = typename ImageType::SizeType
 
using RealType = typename NumericTraits< PixelType >::RealType
 
using RegionType = typename ImageType::RegionType
 
using Self = ScalarImageToRunLengthMatrixFilter
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const ImageTypeGetInput () const
 
const ImageTypeGetMaskImage () const
 
virtual PixelType GetMax () const
 
virtual RealType GetMaxDistance () const
 
virtual PixelType GetMin () const
 
virtual RealType GetMinDistance () const
 
virtual OffsetVectorGetModifiableOffsets ()
 
const char * GetNameOfClass () const override
 
virtual unsigned int GetNumberOfBinsPerAxis () const
 
const HistogramTypeGetOutput () const
 
void SetDistanceValueMinMax (RealType min, RealType max)
 
void SetInput (const ImageType *image)
 
void SetMaskImage (const ImageType *image)
 
virtual void SetNumberOfBinsPerAxis (unsigned int _arg)
 
void SetOffset (const OffsetType offset)
 
virtual void SetOffsets (OffsetVector *_arg)
 
void SetPixelValueMinMax (PixelType min, PixelType max)
 
virtual void SetInsidePixelValue (PixelType _arg)
 
virtual PixelType GetInsidePixelValue () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int DefaultBinsPerAxis = 256
 
static constexpr unsigned int ImageDimension = TImageType::ImageDimension
 

Protected Types

using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 

Protected Member Functions

void GenerateData () override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void NormalizeOffsetDirection (OffsetType &offset)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ScalarImageToRunLengthMatrixFilter ()
 
 ~ScalarImageToRunLengthMatrixFilter () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

PixelType m_InsidePixelValue {}
 
MeasurementVectorType m_LowerBound {}
 
PixelType m_Max {}
 
RealType m_MaxDistance {}
 
PixelType m_Min {}
 
RealType m_MinDistance {}
 
unsigned int m_NumberOfBinsPerAxis {}
 
OffsetVectorPointer m_Offsets {}
 
MeasurementVectorType m_UpperBound {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::ConstPointer = SmartPointer<const Self>

Definition at line 113 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ DataObjectPointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::DataObjectPointer = DataObject::Pointer
protected

Standard itk::ProcessObject subclass method.

Definition at line 247 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
protected

Definition at line 249 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ HistogramConstPointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::HistogramConstPointer = typename HistogramType::ConstPointer

Definition at line 138 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ HistogramPointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::HistogramPointer = typename HistogramType::Pointer

Definition at line 137 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ HistogramType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::HistogramType = Histogram<MeasurementType, THistogramFrequencyContainer>

Definition at line 136 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ ImageConstPointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::ImageConstPointer = typename ImageType::ConstPointer

Definition at line 123 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ ImagePointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::ImagePointer = typename ImageType::Pointer

Definition at line 122 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ ImageType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::ImageType = TImageType

Definition at line 121 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ IndexType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::IndexType = typename ImageType::IndexType

Definition at line 125 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ MeasurementType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::MeasurementType = typename NumericTraits<PixelType>::RealType

Definition at line 133 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ MeasurementVectorType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::MeasurementVectorType = typename HistogramType::MeasurementVectorType

Definition at line 139 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ OffsetType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::OffsetType = typename ImageType::OffsetType

Definition at line 128 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ OffsetVector

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::OffsetVector = VectorContainer<unsigned char, OffsetType>

Definition at line 129 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ OffsetVectorPointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::OffsetVectorPointer = typename OffsetVector::Pointer

Definition at line 130 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ PixelType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::PixelType = typename ImageType::PixelType

Definition at line 124 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ Pointer

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::Pointer = SmartPointer<Self>

Definition at line 112 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ PointType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::PointType = typename ImageType::PointType

Definition at line 131 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ RadiusType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::RadiusType = typename ImageType::SizeType

Definition at line 127 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ RealType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::RealType = typename NumericTraits<PixelType>::RealType

Definition at line 134 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ RegionType

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::RegionType = typename ImageType::RegionType

Definition at line 126 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ Self

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::Self = ScalarImageToRunLengthMatrixFilter

Standard type alias

Definition at line 110 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ Superclass

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
using itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::Superclass = ProcessObject

Definition at line 111 of file itkScalarImageToRunLengthMatrixFilter.h.

Constructor & Destructor Documentation

◆ ScalarImageToRunLengthMatrixFilter()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::ScalarImageToRunLengthMatrixFilter ( )
protected

◆ ~ScalarImageToRunLengthMatrixFilter()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::~ScalarImageToRunLengthMatrixFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GetInput()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
const ImageType * itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetInput ( ) const

Method to get the input image

◆ GetInsidePixelValue()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual PixelType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetInsidePixelValue ( ) const
virtual

Set the pixel value of the mask that should be considered "inside" the object. Defaults to 1.

◆ GetMaskImage()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
const ImageType * itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetMaskImage ( ) const

Method to get the mask image

◆ GetMax()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual PixelType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetMax ( ) const
virtual

Get the max pixel value defining one dimension of the joint histogram.

◆ GetMaxDistance()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual RealType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetMaxDistance ( ) const
virtual

Get the max distance value defining one dimension of the joint histogram.

◆ GetMin()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual PixelType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetMin ( ) const
virtual

Get the min pixel value defining one dimension of the joint histogram.

◆ GetMinDistance()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual RealType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetMinDistance ( ) const
virtual

Get the min distance value defining one dimension of the joint histogram.

◆ GetModifiableOffsets()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual OffsetVector * itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetModifiableOffsets ( )
virtual

Get the current offset(s).

◆ GetNameOfClass()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
const char * itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetNameOfClass ( ) const
overridevirtual

◆ GetNumberOfBinsPerAxis()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual unsigned int itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetNumberOfBinsPerAxis ( ) const
virtual

Get number of histogram bins along each axis

◆ GetOutput()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
const HistogramType * itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::GetOutput ( ) const

method to get the Histogram

◆ MakeOutput()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
DataObjectPointer itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
static Pointer itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::New ( )
static

standard New() method support

◆ NormalizeOffsetDirection()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::NormalizeOffsetDirection ( OffsetType offset)
protected

Normalize the direction of the offset before it is applied. The last non-zero dimension of the offset has to be positive in order to match to scanning order of the iterator. Only the sign is changed. For example, the input offset (-1, 0) will be normalized as (1, 0).

◆ PrintSelf()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ SetDistanceValueMinMax()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetDistanceValueMinMax ( RealType  min,
RealType  max 
)

Set the min and max (inclusive) pixel value that will be used in generating the histogram.

◆ SetInput()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetInput ( const ImageType image)

◆ SetInsidePixelValue()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetInsidePixelValue ( PixelType  _arg)
virtual

Set the pixel value of the mask that should be considered "inside" the object. Defaults to 1.

◆ SetMaskImage()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetMaskImage ( const ImageType image)

Method to set the mask image

◆ SetNumberOfBinsPerAxis()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetNumberOfBinsPerAxis ( unsigned int  _arg)
virtual

Set number of histogram bins along each axis

◆ SetOffset()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetOffset ( const OffsetType  offset)

Set offset over which the intensity/distance pairs will be computed. Invoking this function clears the previous offset(s). Note: for each individual offset, the rightmost non-zero offset element must be positive. For example, in the offset list of a 2D image, (1, 0) means the offset along x-axis. (1, 0) has to be set instead of (-1, 0). This is required from the iterating order of pixel iterator.

◆ SetOffsets()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
virtual void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetOffsets ( OffsetVector _arg)
virtual

Set the offsets over which the intensity/distance pairs will be computed. Invoking this function clears the previous offsets. Note: for each individual offset in the OffsetVector, the rightmost non-zero offset element must be positive. For example, in the offset list of a 2D image, (1, 0) means the offset along x-axis. (1, 0) has to be set instead of (-1, 0). This is required from the iterating order of pixel iterator.

◆ SetPixelValueMinMax()

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
void itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::SetPixelValueMinMax ( PixelType  min,
PixelType  max 
)

Set the min and max (inclusive) pixel value that will be used in generating the histogram.

Member Data Documentation

◆ DefaultBinsPerAxis

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
constexpr unsigned int itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::DefaultBinsPerAxis = 256
staticconstexpr

Specify the default number of bins per axis

Definition at line 145 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ ImageDimension

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
constexpr unsigned int itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::ImageDimension = TImageType::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 142 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_InsidePixelValue

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
PixelType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_InsidePixelValue {}
private

Definition at line 274 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_LowerBound

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
MeasurementVectorType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_LowerBound {}
private

Definition at line 276 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_Max

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
PixelType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_Max {}
private

Definition at line 271 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_MaxDistance

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
RealType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_MaxDistance {}
private

Definition at line 273 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_Min

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
PixelType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_Min {}
private

Definition at line 270 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_MinDistance

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
RealType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_MinDistance {}
private

Definition at line 272 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_NumberOfBinsPerAxis

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
unsigned int itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_NumberOfBinsPerAxis {}
private

Definition at line 269 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_Offsets

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
OffsetVectorPointer itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_Offsets {}
private

Definition at line 278 of file itkScalarImageToRunLengthMatrixFilter.h.

◆ m_UpperBound

template<typename TImageType , typename THistogramFrequencyContainer = DenseFrequencyContainer2>
MeasurementVectorType itk::Statistics::ScalarImageToRunLengthMatrixFilter< TImageType, THistogramFrequencyContainer >::m_UpperBound {}
private

Definition at line 277 of file itkScalarImageToRunLengthMatrixFilter.h.


The documentation for this class was generated from the following file: