#include <itkListSampleCArray.h>

Detailed Description

template<class TMeasurementVector, class TInternalValue = typename TMeasurementVector::ValueType>
class itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >

A ListSampleBase that internally uses a CArray, which can be accessed.

This class is useful if some function expects a c-array, but you would like to keep things as much as possible in the itk::Statistics-framework.

Todo:: : the second template argument should be removed, since the GetMeasurementVector method is incorrect when TMeasurementVector::ValueType != TInternalValue.

Definition at line 45 of file itkListSampleCArray.h.

Inheritance diagram for itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >:

Public Types
typedef Superclass::AbsoluteFrequencyType	AbsoluteFrequencyType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::InstanceIdentifier	InstanceIdentifier

typedef InternalDataType *	InternalDataContainerType

typedef InternalValueType *	InternalDataType

typedef TInternalValue	InternalValueType

typedef Superclass::MeasurementType	MeasurementType

typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType

typedef Superclass::MeasurementVectorType	MeasurementVectorType

typedef SmartPointer< Self >	Pointer

typedef ListSampleCArray	Self

typedef Sample< TMeasurementVector >	Superclass

typedef Superclass::TotalAbsoluteFrequencyType	TotalAbsoluteFrequencyType

Public Member Functions
void	Clear (void)

unsigned long	GetActualSize (void)

virtual const char *	GetClassName () const

AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const override

virtual InternalDataContainerType	GetInternalContainer () const

const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const override

void	GetMeasurementVector (InstanceIdentifier id, MeasurementVectorType &mv) const

TotalAbsoluteFrequencyType	GetTotalFrequency (void) const override

void	Resize (unsigned long n)

void	SetActualSize (unsigned long n)

void	SetMeasurement (InstanceIdentifier id, unsigned int dim, const MeasurementType &value)

void	SetMeasurementVector (InstanceIdentifier id, const MeasurementVectorType &mv)

InstanceIdentifier	Size (void) const override

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	ListSampleCArray ()

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

	~ListSampleCArray () override

Private Member Functions
void	AllocateInternalContainer (unsigned long size, unsigned int dim)

void	DeallocateInternalContainer (void)

	ListSampleCArray (const Self &)

void	operator= (const Self &)

Private Attributes
InstanceIdentifier	m_ActualSize

InternalDataContainerType	m_InternalContainer

InstanceIdentifier	m_InternalContainerSize

MeasurementVectorType	m_TemporaryMeasurementVector

Member Typedef Documentation

◆ AbsoluteFrequencyType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Superclass::AbsoluteFrequencyType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::AbsoluteFrequencyType

Definition at line 66 of file itkListSampleCArray.h.

◆ ConstPointer

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef SmartPointer< const Self > itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::ConstPointer

Definition at line 54 of file itkListSampleCArray.h.

◆ InstanceIdentifier

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Superclass::InstanceIdentifier itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::InstanceIdentifier

Definition at line 68 of file itkListSampleCArray.h.

◆ InternalDataContainerType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef InternalDataType* itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::InternalDataContainerType

Definition at line 73 of file itkListSampleCArray.h.

◆ InternalDataType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef InternalValueType* itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::InternalDataType

Definition at line 72 of file itkListSampleCArray.h.

◆ InternalValueType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef TInternalValue itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::InternalValueType

Typedef's for the internal data container.

Definition at line 71 of file itkListSampleCArray.h.

◆ MeasurementType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Superclass::MeasurementType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::MeasurementType

Definition at line 65 of file itkListSampleCArray.h.

◆ MeasurementVectorSizeType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Superclass::MeasurementVectorSizeType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::MeasurementVectorSizeType

Definition at line 64 of file itkListSampleCArray.h.

◆ MeasurementVectorType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Superclass::MeasurementVectorType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::MeasurementVectorType

Typedef's from Superclass.

Definition at line 63 of file itkListSampleCArray.h.

◆ Pointer

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef SmartPointer< Self > itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::Pointer

Definition at line 53 of file itkListSampleCArray.h.

◆ Self

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef ListSampleCArray itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::Self

Standard itk.

Definition at line 51 of file itkListSampleCArray.h.

◆ Superclass

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Sample< TMeasurementVector > itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::Superclass

Definition at line 52 of file itkListSampleCArray.h.

◆ TotalAbsoluteFrequencyType

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

typedef Superclass::TotalAbsoluteFrequencyType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::TotalAbsoluteFrequencyType

Definition at line 67 of file itkListSampleCArray.h.

Constructor & Destructor Documentation

◆ ListSampleCArray() [1/2]

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::ListSampleCArray ( )

protected

◆ ~ListSampleCArray()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::~ListSampleCArray ( )

overrideprotected

◆ ListSampleCArray() [2/2]

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::ListSampleCArray ( const Self & )

private

Member Function Documentation

◆ AllocateInternalContainer()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::AllocateInternalContainer	(	unsigned long	size,
		unsigned int	dim
	)

private

Function to allocate the memory of the data container.

◆ Clear()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::Clear ( void )

Function to clear the data container.

◆ DeallocateInternalContainer()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::DeallocateInternalContainer ( void )

private

Function to deallocate the memory of the data container.

◆ GetActualSize()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

unsigned long itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetActualSize ( void )

Function to get the actual (not the allocated) size of the data container.

◆ GetClassName()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

virtual const char * itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetClassName ( ) const

virtual

ITK type info

◆ GetFrequency()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

AbsoluteFrequencyType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetFrequency ( InstanceIdentifier id ) const

override

Function to get the frequency of point i. 1.0 if it exist, 0.0 otherwise.

◆ GetInternalContainer()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

virtual InternalDataContainerType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetInternalContainer ( ) const

virtual

Macro to get the internal data container.

◆ GetMeasurementVector() [1/2]

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

const MeasurementVectorType & itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetMeasurementVector ( InstanceIdentifier id ) const

override

Function to get a point from the data container. NB: the reference to the returned value remains only valid until the next call to this function. The method GetMeasurementVector( const InstanceIdentifier &id, MeasurementVectorType & mv) is actually a preferred way to get a measurement vector.

◆ GetMeasurementVector() [2/2]

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetMeasurementVector	(	InstanceIdentifier	id,
		MeasurementVectorType &	mv
	)		const

Function to get a point from the data container.

◆ GetTotalFrequency()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

TotalAbsoluteFrequencyType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::GetTotalFrequency ( void ) const

inlineoverride

Function to get the total frequency.

Definition at line 122 of file itkListSampleCArray.h.

◆ New()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

static Pointer itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::New ( )

static

New method for creating an object using a factory.

◆ operator=()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::operator= ( const Self & )

private

◆ PrintSelf()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotected

◆ Resize()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::Resize ( unsigned long n )

Function to resize the data container.

◆ SetActualSize()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::SetActualSize ( unsigned long n )

Function to set the actual (not the allocated) size of the data container.

◆ SetMeasurement()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::SetMeasurement	(	InstanceIdentifier	id,
		unsigned int	dim,
		const MeasurementType &	value
	)

Function to set part of a point (measurement) in the data container.

◆ SetMeasurementVector()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

void itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::SetMeasurementVector	(	InstanceIdentifier	id,
		const MeasurementVectorType &	mv
	)

Function to set a point (measurement vector) in the data container.

◆ Size()

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

InstanceIdentifier itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::Size ( void ) const

inlineoverride

Function to get the size of the data container.

Definition at line 91 of file itkListSampleCArray.h.

Field Documentation

◆ m_ActualSize

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

InstanceIdentifier itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::m_ActualSize

private

Definition at line 142 of file itkListSampleCArray.h.

◆ m_InternalContainer

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

InternalDataContainerType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::m_InternalContainer

private

The internal storage of the data in a C array.

Definition at line 140 of file itkListSampleCArray.h.

◆ m_InternalContainerSize

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

InstanceIdentifier itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::m_InternalContainerSize

private

Definition at line 141 of file itkListSampleCArray.h.

◆ m_TemporaryMeasurementVector

template<class TMeasurementVector , class TInternalValue = typename TMeasurementVector::ValueType>

MeasurementVectorType itk::Statistics::ListSampleCArray< TMeasurementVector, TInternalValue >::m_TemporaryMeasurementVector

mutableprivate

Dummy needed for GetMeasurementVector().

Definition at line 145 of file itkListSampleCArray.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ AbsoluteFrequencyType

◆ ConstPointer

◆ InstanceIdentifier

◆ InternalDataContainerType

◆ InternalDataType

◆ InternalValueType

◆ MeasurementType

◆ MeasurementVectorSizeType

◆ MeasurementVectorType

◆ Pointer

◆ Self

◆ Superclass

◆ TotalAbsoluteFrequencyType

Constructor & Destructor Documentation

◆ ListSampleCArray() [1/2]

◆ ~ListSampleCArray()

◆ ListSampleCArray() [2/2]

Member Function Documentation

◆ AllocateInternalContainer()

◆ Clear()

◆ DeallocateInternalContainer()

◆ GetActualSize()

◆ GetClassName()

◆ GetFrequency()

◆ GetInternalContainer()

◆ GetMeasurementVector() [1/2]

◆ GetMeasurementVector() [2/2]

◆ GetTotalFrequency()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ Resize()

◆ SetActualSize()

◆ SetMeasurement()

◆ SetMeasurementVector()

◆ Size()

Field Documentation

◆ m_ActualSize

◆ m_InternalContainer

◆ m_InternalContainerSize

◆ m_TemporaryMeasurementVector