#include <itkScalarImageToRunLengthFeaturesFilter.h>

Inheritance diagram for itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >:

Collaboration diagram for itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectPointer = DataObject::Pointer

using	FeatureNameVector = VectorContainer< unsigned char, RunLengthFeatureName >

using	FeatureNameVectorConstPointer = typename FeatureNameVector::ConstPointer

using	FeatureNameVectorPointer = typename FeatureNameVector::Pointer

using	FeatureValueVector = VectorContainer< unsigned char, double >

using	FeatureValueVectorDataObjectType = DataObjectDecorator< FeatureValueVector >

using	FeatureValueVectorPointer = typename FeatureValueVector::Pointer

using	FrequencyContainerType = THistogramFrequencyContainer

using	HistogramType = typename RunLengthMatrixFilterType::HistogramType

using	ImagePointer = typename ImageType::Pointer

using	ImageType = TImageType

using	OffsetType = typename ImageType::OffsetType

using	OffsetVector = VectorContainer< unsigned char, OffsetType >

using	OffsetVectorConstPointer = typename OffsetVector::ConstPointer

using	OffsetVectorPointer = typename OffsetVector::Pointer

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RunLengthFeatureName = uint8_t

using	RunLengthFeaturesFilterType = HistogramToRunLengthFeaturesFilter< HistogramType >

using	RunLengthMatrixFilterType = ScalarImageToRunLengthMatrixFilter< ImageType, FrequencyContainerType >

using	Self = ScalarImageToRunLengthFeaturesFilter

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

const FeatureValueVectorDataObjectType *	GetFeatureMeansOutput () const

const FeatureValueVectorDataObjectType *	GetFeatureStandardDeviationsOutput () const

const ImageType *	GetInput () const

virtual const char *	GetNameOfClass () const

void	SetInput (const ImageType *)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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 void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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)

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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

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 ()

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

RunLengthMatrixFilterType::Pointer	m_RunLengthMatrixGenerator

FeatureValueVectorPointer	m_FeatureMeans

FeatureValueVectorPointer	m_FeatureStandardDeviations

FeatureNameVectorConstPointer	m_RequestedFeatures

OffsetVectorConstPointer	m_Offsets

bool	m_FastCalculations

virtual const FeatureValueVector ::Pointer &	GetFeatureMeans () const

virtual const FeatureValueVector ::Pointer &	GetFeatureStandardDeviations () const

virtual void	SetRequestedFeatures (const FeatureNameVector *_arg)

virtual const FeatureNameVector *	GetRequestedFeatures () const

virtual void	SetOffsets (const OffsetVector *_arg)

virtual const OffsetVector *	GetOffsets () const

void	SetNumberOfBinsPerAxis (unsigned int)

void	SetPixelValueMinMax (PixelType min, PixelType max)

void	SetDistanceValueMinMax (double min, double max)

void	SetMaskImage (const ImageType *)

const ImageType *	GetMaskImage () const

void	SetInsidePixelValue (PixelType insidePixelValue)

virtual bool	GetFastCalculations () const

virtual void	SetFastCalculations (bool _arg)

virtual void	FastCalculationsOn ()

virtual void	FastCalculationsOff ()

	ScalarImageToRunLengthFeaturesFilter ()

	~ScalarImageToRunLengthFeaturesFilter () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

void	FastCompute ()

void	FullCompute ()

void	GenerateData () override

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType) override

Additional Inherited Members
Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

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

This class computes run length descriptions from an image.

By default, run length features are computed for each spatial direction and then averaged afterward, so it is possible to access the standard deviations of the texture features. These values give a clue as to texture anisotropy. However, doing this is much more work, because it involved computing one for each offset given. To compute a single matrix using the first offset, call FastCalculationsOn(). If this is called, then the texture standard deviations will not be computed (and will be set to zero), but texture computation will be much faster.

This class is templated over the input image type.

Template Parameters: The image type, and the type of histogram frequency container. If you are using a large number of bins per axis, a sparse frequency container may be advisable. The default is to use a dense frequency container.

Inputs and parameters:

An image
A mask defining the region over which texture features will be calculated. (Optional)
The pixel value that defines the "inside" of the mask. (Optional, defaults to 1 if a mask is set.)
The set of features to be calculated. These features are defined in the HistogramToRunLengthFeaturesFilter class.
The number of intensity bins. (Optional, defaults to 256.)
The set of directions (offsets) to average across. (Optional, defaults to {(-1, 0), (-1, -1), (0, -1), (1, -1)} for 2D images and scales analogously for ND images.)
The pixel intensity range over which the features will be calculated. (Optional, defaults to the full dynamic range of the pixel type.)
The distance range over which the features will be calculated. (Optional, defaults to the full dynamic range of double type.)

In general, the default parameter values should be sufficient.

Outputs: (1) The average value of each feature. (2) The standard deviation in the values of each feature.

Print 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.

IJ article: https://www.insight-journal.org/browse/publication/231

See also: ScalarImageToRunLengthFeaturesFilter; ScalarImageToRunLengthMatrixFilter; HistogramToRunLengthFeaturesFilter

Author: : Nick Tustison

Definition at line 96 of file itkScalarImageToRunLengthFeaturesFilter.h.