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

Inheritance diagram for LayerStatisticsPeakMap:

Collaboration diagram for LayerStatisticsPeakMap:

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 StatsMap &	getRangeStatistics () const
	get all range statistics, any of which can then be plugged into getDistribution() More...

const StatsCounterMap &	getCountStatistics () 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...

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 ( const PeakMap & pm )

void computeStatistics_ ( )

overrideprivatevirtual

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

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

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

Exceptions

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

const PeakMap* pm_

private

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