OpenMS
LayerStatisticsPeakMap Class Reference

Computes statistics and distributions for a PeakMap. More...

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

Inheritance diagram for LayerStatisticsPeakMap:
[legend]
Collaboration diagram for LayerStatisticsPeakMap:
[legend]

Public Member Functions

 LayerStatisticsPeakMap (const PeakMap &pm)
 
Math::Histogram getDistribution (const RangeStatsType &which, const UInt number_of_bins) const override
 After computing the overview statistic, you can query a concrete distribution by giving the name of the statistic. More...
 
- Public Member Functions inherited from LayerStatistics
virtual ~LayerStatistics ()=default
 Make D'tor virtual for correct destruction from pointers to base. More...
 
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...
 

Private Member Functions

void computeStatistics_ () override
 compute the range and count statistics. Call this method in the Ctor of derived classes. More...
 

Private Attributes

const PeakMappm_
 

Additional Inherited Members

- Protected Member Functions inherited from LayerStatistics
void bringInMetaStats_ (const MetaInfoInterface *meta_interface)
 Brings the meta values of one meta_interface (a peak or feature) into the statistics. More...
 
- Protected Attributes inherited from LayerStatistics
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

Computes statistics and distributions for a PeakMap.

Constructor & Destructor Documentation

◆ LayerStatisticsPeakMap()

Member Function Documentation

◆ computeStatistics_()

void computeStatistics_ ( )
overrideprivatevirtual

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

Implements LayerStatistics.

◆ getDistribution()

Math::Histogram getDistribution ( const RangeStatsType which,
const UInt  number_of_bins 
) const
overridevirtual

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

Implements LayerStatistics.

Member Data Documentation

◆ pm_

const PeakMap* pm_
private

internal reference to a PeakMap – make sure it does not go out of scope while using this class