ITK  5.4.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::ScalarImageToCooccurrenceListSampleFilter< TImage > Class Template Reference

#include <itkScalarImageToCooccurrenceListSampleFilter.h>

Detailed Description

template<typename TImage>
class itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >

Converts pixel data into a list of pairs in order to compute a cooccurrence Histogram.

This class is intended to be used in combination with the ListToHistogramFilter class.

Glenn Pierce

Definition at line 52 of file itkScalarImageToCooccurrenceListSampleFilter.h.

+ Inheritance diagram for itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >:
+ Collaboration diagram for itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
using ImageType = TImage
using MeasurementVectorSizeType = typename SampleType::MeasurementVectorSizeType
using MeasurementVectorType = FixedArray< typename TImage::PixelType, 2 >
using OffsetTable = std::vector< OffsetType >
using OffsetType = typename ShapedNeighborhoodIteratorType::OffsetType
using Pointer = SmartPointer< Self >
using SampleType = itk::Statistics::ListSample< MeasurementVectorType >
using Self = ScalarImageToCooccurrenceListSampleFilter
using ShapedNeighborhoodIteratorType = itk::ShapedNeighborhoodIterator< TImage, ConstantBoundaryCondition< TImage > >
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 char * GetNameOfClass () const override
const SampleTypeGetOutput () const
void SetInput (const ImageType *image)
void UseNeighbor (const OffsetType &offset)
- 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
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 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 *)
unsigned long AddObserver (const EventObject &event, Command *) 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
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 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 ()

Static Public Attributes

static constexpr unsigned int ImageDimension = TImage::ImageDimension
static constexpr unsigned int MeasurementVectorSize = 2

Protected Types

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

Protected Member Functions

void GenerateData () override
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
void PrintSelf (std::ostream &os, Indent indent) const override
 ScalarImageToCooccurrenceListSampleFilter ()
 ~ScalarImageToCooccurrenceListSampleFilter () 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)
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 ()
 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 () ITKv5_CONST
virtual void VerifyPreconditions () ITKv5_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
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

OffsetTable m_OffsetTable {}

Additional Inherited Members

- 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
TimeStamp m_OutputInformationMTime {}
bool m_Updating {}
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ConstPointer = SmartPointer<const Self>

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ ImageType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ImageType = TImage

◆ MeasurementVectorSizeType

◆ MeasurementVectorType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MeasurementVectorType = FixedArray<typename TImage::PixelType, 2>

◆ OffsetTable

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::OffsetTable = std::vector<OffsetType>

◆ OffsetType

Offset type used for Neighborhoods

Definition at line 74 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ Pointer

◆ SampleType

◆ Self

Standard class type aliases

Definition at line 65 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ ShapedNeighborhoodIteratorType

Neighborhood iterator type.

Definition at line 71 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ Superclass

Constructor & Destructor Documentation

◆ ScalarImageToCooccurrenceListSampleFilter()

◆ ~ScalarImageToCooccurrenceListSampleFilter()

template<typename TImage >
itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::~ScalarImageToCooccurrenceListSampleFilter ( )

Member Function Documentation

◆ GenerateData()

template<typename TImage >
void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GenerateData ( )

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GetInput()

template<typename TImage >
const ImageType* itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GetInput ( ) const

◆ GetNameOfClass()

template<typename TImage >
const char* itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GetNameOfClass ( ) const

◆ GetOutput()

template<typename TImage >
const SampleType* itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GetOutput ( ) const

method to get the List sample

◆ MakeOutput()

template<typename TImage >
DataObjectPointer itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)

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 TImage >
static Pointer itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::New ( )

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImage >
void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const

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.

◆ SetInput()

template<typename TImage >
void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::SetInput ( const ImageType image)

◆ UseNeighbor()

template<typename TImage >
void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::UseNeighbor ( const OffsetType offset)

Member Data Documentation

◆ ImageDimension

template<typename TImage >
constexpr unsigned int itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ImageDimension = TImage::ImageDimension

Image dimension.

Definition at line 102 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ m_OffsetTable

template<typename TImage >
OffsetTable itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::m_OffsetTable {}

◆ MeasurementVectorSize

template<typename TImage >
constexpr unsigned int itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MeasurementVectorSize = 2

the number of components in a measurement vector

Definition at line 99 of file itkScalarImageToCooccurrenceListSampleFilter.h.

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