Package pulse.problem.laser

Class ExponentiallyModifiedGaussian

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.laser.PulseTemporalShape

pulse.problem.laser.ExponentiallyModifiedGaussian

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

public class ExponentiallyModifiedGaussian
extends PulseTemporalShape

Represents the exponentially modified Gaussian function, which is given by three independent parameters (μ, σ and λ).

See Also:

Wikipedia page, Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExponentiallyModifiedGaussian()	Creates an exponentially modified Gaussian with the default parameter values.
ExponentiallyModifiedGaussian(ExponentiallyModifiedGaussian another)

Method Summary

Modifier and Type	Method	Description
PulseTemporalShape	copy()
double	evaluateAt(double time)	Evaluates the laser power function.
NumericProperty	getLambda()
NumericProperty	getMu()
int	getRequiredDiscretisation()
NumericProperty	getSigma()
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
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	setLambda(NumericProperty p)	Sets the SKEW_LAMBDA parameter
void	setMu(NumericProperty p)	Sets the SKEW_MU parameter
void	setSigma(NumericProperty p)	Sets the SKEW_SIGMA parameter

Methods inherited from class pulse.problem.laser.PulseTemporalShape

getPrefix, getPulseWidth, init, setPulseWidth, toString

Methods inherited from class pulse.util.PropertyHolder

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

Constructor Detail

ExponentiallyModifiedGaussian

public ExponentiallyModifiedGaussian()

Creates an exponentially modified Gaussian with the default parameter values.

ExponentiallyModifiedGaussian

public ExponentiallyModifiedGaussian(ExponentiallyModifiedGaussian another)

Method Detail

evaluateAt

public double evaluateAt(double time)

Evaluates the laser power function. The error function is calculated using the ApacheCommonsMath library tools.

Specified by:

evaluateAt in class PulseTemporalShape

Parameters:

time - is measured from the 'start' of laser pulse

Returns:

a double value, representing the pulse function at time

See Also:

https://tinyurl.com/ExpModifiedGaussian

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: PropertyHolder

By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

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:

pulse.properties.NumericPropertyKeyword.SKEW_MU, pulse.properties.NumericPropertyKeyword.SKEW_LAMBDA, pulse.properties.NumericPropertyKeyword.SKEW_SIGMA

getMu

public NumericProperty getMu()

Returns:

the μ parameter

getSigma

public NumericProperty getSigma()

Returns:

the σ parameter

getLambda

public NumericProperty getLambda()

Returns:

the λ parameter

setLambda

public void setLambda(NumericProperty p)

Sets the SKEW_LAMBDA parameter

Parameters:

p - the λ parameter

setMu

public void setMu(NumericProperty p)

Sets the SKEW_MU parameter

Parameters:

p - the μ parameter

setSigma

public void setSigma(NumericProperty p)

Sets the SKEW_SIGMA parameter

Parameters:

p - the σ parameter

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.

copy

public PulseTemporalShape copy()

Specified by:

copy in class PulseTemporalShape

getRequiredDiscretisation

public int getRequiredDiscretisation()

Specified by:

getRequiredDiscretisation in class PulseTemporalShape