Package pulse.tasks.processing

Class AverageResult

java.lang.Object

pulse.util.UpwardsNavigable

pulse.tasks.processing.AbstractResult

pulse.tasks.processing.AverageResult

All Implemented Interfaces:

Serializable, Descriptive

public class AverageResult
extends AbstractResult

An AverageResult is obtained by averaging a list of AbstractResults and calculating the associated errors of averaging.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	SIGNIFICANT_FIGURES

Constructor Summary

Constructors

Constructor	Description
AverageResult(List<AbstractResult> res, ResultFormat resultFormat)	This will create an AverageResult based on the AbstractResult in res.

Method Summary

Modifier and Type	Method	Description
List<AbstractResult>	getIndividualResults()	This will analyse the list of AbstractResults used for calculation of the mean and find all associated individual results.

Methods inherited from class pulse.tasks.processing.AbstractResult

addProperty, equals, filterProperties, filterProperties, getFormat, getProperties, getProperty, setFormat, toString

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, describe, getHierarchyListeners, getParent, identify, initListeners, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SIGNIFICANT_FIGURES

public static final int SIGNIFICANT_FIGURES

See Also:

Constant Field Values

Constructor Detail

AverageResult

public AverageResult(List<AbstractResult> res,
                     ResultFormat resultFormat)

This will create an AverageResult based on the AbstractResult in res.

It will also use the resultFormat. A method will be invoked to: (a) calculate the mean values of the list of NumericProperty according to the resultFormat; (b) calculate the statistical error; (c) create a BigDecimal representation of the values and the errors, so that only 2 significant figures are left for consistency between the value and the error.

Parameters:

res - a list of AbstractResults that are going to be averaged (not necessarily instances of Result).

resultFormat - the ResultFormat, which will be used for this AveragedResult.

Method Detail

getIndividualResults

public List<AbstractResult> getIndividualResults()

This will analyse the list of AbstractResults used for calculation of the mean and find all associated individual results.

If it is established that some instances of AverageResult were used in the calculation, this will invoke this method recursively to get a full list of AbstractResults that are not AverageResults

Returns:

a list of AbstractResults that are guaranteed not to be AveragedResults.