itk::Statistics::SampleToSubsampleFilter< TSample > Class Template Reference

#include <itkSampleToSubsampleFilter.h>

Inheritance diagram for itk::Statistics::SampleToSubsampleFilter< TSample >:

Collaboration diagram for itk::Statistics::SampleToSubsampleFilter< TSample >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SampleType::InstanceIdentifier	InstanceIdentifier
typedef SampleType::MeasurementType	MeasurementType
typedef SampleType::MeasurementVectorType	MeasurementVectorType
typedef SubsampleType	OutputType
typedef SmartPointer< Self >	Pointer
typedef TSample	SampleType
typedef SampleToSubsampleFilter	Self
typedef Subsample< SampleType >	SubsampleType
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual const SampleType *	GetInput () const
virtual const char *	GetNameOfClass () const
const OutputType *	GetOutput () const
virtual void	SetInput (const SampleType *sample)
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 LightObject::Pointer	CreateAnother () 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 unsigned long	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

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	SampleToSubsampleFilter ()
virtual	~SampleToSubsampleFilter ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) 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)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
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	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
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 &)
	SampleToSubsampleFilter (const Self &)
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

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

---

Detailed Description

template<class TSample>
class itk::Statistics::SampleToSubsampleFilter< TSample >

Base class of filters intended to select subsamples from samples.

This filter will take as input a Sample and produce as output a Subsample that derives from the original sample, and that refers to it.

This is an Abstract class that can not be instantiated. There are multiple filters that derive from this class and provide specific implementations of subsampling methods.

See also:

Sample, Subsample

NeighborhoodSampler

Definition at line 46 of file itkSampleToSubsampleFilter.h.

---

Member Typedef Documentation

template<class TSample >

typedef SmartPointer< const Self > itk::Statistics::SampleToSubsampleFilter< TSample >::ConstPointer

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 53 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::SampleToSubsampleFilter< TSample >::DataObjectPointerArraySizeType

protected

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also:

ProcessObject

Reimplemented from itk::ProcessObject.

Definition at line 89 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef SampleType::InstanceIdentifier itk::Statistics::SampleToSubsampleFilter< TSample >::InstanceIdentifier

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 63 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef SampleType::MeasurementType itk::Statistics::SampleToSubsampleFilter< TSample >::MeasurementType

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 62 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef SampleType::MeasurementVectorType itk::Statistics::SampleToSubsampleFilter< TSample >::MeasurementVectorType

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 61 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef SubsampleType itk::Statistics::SampleToSubsampleFilter< TSample >::OutputType

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 67 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef SmartPointer< Self > itk::Statistics::SampleToSubsampleFilter< TSample >::Pointer

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 52 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef TSample itk::Statistics::SampleToSubsampleFilter< TSample >::SampleType

Typedefs for Measurement vector, measurement, Instance Identifier, frequency, size, size element value from the template argument TSample

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 56 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef SampleToSubsampleFilter itk::Statistics::SampleToSubsampleFilter< TSample >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 50 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef Subsample< SampleType > itk::Statistics::SampleToSubsampleFilter< TSample >::SubsampleType

Declare the output type

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 66 of file itkSampleToSubsampleFilter.h.

template<class TSample >

typedef ProcessObject itk::Statistics::SampleToSubsampleFilter< TSample >::Superclass

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

Definition at line 51 of file itkSampleToSubsampleFilter.h.

---

Constructor & Destructor Documentation

template<class TSample >

itk::Statistics::SampleToSubsampleFilter< TSample >::SampleToSubsampleFilter ( )

protected

template<class TSample >

virtual itk::Statistics::SampleToSubsampleFilter< TSample >::~SampleToSubsampleFilter ( )

protectedvirtual

template<class TSample >

itk::Statistics::SampleToSubsampleFilter< TSample >::SampleToSubsampleFilter ( const Self &  )

private

---

Member Function Documentation

template<class TSample >

virtual const SampleType* itk::Statistics::SampleToSubsampleFilter< TSample >::GetInput ( ) const

virtual

template<class TSample >

virtual const char* itk::Statistics::SampleToSubsampleFilter< TSample >::GetNameOfClass ( ) const

virtual

Standard macros

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

template<class TSample >

const OutputType* itk::Statistics::SampleToSubsampleFilter< TSample >::GetOutput

(

)

const

Get the output subsample

template<class TSample >

virtual DataObjectPointer itk::Statistics::SampleToSubsampleFilter< TSample >::MakeOutput ( DataObjectPointerArraySizeType  idx )

protectedvirtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also:

ProcessObject

Reimplemented from itk::ProcessObject.

template<class TSample >

void itk::Statistics::SampleToSubsampleFilter< TSample >::operator= ( const Self &  )

private

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

template<class TSample >

void itk::Statistics::SampleToSubsampleFilter< TSample >::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.

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >.

template<class TSample >

virtual void itk::Statistics::SampleToSubsampleFilter< TSample >::SetInput ( const SampleType *  sample )

virtual

---

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

• itkSampleToSubsampleFilter.h