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::ScalarImageToCooccurrenceListSampleFilter< TImage > Class Template Reference
Group Numerics » Module ITKStatistics

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

Author
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 ImageType * GetInput () const
 
const char * GetNameOfClass () const override
 
const SampleType * GetOutput () 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 ()
 
MultiThreaderType * GetMultiThreader () 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 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
 
LightObject::Pointer CreateAnother () const override
 
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
 
const char * GetNameOfClass () const override
 
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 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 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 GenerateData ()
 
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 ()
 
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
 
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 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

OffsetTable m_OffsetTable {}
 

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 TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ DataObjectPointer

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::DataObjectPointer = DataObject::Pointer
protected

Definition at line 110 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
protected

Definition at line 111 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ ImageType

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

Definition at line 57 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ MeasurementVectorSizeType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MeasurementVectorSizeType = typename SampleType::MeasurementVectorSizeType

Definition at line 62 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ MeasurementVectorType

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

Definition at line 59 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ OffsetTable

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

Definition at line 75 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ OffsetType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::OffsetType = typename ShapedNeighborhoodIteratorType::OffsetType

Offset type used for Neighborhoods

Definition at line 74 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ Pointer

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

Definition at line 67 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ SampleType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::SampleType = itk::Statistics::ListSample<MeasurementVectorType>

Definition at line 61 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ Self

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

Standard class type aliases

Definition at line 65 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ ShapedNeighborhoodIteratorType

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ShapedNeighborhoodIteratorType = itk::ShapedNeighborhoodIterator<TImage, ConstantBoundaryCondition<TImage> >

Neighborhood iterator type.

Definition at line 71 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ Superclass

template<typename TImage >
using itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::Superclass = ProcessObject

Definition at line 66 of file itkScalarImageToCooccurrenceListSampleFilter.h.

Constructor & Destructor Documentation

◆ ScalarImageToCooccurrenceListSampleFilter()

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

◆ ~ScalarImageToCooccurrenceListSampleFilter()

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

Member Function Documentation

◆ GenerateData()

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

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
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImage >
void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::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.

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

Image dimension.

Definition at line 102 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ m_OffsetTable

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

Definition at line 121 of file itkScalarImageToCooccurrenceListSampleFilter.h.

◆ MeasurementVectorSize

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

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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3