stella.parameter
Class TargetFunction
java.lang.Object
util.PropertyContainer
util.PropertyResources
util.PropertyBundles
stella.parameter.AbstractParameter
stella.parameter.AbstractTargetParameter
stella.parameter.AbstractTargetValue
stella.parameter.TargetFunction
- All Implemented Interfaces:
- Cloneable, Parameter, TargetDependingValue, ParameterDepending, TargetDepending, TargetDependingParameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying
- Direct Known Subclasses:
- TargetFilterFunction
public class TargetFunction
- extends AbstractTargetValue
- implements ParameterDepending, Reloadable
A parameter that calculates its actual target value (like an exposure time)
as a function of an other target depending parameter like the airmass.
The correct use of this parameter is as follows:
- Define the target depending paramter which is the argument in the
function with
KEY_FORPARAMETER.
- Select a setup section from the target with the
KEY_FORSETUP.
- The instrument setting of this setup is ignored.
- The constants in the setup can provide a
ReservedConstants.FUNCTIONCLASS constant that points to the class
name of the function to be used. If not given, Polynom is used.
- A constant of name
ReservedConstants.FUNCTIONDEFINITION
must be provided. This string is used in initializing (construction)
of the function.
- The number returned by this Value is then a Double, evaluated for
the current airmass via
Fuction#evaluate.
An example would be to have a parameter properties like:
param.prop:
forsetup=expose
forparameter=AirmassTarget
parametername=AdjustingExposureTime
...
target.xml:
Who cares?
FunctionClass
StepFunction
FunctionDefinition
1,2;1.25,3;
|
Field Summary |
private Value |
argument
The target value that gives us the arguemtn to the function. |
static String |
KEY_FORPARAMETER
The name of the airmass of the target parameter. |
static String |
KEY_FORSETUP
The name of the parameter that gives the ra of the first point. |
private Function |
z
The function we evaluate. |
|
Constructor Summary |
TargetFunction(Map<String,String> prop)
Constructs a new global representing the actual object distance
to some other point in the sky. |
| Methods inherited from class stella.parameter.AbstractParameter |
createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, init, register, setName, toString |
| Methods inherited from class util.PropertyResources |
createFrom, createFrom, createFrom, getApplet, getAsResources, getLocalClassLoader, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, keyCreate, keyCreate, reload, setApplet |
| Methods inherited from class util.PropertyContainer |
augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, reload, removeProperty, setObject, setProperties, setProperty, stringProperties |
| Methods inherited from interface util.PropertySupplying |
defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties |
KEY_FORSETUP
public static final String KEY_FORSETUP
- The name of the parameter that gives the ra of the first point.
- See Also:
- Constant Field Values
KEY_FORPARAMETER
public static final String KEY_FORPARAMETER
- The name of the airmass of the target parameter.
- See Also:
- Constant Field Values
z
private Function z
- The function we evaluate.
argument
private Value argument
- The target value that gives us the arguemtn to the function.
TargetFunction
public TargetFunction(Map<String,String> prop)
- Constructs a new global representing the actual object distance
to some other point in the sky.
rescanned
public double rescanned(String key,
String old,
String newval)
- As any parameter depending instance we fail if the parameter we depend
on is now a different one.
- Specified by:
rescanned in interface Reloadable- Overrides:
rescanned in class AbstractParameter
registerParameter
public void registerParameter(Parameter what)
- Registers the parameters giving the ra, dec of two points. No checks
for types are made, only the parameter name counts.
- Specified by:
registerParameter in interface ParameterDepending
registerTarget
public void registerTarget(TargetDefinition star)
- Registers a target to this parameter. We scan for the setup of the
given name, and try to parse a Function out of it.
- Specified by:
registerTarget in interface TargetDepending
getForTarget
public Number getForTarget(TargetDefinition star)
- Gets the declination of the target star.
- Specified by:
getForTarget in interface TargetDependingValue- Specified by:
getForTarget in interface TargetDependingParameter
- Returns:
- A Double holding the target star's declination.
getValue
public Number getValue()
- Returns the ra of the actual target. Returns null if the
ra has not been set previously.
- Specified by:
getValue in interface Value
setValue
public Number setValue(Number val)
throws UnsupportedOperationException
- Sets the distance. This is a read-only variable,
therefore this method throws an UnsupportedOperationException.
- Specified by:
setValue in interface Value
- Throws:
UnsupportedOperationException
getSetupId
protected String getSetupId(TargetDefinition star)
- The basic functionality returns my properties setting of the
KEY_FORSETUP key. Target functions that need more flexibilty
should override here and provide their own implementation of
retrieving the target specific ID. A simple case would be to add
a filter name here, like
return super.getSetupId()+filterparameter.get().toString()
extractFunction
private Function extractFunction(TargetDefinition star)
- From a target, we rty to extract the function.