Package pulse.baseline

Class LinearBaseline

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.baseline.Baseline

pulse.baseline.AdjustableBaseline

pulse.baseline.LinearBaseline

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

SinusoidalBaseline

public class LinearBaseline
extends AdjustableBaseline

A linear Baseline which specifies the intercept and slope parameters.

The mathematical equivalent is the following expression: g(x) = intercept + slope * x. The NumericPropertyKeyword associated with the intercept and slope parameters can be used as fitting variables.

See Also:

HeatingCurve, SearchTask, ParameterVector, Serialized Form

Field Summary

Fields inherited from class pulse.baseline.Baseline

MIN_BASELINE_POINTS

Constructor Summary

Constructors

Constructor	Description
LinearBaseline()	A primitive constructor, which initialises a CONSTANT baseline with zero intercept and slope.
LinearBaseline(double intercept, double slope)
LinearBaseline(AdjustableBaseline baseline)

Method Summary

Modifier and Type	Method	Description
void	assign(ParameterVector params)	Assigns parameter values of this Problem using the optimisation vector params.
Baseline	copy()
protected void	doFit(List<Double> x, List<Double> y)	Calculates the baseline parameters based on input arguments.
Set<NumericPropertyKeyword>	listedKeywords()	Lists the intercept as accessible property for this FlatBaseline.
void	optimisationVector(ParameterVector output)	Calculates the vector argument defined on $$Rn to the scalar objective function for this Optimisable.
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.
String	toString()

Methods inherited from class pulse.baseline.AdjustableBaseline

getIntercept, getSlope, mean, setIntercept, setSlope, valueAt

Methods inherited from class pulse.baseline.Baseline

fitTo, fitTo, getDescriptor

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LinearBaseline

public LinearBaseline()

A primitive constructor, which initialises a CONSTANT baseline with zero intercept and slope.

LinearBaseline

public LinearBaseline(double intercept,
                      double slope)

LinearBaseline

public LinearBaseline(AdjustableBaseline baseline)

Method Detail

doFit

protected void doFit(List<Double> x,
                     List<Double> y)

Description copied from class: Baseline

Calculates the baseline parameters based on input arguments.

This usually runs a simple least-squares estimation of the parameters of this baseline using the specified data within the time range rangeMin < t < rangeMax. If no data is available, the method will NOT change the baseline parameters. Upon completion, the method will use the respective set methods of this class to update the parameter values, triggering whatever events are associated with them.

Specified by:

doFit in class Baseline

toString

public String toString()

Overrides:

toString in class Object

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.

Overrides:

set in class AdjustableBaseline

Parameters:

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

property - the property, which contains new information.

optimisationVector

public void optimisationVector(ParameterVector output)

Description copied from interface: Optimisable

Calculates the vector argument defined on $$Rⁿ to the scalar objective function for this Optimisable.

Specified by:

optimisationVector in interface Optimisable

Overrides:

optimisationVector in class AdjustableBaseline

Parameters:

output - the output vector where the result will be stored

assign

public void assign(ParameterVector params)

Assigns parameter values of this Problem using the optimisation vector params. Only those parameters will be updated, the types of which are listed as indices in the params vector.

Specified by:

assign in interface Optimisable

Overrides:

assign in class AdjustableBaseline

Parameters:

params - the optimisation vector, containing a similar set of parameters to this Problem

See Also:

PropertyHolder.listedTypes()

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: AdjustableBaseline

Lists the intercept as accessible property for this FlatBaseline.

Overrides:

listedKeywords in class AdjustableBaseline

Returns:

a set containing BASELINE_INTERCEPT and BASELINE_SLOPE keywords

See Also:

PropertyHolder

copy

public Baseline copy()

Specified by:

copy in class Baseline