infrared.infrared.FeatureStatistics Class Reference

Keeping statistics on features. More...

Public Member Functions
	__init__ (self, keep=False)
	Construct.
	record_features (self, features, values)
	Record feature values.
	empty (self)
	Check whether any features have been recorded.
	means (self)
	Means of recorded features.
	variances (self)
	Variances of recorded features.
	stds (self)
	Standard deviations of recorded features.
	report (self)
	Report features to standard output.

Public Attributes
	keep
	identifier
	count
	sums
	sqsums
	features

Detailed Description

Keeping statistics on features.

This class allows recording values of multiple features for a series of samples; it can be queried for mean and standard deviation (or the entire distribution) of each recorded feature.

Constructor & Destructor Documentation

__init__()

infrared.infrared.FeatureStatistics.__init__	(		self,
			keep = False
	)

Construct.

Parameters

keep	Keep all recorded features in memory. Defaults to False

Member Function Documentation

empty()

infrared.infrared.FeatureStatistics.empty

(

self

)

Check whether any features have been recorded.

Returns

whether empty (since no feature has been recorded)

means()

infrared.infrared.FeatureStatistics.means

(

self

)

Means of recorded features.

Returns

dictionary of means (at feature ids as keys)

record_features()

infrared.infrared.FeatureStatistics.record_features	(		self,
			features,
			values
	)

Record feature values.

Parameters

features	a dictionary of features
values	a corresponding dictionary of the feature values

Returns

pair of feature id string and value

report()

infrared.infrared.FeatureStatistics.report

(

self

)

Report features to standard output.

stds()

infrared.infrared.FeatureStatistics.stds

(

self

)

Standard deviations of recorded features.

Returns

dictionary of standard deviations (at feature ids as keys)

variances()

infrared.infrared.FeatureStatistics.variances

(

self

)

Variances of recorded features.

Returns

dictionary of variances (at feature ids as keys)

Member Data Documentation

count

infrared.infrared.FeatureStatistics.count

features

infrared.infrared.FeatureStatistics.features

identifier

infrared.infrared.FeatureStatistics.identifier

keep

infrared.infrared.FeatureStatistics.keep

sqsums

infrared.infrared.FeatureStatistics.sqsums

sums

infrared.infrared.FeatureStatistics.sums

---

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

• src/infrared/infrared.py