Package pulse.baseline

Class AdjustableBaseline

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.baseline.Baseline

pulse.baseline.AdjustableBaseline

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

FlatBaseline, LinearBaseline

public abstract class AdjustableBaseline
extends Baseline

A baseline that can shift in the vertical direction.

Author:

Artem Lunev

See Also:

Serialized Form

Field Summary

Fields inherited from class pulse.baseline.Baseline

MIN_BASELINE_POINTS

Constructor Summary

Constructors

Constructor	Description
AdjustableBaseline(double intercept, double slope)	Creates a flat baseline equal to the argument.

Method Summary

Modifier and Type	Method	Description
void	assign(ParameterVector params)	Assigns parameter values of this Optimisable using the optimisation vector params.
NumericProperty	getIntercept()	Provides getter accessibility to the intercept as a NumericProperty
NumericProperty	getSlope()	Provides getter accessibility to the slope as a NumericProperty
Set<NumericPropertyKeyword>	listedKeywords()	Lists the intercept as accessible property for this FlatBaseline.
protected double	mean(List<Double> x)
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.
void	setIntercept(NumericProperty intercept)	Checks whether intercept is a baseline intercept property and updates the respective value of this baseline.
void	setSlope(NumericProperty slope)	Checks whether slope is a baseline slope property and updates the respective value of this baseline.
double	valueAt(double x)	Calculates the linear function g(x) = intercept + slope*time

Methods inherited from class pulse.baseline.Baseline

copy, doFit, 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, toString, wait, wait, wait

Constructor Detail

AdjustableBaseline

public AdjustableBaseline(double intercept,
                          double slope)

Creates a flat baseline equal to the argument.

Parameters:

intercept - the constant baseline value.

Method Detail

valueAt

public double valueAt(double x)

Calculates the linear function g(x) = intercept + slope*time

Specified by:

valueAt in class Baseline

Parameters:

x - the argument of the linear function

Returns:

the result of this simple calculation

mean

protected double mean(List<Double> x)

getIntercept

public NumericProperty getIntercept()

Provides getter accessibility to the intercept as a NumericProperty

Returns:

a NumericProperty derived from NumericPropertyKeyword.BASELINE_INTERCEPT where the value is set to that of slope

setIntercept

public void setIntercept(NumericProperty intercept)

Checks whether intercept is a baseline intercept property and updates the respective value of this baseline.

Parameters:

intercept - a NumericProperty of the BASELINE_INTERCEPT type

See Also:

set(pulse.properties.NumericPropertyKeyword,pulse.properties.NumericProperty)

getSlope

public NumericProperty getSlope()

Provides getter accessibility to the slope as a NumericProperty

Returns:

a NumericProperty derived from NumericPropertyKeyword.BASELINE_SLOPE with a value equal to slop

setSlope

public void setSlope(NumericProperty slope)

Checks whether slope is a baseline slope property and updates the respective value of this baseline.

Parameters:

slope - a NumericProperty of the BASELINE_SLOPE type

See Also:

set(pulse.properties.NumericPropertyKeyword,pulse.properties.NumericProperty)

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Lists the intercept as accessible property for this FlatBaseline.

Overrides:

listedKeywords in class PropertyHolder

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

See Also:

PropertyHolder

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.

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.

Parameters:

output - the output vector where the result will be stored

assign

public void assign(ParameterVector params)

Description copied from interface: Optimisable

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

Parameters:

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