stella.xml
Class MeridianMerit

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.AbstractMerit
                  extended by stella.xml.MeridianMerit
All Implemented Interfaces:
Serializable, Cloneable, Meriting, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

public class MeridianMerit
extends AbstractMerit

A merit calculating its gain from the actual distance of the meridian to the target. It uses two parameters, a KEY_IMPACT factor and a KEY_STEEPNESS. The exact formular is:

   gain(t) = w*exp(-tau^2/s^s)
   
Here, w is the {link #KEY_IMPACT} factor and s is the KEY_STEEPNESS. The tau to the target must be provided in the parameter set handed over.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
private static double DEFIMPACT
          Default value for the priority impact.
private static String DEFMERIDIAN
          Default airmass parameter name.
private static double DEFSTEEPNESS
          Default value for the fwmh of the merit in hours.
private static double FWHM
          Translates degrees into normalized gauss variables.
static String KEY_IMPACT
          The key linked to the impact of the meridian merit.
static String KEY_MERIDIAN
          The key pointing to the name of the tau parameter.
static String KEY_STEEPNESS
          The key linked to the steepness of the meridian merit.
 
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.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME
 
Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS
 
Constructor Summary
MeridianMerit(Map prop)
          Constructs a new airmass merit, defaulting the KEY_IMPACT and the KEY_STEEPNESS parameters.
 
Method Summary
 double getMerit(ParameterClustering set, TargetDefinition target, Collection ignore, long span)
          Calculates the actual gain using the airmass of the target.
 
Methods inherited from class stella.AbstractMerit
createMerit, getInitializer, initMerit
 
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, init, 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, rescanned, setObject, setProperties, setProperty, stringProperties, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface util.ResourceSupplying
getResource, getResourceAsStream, getResources
 
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
 

Field Detail

KEY_IMPACT

public static final String KEY_IMPACT
The key linked to the impact of the meridian merit.

See Also:
Constant Field Values

KEY_STEEPNESS

public static final String KEY_STEEPNESS
The key linked to the steepness of the meridian merit.

See Also:
Constant Field Values

KEY_MERIDIAN

public static final String KEY_MERIDIAN
The key pointing to the name of the tau parameter.

See Also:
Constant Field Values

DEFIMPACT

private static final double DEFIMPACT
Default value for the priority impact.

See Also:
Constant Field Values

DEFSTEEPNESS

private static final double DEFSTEEPNESS
Default value for the fwmh of the merit in hours.

See Also:
Constant Field Values

DEFMERIDIAN

private static final String DEFMERIDIAN
Default airmass parameter name.

See Also:
Constant Field Values

FWHM

private static final double FWHM
Translates degrees into normalized gauss variables.

Constructor Detail

MeridianMerit

public MeridianMerit(Map prop)
Constructs a new airmass merit, defaulting the KEY_IMPACT and the KEY_STEEPNESS parameters. Proper creation should be done using the AbstractMerit.createMerit(java.util.Map) method. This create method also takes care of proper parameter overloading.

Method Detail

getMerit

public double getMerit(ParameterClustering set,
                       TargetDefinition target,
                       Collection ignore,
                       long span)
Calculates the actual gain using the airmass of the target. The gain is higher if the airmass is low. The steepness of the gain decrease with airmass is governed with the KEY_STEEPNESS parameter.

Parameters:
set - Current observing conditions.
target - The actual target.
ignore - The list of targetes relevant to the actual target.
span - The relevant time span in ms.