Package pulse.search.statistics

Class ResidualStatistic

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.search.statistics.Statistic

pulse.search.statistics.ResidualStatistic

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

Direct Known Subclasses:

NormalityTest, OptimiserStatistic

public abstract class ResidualStatistic
extends Statistic

An abstract statistic (= a numeric value resulting from a statistical procedure) that operates with model residuals. The list of residuals is stored in a field value for objects of this class. Each SearchTask will have at least two ResidualStatistics associated with its Calculations.

See Also:

SearchTask, Calculation, Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResidualStatistic()
ResidualStatistic(ResidualStatistic another)

Method Summary

Modifier and Type	Method	Description
void	calculateResiduals(DiscreteInput reference, Response estimate)
void	calculateResiduals(DiscreteInput reference, Response estimate, int min, int max)	This will calculate the residuals for the task using the time sequence defined by the ExperimentalData object.The residuals are calculated between the model, which was previously used to populate the HeatingCurveand the experimental data.The temperature value of the model at the reference time is $t_i$.and unknown a priori.
void	calculateResiduals(GeneralTask task)
boolean	equals(Object obj)
List<Double>	getResiduals()
NumericProperty	getStatistic()
List<Double>	getTimeSequence()
int	hashCode()
double[]	residualsArray()
void	set(NumericPropertyKeyword type, NumericProperty property)	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible.
void	setStatistic(NumericProperty statistic)

Methods inherited from class pulse.search.statistics.Statistic

evaluate

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedKeywords, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResidualStatistic

public ResidualStatistic()

ResidualStatistic

public ResidualStatistic(ResidualStatistic another)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

calculateResiduals

public final void calculateResiduals(DiscreteInput reference,
                                     Response estimate,
                                     int min,
                                     int max)

This will calculate the residuals for the task using the time sequence defined by the ExperimentalData object.The residuals are calculated between the model, which was previously used to populate the HeatingCurveand the experimental data.The temperature value of the model at the reference time is $t_i$.and unknown a priori. Therefore, it needs to be interpolated based on the discrete dataset generated by the solver. The interpolation is currently done using natural cubic splines, which are re-constructed each time a new solution is generated. Therefore, calling this method does not involve expensive calculation of the spline coefficents. The residuals are calculated only for the range that is specified by the ExperimentalData reference. The output of this method is stored in the field of the residuals object.

Parameters:

reference -

estimate -

See Also:

ExperimentalData, HeatingCurve

calculateResiduals

public void calculateResiduals(DiscreteInput reference,
                               Response estimate)

residualsArray

public double[] residualsArray()

calculateResiduals

public final void calculateResiduals(GeneralTask task)

getResiduals

public List<Double> getResiduals()

getTimeSequence

public List<Double> getTimeSequence()

getStatistic

public NumericProperty getStatistic()

setStatistic

public void setStatistic(NumericProperty statistic)

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Description copied from class: Accessible

An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

Specified by:

set in class Accessible

Parameters:

type - the type, which must be equal by definition to property.getType().

property - the property, which contains new information.