itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage > Class Template Reference

#include <itkScalarImageToCooccurrenceListSampleFilter.h>

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

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

Detailed Description

template<class 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 51 of file itkScalarImageToCooccurrenceListSampleFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TImage	ImageType
typedef SampleType::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef FixedArray< typename TImage::PixelType, 2 >	MeasurementVectorType
typedef std::vector< OffsetType >	OffsetTable
typedef ShapedNeighborhoodIteratorType::OffsetType	OffsetType
typedef SmartPointer< Self >	Pointer
typedef itk::Statistics::ListSample < MeasurementVectorType >	SampleType
typedef ScalarImageToCooccurrenceListSampleFilter	Self
typedef itk::ShapedNeighborhoodIterator < TImage, ConstantBoundaryCondition < TImage > >	ShapedNeighborhoodIteratorType
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const ImageType *	GetInput () const
virtual const char *	GetNameOfClass () const
const SampleType *	GetOutput () 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 ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 Attributes
static const unsigned int	ImageDimension = TImage::ImageDimension
static const unsigned int	MeasurementVectorSize = 2

Protected Types
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

Protected Member Functions
virtual void	GenerateData ()
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
void	PrintSelf (std::ostream &os, Indent indent) const
	ScalarImageToCooccurrenceListSampleFilter ()
virtual	~ScalarImageToCooccurrenceListSampleFilter ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 Member Functions
void	operator= (const Self &)
	ScalarImageToCooccurrenceListSampleFilter (const Self &)

Private Attributes
OffsetTable	m_OffsetTable

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating

Member Typedef Documentation

template<class TImage >

typedef SmartPointer< const Self > itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ConstPointer

Definition at line 66 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef DataObject::Pointer itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::DataObjectPointer

protected

Definition at line 107 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::DataObjectPointerArraySizeType

protected

Definition at line 108 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef TImage itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ImageType

Definition at line 55 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef SampleType::MeasurementVectorSizeType itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MeasurementVectorSizeType

Definition at line 60 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef FixedArray< typename TImage::PixelType, 2 > itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MeasurementVectorType

Definition at line 57 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef std::vector< OffsetType > itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::OffsetTable

Definition at line 76 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef ShapedNeighborhoodIteratorType::OffsetType itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::OffsetType

Offset type used for Neighborhoods

Definition at line 75 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef SmartPointer< Self > itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::Pointer

Definition at line 65 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef itk::Statistics::ListSample< MeasurementVectorType > itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::SampleType

Definition at line 59 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef ScalarImageToCooccurrenceListSampleFilter itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::Self

Standard class typedefs

Definition at line 63 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef itk::ShapedNeighborhoodIterator< TImage, ConstantBoundaryCondition< TImage > > itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ShapedNeighborhoodIteratorType

Neighborhood iterator type.

Definition at line 72 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

typedef ProcessObject itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::Superclass

Definition at line 64 of file itkScalarImageToCooccurrenceListSampleFilter.h.

Constructor & Destructor Documentation

template<class TImage >

itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ScalarImageToCooccurrenceListSampleFilter ( )

protected

template<class TImage >

virtual itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::~ScalarImageToCooccurrenceListSampleFilter ( )

inlineprotectedvirtual

Definition at line 104 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ScalarImageToCooccurrenceListSampleFilter ( const Self &  )

private

Member Function Documentation

template<class TImage >

virtual::itk::LightObject::Pointer itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::CreateAnother ( void  ) 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.

template<class TImage >

virtual void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GenerateData ( )

protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TImage >

const ImageType* itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GetInput

(

)

const

template<class TImage >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TImage >

const SampleType* itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::GetOutput

(

)

const

method to get the List sample

template<class TImage >

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

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.

template<class TImage >

static Pointer itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::New ( )

static

Method for creation through the object factory.

template<class TImage >

void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::operator= ( const Self &  )

private

template<class TImage >

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

protectedvirtual

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.

template<class TImage >

void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::SetInput

(

const ImageType *

image

)

template<class TImage >

void itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::UseNeighbor

(

const OffsetType &

offset

)

Member Data Documentation

template<class TImage >

const unsigned int itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::ImageDimension = TImage::ImageDimension

static

Image dimension.

Definition at line 100 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

OffsetTable itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::m_OffsetTable

private

Definition at line 121 of file itkScalarImageToCooccurrenceListSampleFilter.h.

template<class TImage >

const unsigned int itk::Statistics::ScalarImageToCooccurrenceListSampleFilter< TImage >::MeasurementVectorSize = 2

static

the number of components in a measurement vector

Definition at line 96 of file itkScalarImageToCooccurrenceListSampleFilter.h.

---

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

• itkScalarImageToCooccurrenceListSampleFilter.h