ITK
6.0.0
Insight Toolkit
|
#include <itkListSample.h>
This class is the native implementation of the a Sample with an STL container.
ListSample stores measurements in a list type structure (as opposed to a Histogram, etc.). ListSample allows duplicate measurements. ListSample is not sorted.
ListSample does not allow the user to specify the frequency of a measurement directly. The GetFrequency() methods returns 1 if the measurement exists in the list, 0 otherwise.
Definition at line 51 of file itkListSample.h.
Classes | |
class | ConstIterator |
class | Iterator |
Public Member Functions | |
Iterator | Begin () |
ConstIterator | Begin () const |
void | Clear () |
Iterator | End () |
ConstIterator | End () const |
AbsoluteFrequencyType | GetFrequency (InstanceIdentifier instanceId) const override |
const MeasurementVectorType & | GetMeasurementVector (InstanceIdentifier instanceId) const override |
const char * | GetNameOfClass () const override |
TotalAbsoluteFrequencyType | GetTotalFrequency () const override |
void | Graft (const DataObject *thatObject) override |
void | PushBack (const MeasurementVectorType &mv) |
void | Resize (InstanceIdentifier newsize) |
void | SetMeasurement (InstanceIdentifier instanceId, unsigned int dim, const MeasurementType &value) |
void | SetMeasurementVector (InstanceIdentifier instanceId, const MeasurementVectorType &mv) |
InstanceIdentifier | Size () const override |
Public Member Functions inherited from itk::Statistics::Sample< TMeasurementVector > | |
virtual AbsoluteFrequencyType | GetFrequency (InstanceIdentifier id) const =0 |
virtual const MeasurementVectorType & | GetMeasurementVector (InstanceIdentifier id) const =0 |
virtual MeasurementVectorSizeType | GetMeasurementVectorSize () const |
const char * | GetNameOfClass () const override |
virtual TotalAbsoluteFrequencyType | GetTotalFrequency () const =0 |
void | Graft (const DataObject *thatObject) override |
virtual InstanceIdentifier | Size () const =0 |
virtual void | SetMeasurementVectorSize (MeasurementVectorSizeType s) |
Public Member Functions inherited from itk::DataObject | |
virtual void | CopyInformation (const DataObject *) |
virtual void | DataHasBeenGenerated () |
void | DisconnectPipeline () |
bool | GetDataReleased () const |
const char * | GetNameOfClass () const override |
virtual const bool & | GetReleaseDataFlag () const |
SmartPointer< ProcessObject > | GetSource () const |
DataObjectPointerArraySizeType | GetSourceOutputIndex () const |
const DataObjectIdentifierType & | GetSourceOutputName () const |
virtual ModifiedTimeType | GetUpdateMTime () const |
virtual void | Graft (const DataObject *) |
virtual void | Initialize () |
virtual void | PrepareForNewData () |
virtual void | PropagateRequestedRegion () |
void | ReleaseData () |
virtual void | ReleaseDataFlagOn () |
virtual bool | RequestedRegionIsOutsideOfTheBufferedRegion () |
virtual void | ResetPipeline () |
void | SetReleaseDataFlag (bool flag) |
virtual void | SetRequestedRegion (const DataObject *) |
virtual void | SetRequestedRegionToLargestPossibleRegion () |
bool | ShouldIReleaseData () const |
virtual void | Update () |
virtual void | UpdateOutputData () |
virtual void | UpdateOutputInformation () |
void | UpdateSource () const |
virtual bool | VerifyRequestedRegion () |
void | SetPipelineMTime (ModifiedTimeType time) |
virtual const ModifiedTimeType & | GetPipelineMTime () const |
virtual void | SetRealTimeStamp (RealTimeStamp _arg) |
virtual const RealTimeStamp & | GetRealTimeStamp () const |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) 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 |
const char * | GetNameOfClass () const override |
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) const |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::DataObject | |
static bool | GetGlobalReleaseDataFlag () |
static void | GlobalReleaseDataFlagOff () |
static void | GlobalReleaseDataFlagOn () |
static Pointer | New () |
static void | SetGlobalReleaseDataFlag (bool val) |
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 () |
Protected Member Functions | |
ListSample ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~ListSample () override=default | |
Protected Member Functions inherited from itk::Statistics::Sample< TMeasurementVector > | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
Sample () | |
~Sample () override=default | |
Protected Member Functions inherited from itk::DataObject | |
DataObject () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | PropagateResetPipeline () |
~DataObject () override | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
InternalDataContainerType | m_InternalContainer {} |
Additional Inherited Members | |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::Statistics::ListSample< TMeasurementVector >::ConstPointer = SmartPointer<const Self> |
Definition at line 60 of file itkListSample.h.
using itk::Statistics::ListSample< TMeasurementVector >::InternalDataContainerType = std::vector<MeasurementVectorType> |
internal data container type
Definition at line 81 of file itkListSample.h.
using itk::Statistics::ListSample< TMeasurementVector >::Pointer = SmartPointer<Self> |
Definition at line 59 of file itkListSample.h.
using itk::Statistics::ListSample< TMeasurementVector >::Self = ListSample |
Standard class type alias.
Definition at line 57 of file itkListSample.h.
using itk::Statistics::ListSample< TMeasurementVector >::Superclass = Sample<TMeasurementVector> |
Definition at line 58 of file itkListSample.h.
using itk::Statistics::ListSample< TMeasurementVector >::ValueType = MeasurementVectorType |
Value type of a measurement (component of the measurement vector)
Definition at line 78 of file itkListSample.h.
|
protecteddefault |
|
overrideprotecteddefault |
|
inline |
returns an iterator that points to the beginning of the container
Definition at line 246 of file itkListSample.h.
Referenced by itk::Statistics::ListSample< TMeasurementVector >::ConstIterator::ConstIterator().
|
inline |
returns an iterator that points to the beginning of the container
Definition at line 264 of file itkListSample.h.
void itk::Statistics::ListSample< TMeasurementVector >::Clear | ( | ) |
Removes all the elements in the Sample
|
inline |
returns an iterator that points to the end of the container
Definition at line 255 of file itkListSample.h.
|
inline |
returns an iterator that points to the end of the container
Definition at line 273 of file itkListSample.h.
|
overridevirtual |
Get the frequency of a measurement. Returns 1 if the measurement exist.
Implements itk::Statistics::Sample< TMeasurementVector >.
|
overridevirtual |
Get the measurement associated with the specified InstanceIdentifier
Implements itk::Statistics::Sample< TMeasurementVector >.
|
overridevirtual |
Reimplemented from itk::DataObject.
|
overridevirtual |
Get the total frequency of the sample. This is equivalent to the size of the sample.
Implements itk::Statistics::Sample< TMeasurementVector >.
|
overridevirtual |
Method to graft another sample
Reimplemented from itk::DataObject.
|
static |
Method for creation through the object factory.
|
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::DataObject.
void itk::Statistics::ListSample< TMeasurementVector >::PushBack | ( | const MeasurementVectorType & | mv | ) |
Inserts a measurement at the end of the list
void itk::Statistics::ListSample< TMeasurementVector >::Resize | ( | InstanceIdentifier | newsize | ) |
Resize the container. Using Resize() and then SetMeasurementVector() is about nine times faster than using PushBack() continuously. Which means that whenever the total number of Measurement vectors is known, the users should prefer calling Resize() first and then set the values by calling SetMeasurementVector(). On the other hand, if the number of measurement vectors is not known from the beginning, then calling PushBack() sequentially is a convenient option.
void itk::Statistics::ListSample< TMeasurementVector >::SetMeasurement | ( | InstanceIdentifier | instanceId, |
unsigned int | dim, | ||
const MeasurementType & | value | ||
) |
Set a component a measurement to a particular value.
void itk::Statistics::ListSample< TMeasurementVector >::SetMeasurementVector | ( | InstanceIdentifier | instanceId, |
const MeasurementVectorType & | mv | ||
) |
Replace a measurement with a different measurement
|
overridevirtual |
Get the number of measurement vectors in the sample
Implements itk::Statistics::Sample< TMeasurementVector >.
|
private |
Definition at line 287 of file itkListSample.h.