Package pulse.baseline

Class Baseline

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.baseline.Baseline

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

AdjustableBaseline

public abstract class Baseline
extends PropertyHolder
implements Reflexive, Optimisable

An abstract class for baseline calculations. Defines an abstract valueAt method that would return a baseline value at a given moment in time (either before or after the laser pulse). The baseline parameters can be modified within an optimisation loop, hence there are two abstract methods to implement that functionality.

See Also:

HeatingCurve, SearchTask, ParameterVector, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	MIN_BASELINE_POINTS

Constructor Summary

Constructors

Constructor	Description
Baseline()

Method Summary

Modifier and Type	Method	Description
abstract Baseline	copy()
protected abstract void	doFit(List<Double> x, List<Double> y)	Calculates the baseline parameters based on input arguments.
void	fitTo(List<Double> x, List<Double> y)
void	fitTo(DiscreteInput data)	Calls fitTo using the default time range for the data: -Infinity < t < ZERO_LEFT, where the upper bound is a small negative constant.
String	getDescriptor()	If not null, will return the prefix, otherwise calls the superclass method.
abstract double	valueAt(double x)	Calculates the baseline at the given position.

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, 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, set, 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

Methods inherited from interface pulse.search.Optimisable

assign, optimisationVector

Field Detail

MIN_BASELINE_POINTS

public static final int MIN_BASELINE_POINTS

See Also:

Constant Field Values

Constructor Detail

Baseline

public Baseline()

Method Detail

copy

public abstract Baseline copy()

valueAt

public abstract double valueAt(double x)

Calculates the baseline at the given position.

Parameters:

x - the position on the profile (e.g., the time value)

Returns:

the baseline value

doFit

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

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.

Parameters:

x -

y -

fitTo

public void fitTo(DiscreteInput data)

Calls fitTo using the default time range for the data: -Infinity < t < ZERO_LEFT, where the upper bound is a small negative constant.

Parameters:

data - the experimental data stretching to negative time values

See Also:

fitTo(ExperimentalData,double,double)

fitTo

public void fitTo(List<Double> x,
                  List<Double> y)

getDescriptor

public String getDescriptor()

Description copied from class: PropertyHolder

If not null, will return the prefix, otherwise calls the superclass method.

Overrides:

getDescriptor in class PropertyHolder

Returns:

the descriptor

See Also:

Group.getSimpleName()