org.das2.qds

Class AbstractQFunction

java.lang.Object

org.das2.qds.AbstractQFunction

All Implemented Interfaces:

QFunction

Direct Known Subclasses:

DataSourceTcaSource, DemoFunction1, NearestNeighborTcaFunction, QFunctionLarry, UriTcaSource

public abstract class AbstractQFunction
extends java.lang.Object
implements QFunction

Abstract class implements values and exampleOutput based on value and exampleInput.

Constructor Summary

Constructors

Constructor and Description
AbstractQFunction()

Method Summary

Modifier and Type	Method and Description
abstract QDataSet	exampleInput() Discover an example input.
QDataSet	exampleOutput() this simply calls value( exampleInput() ).
abstract QDataSet	value(QDataSet parm) Evaluate the function at the location.
QDataSet	values(QDataSet vs) calculate the values by calling the value function for each element of vs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractQFunction

public AbstractQFunction()

Method Detail

value

public abstract QDataSet value(QDataSet parm)

Description copied from interface: QFunction

Evaluate the function at the location. A rank 1 dataset of N parameters is passed in, and a rank 1 dataset of M parameters is returned. It's presumed that this is calculated in interactive time (1/30sec) for GUI applications like attaching ephemeris ticks to an axis (note no monitor parameter to indicate feedback).

Specified by:

value in interface QFunction

Parameters:

parm - rank 1 bundle of N elements, or rank 2 array of such.

Returns:

rank 1 bundle of M elements, or rank 2 array of such.

values

public QDataSet values(QDataSet vs)

calculate the values by calling the value function for each element of vs. A check is made for each call to the value function that a dataset with the same rank and length is returned.

Specified by:

values in interface QFunction

Parameters:

vs - rank N+1 set of values, where exampleInput returns rank N.

Returns:

rank M+1 set of values, where value returns rank M.

exampleInput

public abstract QDataSet exampleInput()

Description copied from interface: QFunction

Discover an example input. Result is a rank 1 bundle QDataSet.

QFunction ff= TestFunction();
ff.exampleInput().length();  // how many parameters the function takes
QDataSet bds= ff.exampleInput().property( QDataSet.BUNDLE_0 );
bds.slice(0).property( QDataSet.UNITS )       // function should handle convertible units (e.g. TimeAxes Ephemeris).
bds.slice(0).property( QDataSet.VALID_MIN )   // absolute limits of domain of the function
bds.slice(0).property( QDataSet.VALID_MAX )
bds.slice(0).property( QDataSet.TYPICAL_MIN ) // domain of the function parameter
bds.slice(0).property( QDataSet.TYPICAL_MAX )
bds.slice(0).property( QDataSet.CADENCE ) // granularity of the function parameter
bds.slice(0).property( QDataSet.LABEL )   // label for the parameter

slice(0) is the first argument, slice(1) would be the second, etc. This would be a bundle. Note, for functions that have only one argument, like F(T)→[R,MLT,MLAT], this may return a rank 0 dataset. Clients should pass a dataset to the value method a dataset with the same geometry.

Specified by:

exampleInput in interface QFunction

Returns:

rank 1 bundle of N elements, or rank 0 for functions when the function has just one parameter.

exampleOutput

public QDataSet exampleOutput()

this simply calls value( exampleInput() ).

Specified by:

exampleOutput in interface QFunction

Returns: