Package pulse.input

Class Range

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.input.Range

All Implemented Interfaces:

Serializable, Optimisable, Descriptive

public class Range
extends PropertyHolder
implements Optimisable

The actual physical range defined as a Segment with minimum and maximum values. This is used purely in context of the time sequence defined by the ExperimentalData.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Range	NEGATIVE
static Range	POSITIVE
static Range	UNLIMITED

Constructor Summary

Constructors

Constructor	Description
Range(double a, double b)	Constructs a new Range based on the segment specified by a and b
Range(List<Double> data)	Constructs a Range from the minimum and maximum values of data.

Method Summary

Modifier and Type	Method	Description
void	assign(ParameterVector params)	Tries to assign the upper and lower bound based on params.
Segment	boundLimits(boolean isUpperBound)	Calculates the allowed range for either the upper or lower bound.
List<Double>[]	filter(DiscreteInput input)	Contains a data double array ([0] - x, [1] - y), where the data points have been filtered so that each x fits into this range.
NumericProperty	getLowerBound()	Gets the numeric property defining the lower bound of this range.
Segment	getSegment()	Gets the segment representing this range
NumericProperty	getUpperBound()	Gets the numeric property defining the upper bound of this range.
Set<NumericPropertyKeyword>	listedKeywords()	Lists lower and upper bounds as properties.
void	optimisationVector(ParameterVector output)	The optimisation vector contain both the lower and upper bounds with the absolute constraints equal to a fourth of their values.
void	reset(IndexRange range, List<Double> data)	Resets the minimum and maximum values of this range to those specified by the elements of data, the indices of which correspond to the lower and upper bound of the IndexRange.
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	setLowerBound(NumericProperty p)	Sets the lower bound and triggers firePropertyChanged.
void	setUpperBound(NumericProperty p)	Sets the upper bound and triggers firePropertyChanged.
String	toString()
protected void	updateMinimum(NumericProperty p)	Updates the lower bound of this range using the information contained in p.

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNLIMITED

public static final Range UNLIMITED

NEGATIVE

public static final Range NEGATIVE

POSITIVE

public static final Range POSITIVE

Constructor Detail

Range

public Range(List<Double> data)

Constructs a Range from the minimum and maximum values of data.

Parameters:

data - a list of double values

Range

public Range(double a,
             double b)

Constructs a new Range based on the segment specified by a and b

Parameters:

a - a double value

b - another double value

Method Detail

filter

public List<Double>[] filter(DiscreteInput input)

Contains a data double array ([0] - x, [1] - y), where the data points have been filtered so that each x fits into this range.

Parameters:

input -

Returns:

a [2][...] array containing filtered x and y values

reset

public void reset(IndexRange range,
                  List<Double> data)

Resets the minimum and maximum values of this range to those specified by the elements of data, the indices of which correspond to the lower and upper bound of the IndexRange.

Parameters:

range - an object specifying the start/end indices in regard to the data list

data - a list of double values (usually, a time sequence)

getLowerBound

public NumericProperty getLowerBound()

Gets the numeric property defining the lower bound of this range.

Returns:

the lower bound (usually referring to a time sequence).

getUpperBound

public NumericProperty getUpperBound()

Gets the numeric property defining the upper bound of this range.

Returns:

the upper bound (usually referring to a time sequence).

setLowerBound

public void setLowerBound(NumericProperty p)

Sets the lower bound and triggers firePropertyChanged.

Parameters:

p - a numeric property with the required LOWER_BOUND type.

setUpperBound

public void setUpperBound(NumericProperty p)

Sets the upper bound and triggers firePropertyChanged.

Parameters:

p - a numeric property with the required UPPER_BOUND type.

getSegment

public Segment getSegment()

Gets the segment representing this range

Returns:

a segment

updateMinimum

protected void updateMinimum(NumericProperty p)

Updates the lower bound of this range using the information contained in p. Since this is not fail-safe, the method has been made protected.

Parameters:

p - a NumericProperty representing the laser pulse width.

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.

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Lists lower and upper bounds as properties.

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:

PropertyHolder

boundLimits

public Segment boundLimits(boolean isUpperBound)

Calculates the allowed range for either the upper or lower bound.

Parameters:

isUpperBound - if true, will calculate the range for the upper bound, otherwise -- for the lower one.,

Returns:

a Segment range of limits for the specific bound

optimisationVector

public void optimisationVector(ParameterVector output)

The optimisation vector contain both the lower and upper bounds with the absolute constraints equal to a fourth of their values.

Specified by:

optimisationVector in interface Optimisable

Parameters:

output - the vector to be updated

assign

public void assign(ParameterVector params)
            throws SolverException

Tries to assign the upper and lower bound based on params.

Specified by:

assign in interface Optimisable

Parameters:

params - an IndexedVector which may contain the bounds.

Throws:

SolverException

toString

public String toString()

Overrides:

toString in class Object