ITK  5.2.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>

+ 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
const ImageTypeGetInput () const
 
virtual const char * GetNameOfClass () const
 
const SampleTypeGetOutput () const
 
void SetInput (const ImageType *image)
 
void UseNeighbor (const OffsetType &offset)
 
- 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 flag)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () 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
 
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)
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- 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
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, 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)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 &time)
 
- 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
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

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

Member Function Documentation

◆ CreateAnother()

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

◆ 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 >
virtual const char* itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

STL map to store the named inputs and outputs

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

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