ITK  5.2.0
Insight Toolkit
Public Types | List of all members
itk::Statistics::NeighborhoodSampler< TSample > Class Template Reference

#include <itkNeighborhoodSampler.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = NeighborhoodSampler
 
using Superclass = SampleToSubsampleFilter< TSample >
 
- Public Types inherited from itk::Statistics::SampleToSubsampleFilter< TSample >
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
 
using SampleType = typename Superclass::SampleType
 
using MeasurementVectorType = typename Superclass::MeasurementVectorType
 
using MeasurementType = typename Superclass::MeasurementType
 
using InstanceIdentifier = typename Superclass::InstanceIdentifier
 
using SubsampleType = typename Superclass::SubsampleType
 
using OutputType = typename Superclass::OutputType
 
using RadiusType = double
 
using InputRadiusObjectType = SimpleDataObjectDecorator< RadiusType >
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void SetRadiusInput (const SimpleDataObjectDecorator< RadiusType > *_arg)
 
virtual void SetRadius (const RadiusType &_arg)
 
virtual void SetRadius (const SimpleDataObjectDecorator< RadiusType > *_arg)
 
virtual const SimpleDataObjectDecorator< RadiusType > * GetRadiusInput () const
 
virtual const RadiusTypeGetRadius () const
 
static Pointer New ()
 
 NeighborhoodSampler ()=default
 
 ~NeighborhoodSampler () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 

Additional Inherited Members

- Public Member Functions inherited from itk::Statistics::SampleToSubsampleFilter< TSample >
virtual const SampleTypeGetInput () const
 
const OutputTypeGetOutput () 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 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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () 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
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
- 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 Types inherited from itk::Statistics::SampleToSubsampleFilter< TSample >
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
- Protected Member Functions inherited from itk::Statistics::SampleToSubsampleFilter< TSample >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SampleToSubsampleFilter ()
 
 ~SampleToSubsampleFilter () override=default
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, 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)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 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 &time)
 
- 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 ()
 
- 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::NeighborhoodSampler< TSample >

Generates a Subsample out of a Sample, based on a user-provided distance to a MeasurementVector.

This filter will take as input a Sample and produce as output a Subsample containing the instances of the sample that are at a distance lower than a user-provided threshold from a user-provided measurement vector.

See also
Sample, Subsample
SampleToSubsampleFilter
Examples
Examples/Statistics/NeighborhoodSampler.cxx.

Definition at line 44 of file itkNeighborhoodSampler.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkNeighborhoodSampler.h.

◆ InputRadiusObjectType

Type of DataObjects to use for distance radius input.

Definition at line 73 of file itkNeighborhoodSampler.h.

◆ InstanceIdentifier

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::InstanceIdentifier = typename Superclass::InstanceIdentifier

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

Definition at line 65 of file itkNeighborhoodSampler.h.

◆ MeasurementType

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::MeasurementType = typename Superclass::MeasurementType

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

Definition at line 64 of file itkNeighborhoodSampler.h.

◆ MeasurementVectorType

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::MeasurementVectorType = typename Superclass::MeasurementVectorType

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

Definition at line 63 of file itkNeighborhoodSampler.h.

◆ OutputType

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::OutputType = typename Superclass::OutputType

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

Definition at line 67 of file itkNeighborhoodSampler.h.

◆ Pointer

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkNeighborhoodSampler.h.

◆ RadiusType

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::RadiusType = double

Type of the distance radius.

Definition at line 70 of file itkNeighborhoodSampler.h.

◆ SampleType

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::SampleType = typename Superclass::SampleType

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

Definition at line 62 of file itkNeighborhoodSampler.h.

◆ Self

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::Self = NeighborhoodSampler

Standard class type aliases.

Definition at line 50 of file itkNeighborhoodSampler.h.

◆ SubsampleType

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::SubsampleType = typename Superclass::SubsampleType

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

Definition at line 66 of file itkNeighborhoodSampler.h.

◆ Superclass

template<typename TSample >
using itk::Statistics::NeighborhoodSampler< TSample >::Superclass = SampleToSubsampleFilter<TSample>

Definition at line 51 of file itkNeighborhoodSampler.h.

Constructor & Destructor Documentation

◆ NeighborhoodSampler()

template<typename TSample >
itk::Statistics::NeighborhoodSampler< TSample >::NeighborhoodSampler ( )
protecteddefault

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

◆ ~NeighborhoodSampler()

template<typename TSample >
itk::Statistics::NeighborhoodSampler< TSample >::~NeighborhoodSampler ( )
overrideprotecteddefault

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

Member Function Documentation

◆ CreateAnother()

template<typename TSample >
virtual::itk::LightObject::Pointer itk::Statistics::NeighborhoodSampler< TSample >::CreateAnother ( ) const
virtual

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

Reimplemented from itk::Object.

◆ GenerateData()

template<typename TSample >
void itk::Statistics::NeighborhoodSampler< TSample >::GenerateData ( )
overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<typename TSample >
virtual const char* itk::Statistics::NeighborhoodSampler< TSample >::GetNameOfClass ( ) const
virtual

Standard macros

Reimplemented from itk::Statistics::SampleToSubsampleFilter< TSample >.

◆ GetRadius()

template<typename TSample >
virtual const RadiusType& itk::Statistics::NeighborhoodSampler< TSample >::GetRadius ( ) const
virtual

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

◆ GetRadiusInput()

template<typename TSample >
virtual const SimpleDataObjectDecorator< RadiusType >* itk::Statistics::NeighborhoodSampler< TSample >::GetRadiusInput ( ) const
virtual

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

◆ New()

template<typename TSample >
static Pointer itk::Statistics::NeighborhoodSampler< TSample >::New ( )
static

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

◆ PrintSelf()

template<typename TSample >
void itk::Statistics::NeighborhoodSampler< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

◆ SetRadius() [1/2]

template<typename TSample >
virtual void itk::Statistics::NeighborhoodSampler< TSample >::SetRadius ( const RadiusType _arg)
virtual

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

◆ SetRadius() [2/2]

template<typename TSample >
virtual void itk::Statistics::NeighborhoodSampler< TSample >::SetRadius ( const SimpleDataObjectDecorator< RadiusType > *  _arg)
virtual

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

◆ SetRadiusInput()

template<typename TSample >
virtual void itk::Statistics::NeighborhoodSampler< TSample >::SetRadiusInput ( const SimpleDataObjectDecorator< RadiusType > *  _arg)
virtual

Method to set the input value of the Radius


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