ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::Statistics::SampleToSubsampleFilter< TSample > Class Template Reference
Module ITKStatistics

#include <itkSampleToSubsampleFilter.h>

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

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.

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 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 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 ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 		GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
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 Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfThreads () const
 
- 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 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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
 

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 SampleToSubsampleFilter ()
 
virtual ~SampleToSubsampleFilter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (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
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
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 &) ITK_DELETE_FUNCTION
 
 SampleToSubsampleFilter (const Self &) ITK_DELETE_FUNCTION
 
typedef
ProcessObject::DataObjectPointerArraySizeType 		DataObjectPointerArraySizeType
 
virtual 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 53 of file itkSampleToSubsampleFilter.h.

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

Definition at line 89 of file itkSampleToSubsampleFilter.h.

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

Definition at line 63 of file itkSampleToSubsampleFilter.h.

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

Definition at line 62 of file itkSampleToSubsampleFilter.h.

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

Definition at line 61 of file itkSampleToSubsampleFilter.h.

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

Definition at line 67 of file itkSampleToSubsampleFilter.h.

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

Definition at line 52 of file itkSampleToSubsampleFilter.h.

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

Definition at line 56 of file itkSampleToSubsampleFilter.h.

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

Standard class typedefs.

Definition at line 50 of file itkSampleToSubsampleFilter.h.

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

Declare the output type

Definition at line 66 of file itkSampleToSubsampleFilter.h.

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

Definition at line 51 of file itkSampleToSubsampleFilter.h.

Constructor & Destructor Documentation

template<typename TSample >
itk::Statistics::SampleToSubsampleFilter< TSample >::SampleToSubsampleFilter ( )
protected
template<typename TSample >
virtual itk::Statistics::SampleToSubsampleFilter< TSample >::~SampleToSubsampleFilter ( )
protectedvirtual
template<typename TSample >
itk::Statistics::SampleToSubsampleFilter< TSample >::SampleToSubsampleFilter ( const Self &  )
private

Member Function Documentation

template<typename TSample >
virtual const SampleType* itk::Statistics::SampleToSubsampleFilter< TSample >::GetInput ( ) const
virtual
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 >.

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

Get the output subsample

template<typename TSample >
virtual 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.

template<typename TSample >
void itk::Statistics::SampleToSubsampleFilter< TSample >::operator= ( const Self &  )
private
template<typename TSample >
virtual void itk::Statistics::SampleToSubsampleFilter< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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<typename TSample >
virtual void itk::Statistics::SampleToSubsampleFilter< TSample >::SetInput ( const SampleType *  sample)
virtual
The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Sat Jan 30 2016 05:28:25 for ITK by   doxygen 1.8.5