#include <itkSampleToSubsampleFilter.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InstanceIdentifier = typename SampleType::InstanceIdentifier

using	MeasurementType = typename SampleType::MeasurementType

using	MeasurementVectorType = typename SampleType::MeasurementVectorType

using	OutputType = SubsampleType

using	Pointer = SmartPointer< Self >

using	SampleType = TSample

using	Self = SampleToSubsampleFilter

using	SubsampleType = Subsample< SampleType >

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

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 ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () 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

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

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)

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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

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

	SampleToSubsampleFilter ()

	~SampleToSubsampleFilter () override=default

Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, 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)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () 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)

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

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () 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	GenerateData ()

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 &timeStamp)

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

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

Additional Inherited Members
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 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 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

◆ ConstPointer

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkSampleToSubsampleFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::DataObjectPointerArraySizeType = ProcessObject::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

Definition at line 95 of file itkSampleToSubsampleFilter.h.

◆ InstanceIdentifier

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::InstanceIdentifier = typename SampleType::InstanceIdentifier

Definition at line 65 of file itkSampleToSubsampleFilter.h.

◆ MeasurementType

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::MeasurementType = typename SampleType::MeasurementType

Definition at line 64 of file itkSampleToSubsampleFilter.h.

◆ MeasurementVectorType

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::MeasurementVectorType = typename SampleType::MeasurementVectorType

Definition at line 63 of file itkSampleToSubsampleFilter.h.

◆ OutputType

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::OutputType = SubsampleType

Definition at line 69 of file itkSampleToSubsampleFilter.h.

◆ Pointer

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkSampleToSubsampleFilter.h.

◆ SampleType

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::SampleType = TSample

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

Definition at line 62 of file itkSampleToSubsampleFilter.h.

◆ Self

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::Self = SampleToSubsampleFilter

Standard class type aliases.

Definition at line 52 of file itkSampleToSubsampleFilter.h.

◆ SubsampleType

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::SubsampleType = Subsample<SampleType>

Declare the output type

Definition at line 68 of file itkSampleToSubsampleFilter.h.

◆ Superclass

template<typename TSample >

using itk::Statistics::SampleToSubsampleFilter< TSample >::Superclass = ProcessObject

Definition at line 53 of file itkSampleToSubsampleFilter.h.

Constructor & Destructor Documentation

◆ SampleToSubsampleFilter()

template<typename TSample >

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

protected

◆ ~SampleToSubsampleFilter()

template<typename TSample >

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

overrideprotecteddefault

Member Function Documentation

◆ GetInput()

template<typename TSample >

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

virtual

◆ GetNameOfClass()

template<typename TSample >

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

virtual

Standard macros

Reimplemented from itk::ProcessObject.

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

◆ GetOutput()

template<typename TSample >

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

Get the output subsample

◆ MakeOutput()

template<typename TSample >

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

overrideprotectedvirtual

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.

◆ PrintSelf()

template<typename TSample >

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

overrideprotectedvirtual

STL map to store the named inputs and outputs

Reimplemented from itk::ProcessObject.

◆ SetInput()

template<typename 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

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointerArraySizeType

◆ InstanceIdentifier

◆ MeasurementType

◆ MeasurementVectorType

◆ OutputType

◆ Pointer

◆ SampleType

◆ Self

◆ SubsampleType

◆ Superclass

Constructor & Destructor Documentation

◆ SampleToSubsampleFilter()

◆ ~SampleToSubsampleFilter()

Member Function Documentation

◆ GetInput()

◆ GetNameOfClass()

◆ GetOutput()

◆ MakeOutput()

◆ PrintSelf()

◆ SetInput()

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