Package pulse.problem.laser

Class NumericPulse

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.laser.PulseTemporalShape

pulse.problem.laser.NumericPulse

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

public class NumericPulse
extends PulseTemporalShape

A numeric pulse is given by a set of discrete NumericPulseData measured independently using a pulse diode.

See Also:

NumericPulseData, Serialized Form

Constructor Summary

Constructors

Constructor	Description
NumericPulse()
NumericPulse(NumericPulse pulse)	Copy constructor

Method Summary

Modifier and Type	Method	Description
PulseTemporalShape	copy()
double	evaluateAt(double time)	If the argument is less than the pulse width, uses a spline to interpolate the pulse data at time.
NumericPulseData	getData()
org.apache.commons.math3.analysis.UnivariateFunction	getInterpolation()
int	getRequiredDiscretisation()
void	init(ExperimentalData data, DiscretePulse pulse)	Defines the pulse width as the last element of the time sequence contained in NumericPulseData.
void	set(NumericPropertyKeyword type, NumericProperty property)	Does not define any property.
void	setData(NumericPulseData pulseData)

Methods inherited from class pulse.problem.laser.PulseTemporalShape

getPrefix, getPulseWidth, setPulseWidth, toString

Methods inherited from class pulse.util.PropertyHolder

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

NumericPulse

public NumericPulse()

NumericPulse

public NumericPulse(NumericPulse pulse)

Copy constructor

Parameters:

pulse - another numeric pulse, the data of which will be copied

Method Detail

init

public void init(ExperimentalData data,
                 DiscretePulse pulse)

Defines the pulse width as the last element of the time sequence contained in NumericPulseData. Calls super.init, then interpolates the input pulse using spline functions and normalises the output.

Overrides:

init in class PulseTemporalShape

Parameters:

data -

pulse - the discrete pulse containing the pulse width

See Also:

normalise()

evaluateAt

public double evaluateAt(double time)

If the argument is less than the pulse width, uses a spline to interpolate the pulse data at time. Otherwise returns zero.

Specified by:

evaluateAt in class PulseTemporalShape

Parameters:

time - the dimensionless time (a multiplier of tau), at which calculation should be performed

Returns:

a double value, representing the pulse function at time

copy

public PulseTemporalShape copy()

Specified by:

copy in class PulseTemporalShape

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Does not define any 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.

getData

public NumericPulseData getData()

setData

public void setData(NumericPulseData pulseData)

getInterpolation

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

getRequiredDiscretisation

public int getRequiredDiscretisation()

Specified by:

getRequiredDiscretisation in class PulseTemporalShape