aimsdata  5.1.2
Neuroimaging data handling
aims::ScalarFeaturesProvider Class Referenceabstract

This class should be inherited by all subclasses that provides scalar features. More...

#include <aims/features/features.h>

Inheritance diagram for aims::ScalarFeaturesProvider:
Collaboration diagram for aims::ScalarFeaturesProvider:

Public Types

typedef double Scalar_t
 

Public Member Functions

virtual ~ScalarFeaturesProvider ()
 
const std::vector< std::string > & scalarFeatureNames () const
 Return the name of all scalar features provided by this object. More...
 
virtual void scalarFeatureValues (std::vector< Scalar_t > &) const =0
 Clear an fill its parameter with the values of the scalar features. More...
 

Protected Attributes

std::vector< std::string > _scalarFeatureNames
 Constructors of derived classes must fill this vector with scalar feature names. More...
 

Detailed Description

This class should be inherited by all subclasses that provides scalar features.

A scalar feature is a named scalar value.

Definition at line 52 of file features.h.

Member Typedef Documentation

◆ Scalar_t

Definition at line 55 of file features.h.

Constructor & Destructor Documentation

◆ ~ScalarFeaturesProvider()

aims::ScalarFeaturesProvider::~ScalarFeaturesProvider ( )
inlinevirtual

Definition at line 82 of file features.h.

Member Function Documentation

◆ scalarFeatureNames()

const std::vector< std::string > & aims::ScalarFeaturesProvider::scalarFeatureNames ( ) const
inline

Return the name of all scalar features provided by this object.

Definition at line 87 of file features.h.

References _scalarFeatureNames.

◆ scalarFeatureValues()

virtual void aims::ScalarFeaturesProvider::scalarFeatureValues ( std::vector< Scalar_t > &  ) const
pure virtual

Clear an fill its parameter with the values of the scalar features.

The returned vector has the same size as the one returned by scalarFeatureNames().

Implemented in aims::PointsInImageFeatures, and aims::ScalarSetFeatures.

Member Data Documentation

◆ _scalarFeatureNames

std::vector< std::string > aims::ScalarFeaturesProvider::_scalarFeatureNames
protected

Constructors of derived classes must fill this vector with scalar feature names.

Definition at line 73 of file features.h.

Referenced by scalarFeatureNames().


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