OpenMS  2.8.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LayerStatistics Class Referenceabstract

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:
[legend]
Collaboration diagram for LayerStatistics:
[legend]

Public Member Functions

const StatsMapgetRangeStatistics () const
 get all range statistics, any of which can then be plugged into getDistribution() More...
 
const StatsCounterMapgetCountStatistics () const
 obtain count statistics for all meta values which are not numerical More...
 
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. More...
 

Protected Member Functions

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

Protected Attributes

StatsMap overview_range_data_
 data on numerical values computed during getOverviewStatistics More...
 
StatsCounterMap overview_count_data_
 count data on non-numerical values computed during getOverviewStatistics More...
 

Detailed Description

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

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 LayerStatisticsIdent, LayerStatisticsConsensusMap, LayerStatisticsFeatureMap, and LayerStatisticsPeakMap.

◆ 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
whichDistribution based on which data?
number_of_binsNumber of histogram bins (equally spaced within [min,max] of the distribution)
Returns
The distribution
Exceptions
Exception::InvalidValueif which is not a valid overview statistic for the underlying data

Implemented in LayerStatisticsIdent, LayerStatisticsConsensusMap, LayerStatisticsFeatureMap, and LayerStatisticsPeakMap.

◆ 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