Package pulse.baseline

Class SinusoidalBaseline

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.baseline.Baseline

pulse.baseline.AdjustableBaseline

pulse.baseline.LinearBaseline

pulse.baseline.SinusoidalBaseline

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

public class SinusoidalBaseline
extends LinearBaseline

A multiple-harmonic baseline. Replaces the Sinusoidal baseline in previous version.

See Also:

Serialized Form

Field Summary

Fields inherited from class pulse.baseline.Baseline

MIN_BASELINE_POINTS

Constructor Summary

Constructors

Constructor	Description
SinusoidalBaseline()	Creates a sinusoidal baseline with default properties.

Method Summary

Modifier and Type	Method	Description
void	assign(ParameterVector output)	Assigns parameter values of this Problem using the optimisation vector params.
Baseline	copy()
void	fitTo(DiscreteInput input)	Calls fitTo using the default time range for the data: -Infinity < t < ZERO_LEFT, where the upper bound is a small negative constant.
List<Harmonic>	getHarmonics()
NumericProperty	getHiFreqMax()
NumericProperty	getLowFreqMax()
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.
void	setHiFreqMax(NumericProperty maxHarmonics)
void	setLowFreqMax(NumericProperty maxHarmonics)
List<Group>	subgroups()	Tries to access getter methods to retrieve all Accessible instances belonging to this object.
String	toString()
double	valueAt(double x)	Calculates the linear function g(x) = intercept + slope*time

Methods inherited from class pulse.baseline.LinearBaseline

doFit

Methods inherited from class pulse.baseline.AdjustableBaseline

getIntercept, getSlope, mean, setIntercept, setSlope

Methods inherited from class pulse.baseline.Baseline

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

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

SinusoidalBaseline

public SinusoidalBaseline()

Creates a sinusoidal baseline with default properties.

Method Detail

valueAt

public double valueAt(double x)

Description copied from class: AdjustableBaseline

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

Overrides:

valueAt in class AdjustableBaseline

Parameters:

x - the argument of the linear function

Returns:

the result of this simple calculation

copy

public Baseline copy()

Overrides:

copy in class LinearBaseline

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 LinearBaseline

Parameters:

output - the output vector where the result will be stored

assign

public void assign(ParameterVector output)

Description copied from class: LinearBaseline

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 LinearBaseline

Parameters:

output - 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 LinearBaseline

Returns:

a set containing BASELINE_INTERCEPT and BASELINE_SLOPE keywords

See Also:

PropertyHolder

subgroups

public List<Group> subgroups()

Description copied from class: Group

Tries to access getter methods to retrieve all Accessible instances belonging to this object. Ignores any methods that return instances of the same class as this one.

Overrides:

subgroups in class Group

Returns:

a List containing Accessible objects which could be accessed by the declared getter methods.

getHarmonics

public List<Harmonic> getHarmonics()

getHiFreqMax

public NumericProperty getHiFreqMax()

setHiFreqMax

public void setHiFreqMax(NumericProperty maxHarmonics)

getLowFreqMax

public NumericProperty getLowFreqMax()

setLowFreqMax

public void setLowFreqMax(NumericProperty maxHarmonics)

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 LinearBaseline

Parameters:

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

property - the property, which contains new information.

fitTo

public void fitTo(DiscreteInput input)

Description copied from class: Baseline

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

Overrides:

fitTo in class Baseline

Parameters:

input - the experimental data stretching to negative time values

See Also:

fitTo(ExperimentalData,double,double)

toString

public String toString()

Overrides:

toString in class LinearBaseline