Package pulse

Class HeatingCurve

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.AbstractData

pulse.HeatingCurve

All Implemented Interfaces:

Serializable, Descriptive

public class HeatingCurve
extends AbstractData

The HeatingCurve represents a time-temperature profile (a AbstractData instance) generated using a calculation algorithm implemented by a Problem's Solver. In addition to the time and signal lists defined in the super-class, it features baseline-corrected signal values stored in a separate list.The HeatingCurve may have HeatingCurveListeners to process simple events. To enable comparison with ExperimentalData, a HeatingCurve builds a spline interpolation of its time - baseline-adjusted signal values, thus representing a continuous curve, rather than just a collection of discrete data.

See Also:

HeatingCurveListener, org.apache.commons.math3.analysis.interpolation.UnivariateInterpolation, Serialized Form

Field Summary

Fields inherited from class pulse.AbstractData

signal, time

Constructor Summary

Constructors

Modifier	Constructor	Description
	HeatingCurve()	Calls the super-constructor and initialises the baseline-corrected signal list.
protected	HeatingCurve(List<Double> time, List<Double> signal, double startTime, String name)
	HeatingCurve(HeatingCurve c)	Copy constructor.
	HeatingCurve(NumericProperty count)	Creates a HeatingCurve, where the number of elements in the time, signal, and adjustedSignal collections are set to count.getValue().

Method Summary

Modifier and Type	Method	Description
void	addHeatingCurveListener(HeatingCurveListener l)
void	apply(Baseline baseline)	Adds the baseline value to each element of the signal list.
void	clear()	Clears all elements from the three List objects, thus releasing memory.
void	copyToLastCalculation()
boolean	equals(Object o)
HeatingCurve	extendedTo(ExperimentalData data, Baseline baseline)	This creates a new HeatingCurve to match the time boundaries of the data.
List<Double>	getBaselineCorrectedData()
org.apache.commons.math3.analysis.UnivariateFunction	getInterpolation()
NumericProperty	getTimeShift()	The time shift is the position of the 'zero-time'.
void	initListeners()
double	interpolateSignalAt(double x)
Set<NumericPropertyKeyword>	listedKeywords()	Lists NUM_POINTS as an accessible property of this PropertyHolder.
double	maxAdjustedSignal()	Retrieves the simple maximum (in arbitrary units) of the baseline-corrected temperature list.
void	remove(int i)	Removes an element with the index i from all three Lists (time, signal, and baseline-corrected signal).
void	removeListeners()
void	scale(double scale)	Scales the temperature values by a factor of scale.
void	set(NumericPropertyKeyword type, NumericProperty property)	Calls super.set and provides write access to the TIME_SHIFT property.
void	setTimeShift(NumericProperty startTime)	Sets the time shift and triggers TIME_ORIGIN_CHANGED in CurveEvent.
double	signalAt(int index)	Retrieves the baseline-corrected temperature corresponding to index in the respective List.
double	timeAt(int index)	Retrieves the time from the stored list of values, adding the value of startTime to the result.

Methods inherited from class pulse.AbstractData

actualNumPoints, addPoint, apparentMaximum, getName, getNumPoints, getSignalData, getTimeSequence, ignoreSiblings, incrementCount, isFull, setName, setNumPoints, setSignalAt, setTimeAt, timeLimit, toString

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, isListedNumericType, isListedParameter, listedTypes, numericData, parameterListChanged, 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, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HeatingCurve

protected HeatingCurve(List<Double> time,
                       List<Double> signal,
                       double startTime,
                       String name)

HeatingCurve

public HeatingCurve()

Calls the super-constructor and initialises the baseline-corrected signal list. Creates a SplineInterpolator object.

HeatingCurve

public HeatingCurve(HeatingCurve c)

Copy constructor. In addition to copying the data, also re-builds the splines.

Parameters:

c - another instance of this class

See Also:

refreshInterpolation()

HeatingCurve

public HeatingCurve(NumericProperty count)

Creates a HeatingCurve, where the number of elements in the time, signal, and adjustedSignal collections are set to count.getValue(). The time shift is initialized with a default value.

Parameters:

count - The NumericProperty that is derived from the NumericPropertyKeyword.NUMPOINTS.

Method Detail

initListeners

public void initListeners()

Overrides:

initListeners in class PropertyHolder

copyToLastCalculation

public void copyToLastCalculation()

clear

public void clear()

Description copied from class: AbstractData

Clears all elements from the three List objects, thus releasing memory.

Overrides:

clear in class AbstractData

timeAt

public double timeAt(int index)

Retrieves the time from the stored list of values, adding the value of startTime to the result.

Overrides:

timeAt in class AbstractData

Parameters:

index - the index of the element to be returned

Returns:

time at index + startTime

signalAt

public double signalAt(int index)

Retrieves the baseline-corrected temperature corresponding to index in the respective List.

Overrides:

signalAt in class AbstractData

Parameters:

index - the index of the element

Returns:

a double, representing the baseline-corrected temperature at index

scale

public void scale(double scale)

Scales the temperature values by a factor of scale.

This is done by manually setting each temperature value to T*scale, where T is the current temperature value at this index. Finally. applies the baseline to the scaled temperature values.

This method is used in the DifferenceScheme subclasses when a dimensionless solution needs to be re-scaled to the given maximum temperature (usually matching the ExperimentalData, but also used as a search variable by the SearchTask.

Triggers a RESCALED CurveEvent.

Parameters:

scale - the scale

See Also:

DifferenceScheme, Problem, SearchTask, CurveEvent

maxAdjustedSignal

public double maxAdjustedSignal()

Retrieves the simple maximum (in arbitrary units) of the baseline-corrected temperature list.

Returns:

the simple maximum of the baseline-adjusted temperature.

apply

public void apply(Baseline baseline)

Adds the baseline value to each element of the signal list.

The baseline.valueAt method is explicitly invoked for all time values, and the result of adding the baseline value to the corresponding signal is assigned to a position in the adjustedSignal list.

Parameters:

baseline - the baseline. Note it may not specifically belong to this heating curve.

extendedTo

public final HeatingCurve extendedTo(ExperimentalData data,
                                     Baseline baseline)

This creates a new HeatingCurve to match the time boundaries of the data.

Curves derived in this way are called extended and are used primarily to visually inspect how the calculated baseline correlates with the data at times t < 0. This method is not used in any calculation and is introduced primarily because the search for the reverse solution of the heat problems only regards time value at $t\ge 0$, whereas in reality it may not be consistent with the experimental baseline value at t < 0.

Parameters:

data - the experimental data, with a time range broader than the time range of this HeatingCurve.

baseline -

Returns:

a new HeatingCurve, extended to match the time limits of data

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Calls super.set and provides write access to the TIME_SHIFT property.

Overrides:

set in class AbstractData

Parameters:

property - the property of the type NumericPropertyKeyword.NUMPOINTS

type - must be equal to NumericPropertyKeyword.NUMPOINTS

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: AbstractData

Lists NUM_POINTS as an accessible property of this PropertyHolder.

Overrides:

listedKeywords in class AbstractData

Returns:

TIME_SHIFT and NUM_POINTS.

remove

public void remove(int i)

Removes an element with the index i from all three Lists (time, signal, and baseline-corrected signal).

Overrides:

remove in class AbstractData

Parameters:

i - the element to be removed

getTimeShift

public NumericProperty getTimeShift()

The time shift is the position of the 'zero-time'.

Returns:

a TIME_SHIFT property

setTimeShift

public void setTimeShift(NumericProperty startTime)

Sets the time shift and triggers TIME_ORIGIN_CHANGED in CurveEvent. Triggers the firePropertyChanged.

Parameters:

startTime - the new start time value

getInterpolation

public org.apache.commons.math3.analysis.UnivariateFunction getInterpolation()

getBaselineCorrectedData

public List<Double> getBaselineCorrectedData()

addHeatingCurveListener

public void addHeatingCurveListener(HeatingCurveListener l)

removeListeners

public void removeListeners()

Overrides:

removeListeners in class PropertyHolder

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractData

Returns:

true only if o is an AbstractData containing all the elements of the time and signal lists of this object.

interpolateSignalAt

public double interpolateSignalAt(double x)