stella.parameter
Class TargetFilterFunction

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.parameter.AbstractParameter
                  stella.parameter.AbstractTargetParameter
                      stella.parameter.AbstractTargetValue
                          stella.parameter.TargetFunction
                              stella.parameter.TargetFilterFunction

All Implemented Interfaces:

Cloneable, Parameter, TargetDependingValue, ParameterDepending, TargetDepending, TargetDependingParameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class TargetFilterFunction
extends TargetFunction

A parameter that calculates its actual target value (like an exposure time) not only as a function of an other target depending parameter like the airmass, but also of the current filter selected, or, if useful, on any additional parameter. The difference to its parental class is that it includes the value of the KEY_FILTERPARAMETER in it setup-ID generation. Thus, an example would be to have a parameter properties like:

   param.prop:
     forsetup=expose
     forparameter=AirmassTarget
     filterparameter=CurrentFilter
     parametername=AdjustingExposureTime
                    ...
   target.xml:
     
     Who cares?
     
        FunctionClass
        StepFunction
     
     
        FunctionDefinition
        1,2;1.25,3;
     
     

Note the difference in the Setup id in target.xml: This is now augmented simply by the value the current filter will return if queried (in this case, Johnson V).

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

private Parameter	filter The parameter that asumes the current filter name.
static String	KEY_FILTERPARAMETER The name of the airmass of the target parameter.

Fields inherited from class stella.parameter.TargetFunction

KEY_FORPARAMETER, KEY_FORSETUP

Fields inherited from class stella.parameter.AbstractTargetParameter

KEY_INDEX

Fields inherited from class stella.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyBundles

KEY_LOCALECOUNTRY, KEY_LOCALELANGUAGE, KEY_RESOURCEBUNDLES

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, localurl, locate, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_URL, urlset

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

TargetFilterFunction(Map<String,String> prop)
Constructs a new global representing the actual object distance to some other point in the sky.

Method Summary

protected String	getSetupId(TargetDefinition star) We append the current filter name to the value of the TargetFunction.KEY_FORSETUP key.
void	registerParameter(Parameter what) Registers the parameters giving the ra, dec of two points.
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.

Methods inherited from class stella.parameter.TargetFunction

getForTarget, getValue, registerTarget, setValue

Methods inherited from class stella.parameter.AbstractTargetValue

get, set

Methods inherited from class stella.parameter.AbstractTargetParameter

getAsStar, getConstant, getFormattedFor, getSetup

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.PropertyBundles

clone, getLocalized, getLocalized, getLocalizedString, getLocalizedString, loadResource

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 class java.lang.Object

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

Methods inherited from interface util.Reloadable

reload

Methods inherited from interface stella.TargetDependingParameter

getFormattedFor

Methods inherited from interface stella.Parameter

getFormatted, getName, getString

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

Methods inherited from interface util.Initializable

init

Methods inherited from interface util.ResourceSupplying

getResource, getResourceAsStream, getResources

Field Detail

KEY_FILTERPARAMETER

public static final String KEY_FILTERPARAMETER

The name of the airmass of the target parameter.

See Also:

Constant Field Values

filter

private Parameter filter

The parameter that asumes the current filter name.

Constructor Detail

TargetFilterFunction

public TargetFilterFunction(Map<String,String> prop)

Constructs a new global representing the actual object distance to some other point in the sky.

Method Detail

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 TargetFunction

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

Overrides:

registerParameter in class TargetFunction

getSetupId

protected String getSetupId(TargetDefinition star)

We append the current filter name to the value of the TargetFunction.KEY_FORSETUP key. Only acts on the parameter value returned by the registered filtername parameter, which can be in principle any parameter, but may proove difficult on doubles for not guaranteed repeatability.

Overrides:

getSetupId in class TargetFunction