Package pulse.math

Class Harmonic

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.math.Harmonic

All Implemented Interfaces:

Serializable, Comparable<Harmonic>, Optimisable, Descriptive

public class Harmonic
extends PropertyHolder
implements Optimisable, Comparable<Harmonic>

Harmonic class.

It is given by the expression $$y = y₀ + A cos(2πf t + φ) , where f is the frequency (in Hz), A is the amplitude, φ is the phase shift.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Harmonic()
Harmonic(double amplitude, double frequency, double phaseShift)
Harmonic(Harmonic h)

Method Summary

Modifier and Type	Method	Description
void	assign(ParameterVector params)	Assigns parameter values of this Optimisable using the optimisation vector params.
int	compareTo(Harmonic o)
boolean	equals(Object o)
NumericProperty	getAmplitude()
NumericProperty	getFrequency()
NumericProperty	getPhaseShift()
int	getRank()
Harmonic	increaseAmplitudeBy(int amplitudeFactor)
Set<NumericPropertyKeyword>	listedKeywords()	Listed properties include the frequency, amplitude, phase shift, and intercept.
void	optimisationVector(ParameterVector output)	The optimisation vector can include the amplitude, frequency and phase shift of a sinusoid, and a baseline intercept value of the superclass.
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	setAmplitude(NumericProperty amplitude)
void	setFrequency(NumericProperty frequency)
void	setPhaseShift(NumericProperty phaseShift)
void	setRank(int rank)
String	toString()
double	valueAt(double x)	Amplitude form of the Fourier harmonic

Methods inherited from class pulse.util.PropertyHolder

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

Harmonic

public Harmonic()

Harmonic

public Harmonic(double amplitude,
                double frequency,
                double phaseShift)

Harmonic

public Harmonic(Harmonic h)

Method Detail

getFrequency

public NumericProperty getFrequency()

getAmplitude

public NumericProperty getAmplitude()

getPhaseShift

public NumericProperty getPhaseShift()

setFrequency

public final void setFrequency(NumericProperty frequency)

setAmplitude

public final void setAmplitude(NumericProperty amplitude)

setPhaseShift

public final void setPhaseShift(NumericProperty phaseShift)

valueAt

public double valueAt(double x)

Amplitude form of the Fourier harmonic

Parameters:

x -

Returns:

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Listed properties include the frequency, amplitude, phase shift, and intercept.

Overrides:

listedKeywords in class PropertyHolder

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

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.

optimisationVector

public void optimisationVector(ParameterVector output)

The optimisation vector can include the amplitude, frequency and phase shift of a sinusoid, and a baseline intercept value of the superclass.

Specified by:

optimisationVector in interface Optimisable

Parameters:

output - the output vector where the result will be stored

assign

public void assign(ParameterVector params)

Description copied from interface: Optimisable

Assigns parameter values of this Optimisable 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

Parameters:

params - the optimisation vector, containing a similar set of parameters to this Problem

setRank

public void setRank(int rank)

getRank

public int getRank()

increaseAmplitudeBy

public Harmonic increaseAmplitudeBy(int amplitudeFactor)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(Harmonic o)

Specified by:

compareTo in interface Comparable<Harmonic>

toString

public String toString()

Overrides:

toString in class Object