LayerStatistics Class Reference

Compute summary statistics (count/min/max/avg) about a container, e.g. intensity, charge, meta values, ... More...

#include <OpenMS/VISUAL/VISITORS/LayerStatistics.h>

Inheritance diagram for LayerStatistics:

Collaboration diagram for LayerStatistics:

Public Member Functions
virtual	~LayerStatistics ()=default
	Make D'tor virtual for correct destruction from pointers to base.
const StatsMap &	getRangeStatistics () const
	get all range statistics, any of which can then be plugged into getDistribution()
const StatsCounterMap &	getCountStatistics () const
	obtain count statistics for all meta values which are not numerical
virtual Math::Histogram	getDistribution (const RangeStatsType &which, const UInt number_of_bins=500) const =0
	After computing the overview statistic, you can query a concrete distribution by giving the name of the statistic.

Protected Member Functions
virtual void	computeStatistics_ ()=0
	compute the range and count statistics. Call this method in the Ctor of derived classes.
void	bringInMetaStats_ (const MetaInfoInterface *meta_interface)
	Brings the meta values of one meta_interface (a peak or feature) into the statistics.

Protected Attributes
StatsMap	overview_range_data_
	data on numerical values computed during getOverviewStatistics
StatsCounterMap	overview_count_data_
	count data on non-numerical values computed during getOverviewStatistics

Detailed Description

Compute summary statistics (count/min/max/avg) about a container, e.g. intensity, charge, meta values, ...

Constructor & Destructor Documentation

~LayerStatistics()

virtual ~LayerStatistics ( )

virtualdefault

Make D'tor virtual for correct destruction from pointers to base.

Member Function Documentation

bringInMetaStats_()

void bringInMetaStats_ ( const MetaInfoInterface *  meta_interface )

protected

Brings the meta values of one meta_interface (a peak or feature) into the statistics.

computeStatistics_()

virtual void computeStatistics_ ( )

protectedpure virtual

compute the range and count statistics. Call this method in the Ctor of derived classes.

Implemented in LayerStatisticsPeakMap, LayerStatisticsFeatureMap, LayerStatisticsConsensusMap, and LayerStatisticsIdent.

getCountStatistics()

const StatsCounterMap & getCountStatistics ( ) const

inline

obtain count statistics for all meta values which are not numerical

getDistribution()

virtual Math::Histogram getDistribution ( const RangeStatsType &  which, const UInt  number_of_bins = 500  ) const

pure virtual

After computing the overview statistic, you can query a concrete distribution by giving the name of the statistic.

Parameters

[in]	which	Distribution based on which data?
[in]	number_of_bins	Number of histogram bins (equally spaced within [min,max] of the distribution)

Returns

The distribution

Exceptions

Exception::InvalidValue

if which is not a valid overview statistic for the underlying data

Implemented in LayerStatisticsPeakMap, LayerStatisticsFeatureMap, LayerStatisticsConsensusMap, and LayerStatisticsIdent.

getRangeStatistics()

const StatsMap & getRangeStatistics ( ) const

inline

get all range statistics, any of which can then be plugged into getDistribution()

Member Data Documentation

overview_count_data_

StatsCounterMap overview_count_data_

protected

count data on non-numerical values computed during getOverviewStatistics

overview_range_data_

StatsMap overview_range_data_

protected

data on numerical values computed during getOverviewStatistics