LayerStatisticsConsensusMap Class Reference

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

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

Inheritance diagram for LayerStatisticsConsensusMap:

Collaboration diagram for LayerStatisticsConsensusMap:

Public Member Functions
	LayerStatisticsConsensusMap (const ConsensusMap &cm)
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.
Public Member Functions inherited from LayerStatistics
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

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

Private Attributes
const ConsensusMap *	cm_

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.
Protected Attributes inherited from LayerStatistics
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

Computes statistics and distributions for a PeakMap.

Constructor & Destructor Documentation

LayerStatisticsConsensusMap()

LayerStatisticsConsensusMap

(

const ConsensusMap &

cm

)

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

[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

Implements LayerStatistics.

Member Data Documentation

cm_

const ConsensusMap* cm_

private

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