#include <itkScalarImageToRunLengthFeaturesFilter.h>

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.

For algorithmic details see [39], [24] and [29].

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

See also: ScalarImageToRunLengthMatrixFilter; HistogramToRunLengthFeaturesFilter

Author: : Nick Tustison

Definition at line 86 of file 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

virtual void	FastCalculationsOff ()

virtual void	FastCalculationsOn ()

virtual bool	GetFastCalculations () const

const FeatureValueVectorDataObjectType *	GetFeatureMeansOutput () const

const FeatureValueVectorDataObjectType *	GetFeatureStandardDeviationsOutput () const

const ImageType *	GetInput () const

const ImageType *	GetMaskImage () const

const char *	GetNameOfClass () const override

virtual void	SetFastCalculations (bool _arg)

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

void	SetInput (const ImageType *)

void	SetInsidePixelValue (PixelType insidePixelValue)

void	SetMaskImage (const ImageType *)

void	SetNumberOfBinsPerAxis (unsigned int)


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	SetPixelValueMinMax (PixelType min, PixelType max)


void	SetDistanceValueMinMax (double min, double max)

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () 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

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

Protected Types
using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Protected Member Functions
void	FastCompute ()

void	FullCompute ()

void	GenerateData () override

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType) override

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

	ScalarImageToRunLengthFeaturesFilter ()

	~ScalarImageToRunLengthFeaturesFilter () 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	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () 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 ()

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

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

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

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
bool	m_FastCalculations {}

FeatureValueVectorPointer	m_FeatureMeans {}

FeatureValueVectorPointer	m_FeatureStandardDeviations {}

OffsetVectorConstPointer	m_Offsets {}

FeatureNameVectorConstPointer	m_RequestedFeatures {}

RunLengthMatrixFilterType::Pointer	m_RunLengthMatrixGenerator {}

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::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::ConstPointer = SmartPointer<const Self>

Definition at line 93 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ DataObjectPointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::DataObjectPointer = DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 127 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

protected

Make a DataObject to be used for output output.

Definition at line 214 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FeatureNameVector

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FeatureNameVector = VectorContainer<unsigned char, RunLengthFeatureName>

Definition at line 120 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FeatureNameVectorConstPointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FeatureNameVectorConstPointer = typename FeatureNameVector::ConstPointer

Definition at line 122 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FeatureNameVectorPointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FeatureNameVectorPointer = typename FeatureNameVector::Pointer

Definition at line 121 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FeatureValueVector

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FeatureValueVector = VectorContainer<unsigned char, double>

Definition at line 123 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FeatureValueVectorDataObjectType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FeatureValueVectorDataObjectType = DataObjectDecorator<FeatureValueVector>

Type of DataObjects used for scalar outputs

Definition at line 130 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FeatureValueVectorPointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FeatureValueVectorPointer = typename FeatureValueVector::Pointer

Definition at line 124 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ FrequencyContainerType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FrequencyContainerType = THistogramFrequencyContainer

Definition at line 101 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ HistogramType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::HistogramType = typename RunLengthMatrixFilterType::HistogramType

Definition at line 113 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ ImagePointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::ImagePointer = typename ImageType::Pointer

Definition at line 103 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ ImageType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::ImageType = TImageType

Definition at line 102 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ OffsetType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::OffsetType = typename ImageType::OffsetType

Definition at line 106 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ OffsetVector

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::OffsetVector = VectorContainer<unsigned char, OffsetType>

Definition at line 107 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ OffsetVectorConstPointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::OffsetVectorConstPointer = typename OffsetVector::ConstPointer

Definition at line 109 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ OffsetVectorPointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::OffsetVectorPointer = typename OffsetVector::Pointer

Definition at line 108 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ PixelType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::PixelType = typename ImageType::PixelType

Definition at line 105 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ Pointer

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::Pointer = SmartPointer<Self>

Definition at line 92 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ RunLengthFeatureName

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::RunLengthFeatureName = uint8_t

Definition at line 119 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ RunLengthFeaturesFilterType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::RunLengthFeaturesFilterType = HistogramToRunLengthFeaturesFilter<HistogramType>

Definition at line 115 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ RunLengthMatrixFilterType

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::RunLengthMatrixFilterType = ScalarImageToRunLengthMatrixFilter<ImageType, FrequencyContainerType>

Definition at line 111 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ Self

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::Self = ScalarImageToRunLengthFeaturesFilter

Standard type alias

Definition at line 90 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ Superclass

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

using itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::Superclass = ProcessObject

Definition at line 91 of file itkScalarImageToRunLengthFeaturesFilter.h.

Constructor & Destructor Documentation

◆ ScalarImageToRunLengthFeaturesFilter()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::ScalarImageToRunLengthFeaturesFilter ( )

protected

Referenced by GetNameOfClass().

◆ ~ScalarImageToRunLengthFeaturesFilter()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::~ScalarImageToRunLengthFeaturesFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual::itk::LightObject::Pointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ FastCalculationsOff()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FastCalculationsOff ( )

virtual

◆ FastCalculationsOn()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FastCalculationsOn ( )

virtual

◆ FastCompute()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FastCompute ( )

protected

◆ FullCompute()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::FullCompute ( )

protected

◆ GenerateData()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GenerateData ( )

overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GetFastCalculations()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual bool itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetFastCalculations ( ) const

virtual

◆ GetFeatureMeans()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual const FeatureValueVector::Pointer & itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetFeatureMeans ( ) const

virtual

Return the feature means and deviations.

◆ GetFeatureMeansOutput()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

const FeatureValueVectorDataObjectType * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetFeatureMeansOutput ( ) const

◆ GetFeatureStandardDeviations()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual const FeatureValueVector::Pointer & itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetFeatureStandardDeviations ( ) const

virtual

Return the feature means and deviations.

◆ GetFeatureStandardDeviationsOutput()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

const FeatureValueVectorDataObjectType * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetFeatureStandardDeviationsOutput ( ) const

References itk::ProcessObject::SetInput().

◆ GetInput()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

const ImageType * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetInput ( ) const

◆ GetMaskImage()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

const ImageType * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetMaskImage ( ) const

◆ GetNameOfClass()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

const char * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

References ScalarImageToRunLengthFeaturesFilter().

◆ GetOffsets()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual const OffsetVector * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetOffsets ( ) const

virtual

Set the offsets over which the co-occurrence pairs will be computed. Optional; for default value see above.

◆ GetRequestedFeatures()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual const FeatureNameVector * itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::GetRequestedFeatures ( ) const

virtual

Set the desired feature set. Optional, for default value see above.

◆ MakeOutput() [1/2]

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual DataObjectPointer itk::ProcessObject::MakeOutput ( const DataObjectIdentifierType & )

protectedvirtual

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.

◆ MakeOutput() [2/2]

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

DataObjectPointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< 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::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::New ( )

static

standard New() method support

◆ PrintSelf()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< 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::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetDistanceValueMinMax	(	double	min,
		double	max )

Set the min and max (inclusive) pixel value that will be used for feature calculations. Optional; for default value see above.

◆ SetFastCalculations()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetFastCalculations ( bool _arg )

virtual

◆ SetInput() [1/2]

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

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

virtual

Connects the input image for which the features are going to be computed

Reimplemented from itk::ProcessObject.

◆ SetInput() [2/2]

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetInput ( const ImageType * )

◆ SetInsidePixelValue()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetInsidePixelValue ( PixelType insidePixelValue )

Set the pixel value of the mask that should be considered "inside" the object. Optional; for default value see above.

◆ SetMaskImage()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetMaskImage ( const ImageType * )

Connects the mask image for which the histogram is going to be computed. Optional; for default value see above.

◆ SetNumberOfBinsPerAxis()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetNumberOfBinsPerAxis ( unsigned int )

Set number of histogram bins along each axis. Optional; for default value see above.

◆ SetOffsets()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetOffsets ( const OffsetVector * _arg )

virtual

Set the offsets over which the co-occurrence pairs will be computed. Optional; for default value see above.

◆ SetPixelValueMinMax()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetPixelValueMinMax	(	PixelType	min,
		PixelType	max )

Set the min and max (inclusive) pixel value that will be used for feature calculations. Optional; for default value see above.

◆ SetRequestedFeatures()

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

virtual void itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::SetRequestedFeatures ( const FeatureNameVector * _arg )

virtual

Set the desired feature set. Optional, for default value see above.

Member Data Documentation

◆ m_FastCalculations

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

bool itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::m_FastCalculations {}

private

Definition at line 225 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ m_FeatureMeans

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

FeatureValueVectorPointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::m_FeatureMeans {}

private

Definition at line 221 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ m_FeatureStandardDeviations

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

FeatureValueVectorPointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::m_FeatureStandardDeviations {}

private

Definition at line 222 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ m_Offsets

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

OffsetVectorConstPointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::m_Offsets {}

private

Definition at line 224 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ m_RequestedFeatures

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

FeatureNameVectorConstPointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::m_RequestedFeatures {}

private

Definition at line 223 of file itkScalarImageToRunLengthFeaturesFilter.h.

◆ m_RunLengthMatrixGenerator

template<typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>

RunLengthMatrixFilterType::Pointer itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::m_RunLengthMatrixGenerator {}

private

Definition at line 219 of file itkScalarImageToRunLengthFeaturesFilter.h.

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

itkScalarImageToRunLengthFeaturesFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ FeatureNameVector

◆ FeatureNameVectorConstPointer

◆ FeatureNameVectorPointer

◆ FeatureValueVector

◆ FeatureValueVectorDataObjectType

◆ FeatureValueVectorPointer

◆ FrequencyContainerType

◆ HistogramType

◆ ImagePointer

◆ ImageType

◆ OffsetType

◆ OffsetVector

◆ OffsetVectorConstPointer

◆ OffsetVectorPointer

◆ PixelType

◆ Pointer

◆ RunLengthFeatureName

◆ RunLengthFeaturesFilterType

◆ RunLengthMatrixFilterType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ScalarImageToRunLengthFeaturesFilter()

◆ ~ScalarImageToRunLengthFeaturesFilter()

Member Function Documentation

◆ CreateAnother()

◆ FastCalculationsOff()

◆ FastCalculationsOn()

◆ FastCompute()

◆ FullCompute()

◆ GenerateData()

◆ GetFastCalculations()

◆ GetFeatureMeans()

◆ GetFeatureMeansOutput()

◆ GetFeatureStandardDeviations()

◆ GetFeatureStandardDeviationsOutput()

◆ GetInput()

◆ GetMaskImage()

◆ GetNameOfClass()

◆ GetOffsets()

◆ GetRequestedFeatures()

◆ MakeOutput() [1/2]

◆ MakeOutput() [2/2]

◆ New()

◆ PrintSelf()

◆ SetDistanceValueMinMax()

◆ SetFastCalculations()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

◆ SetInsidePixelValue()

◆ SetMaskImage()

◆ SetNumberOfBinsPerAxis()

◆ SetOffsets()

◆ SetPixelValueMinMax()

◆ SetRequestedFeatures()

Member Data Documentation

◆ m_FastCalculations

◆ m_FeatureMeans

◆ m_FeatureStandardDeviations

◆ m_Offsets

◆ m_RequestedFeatures

◆ m_RunLengthMatrixGenerator