stella.xml
Class DarkSkyMerit

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.AbstractMerit
                  stella.xml.AvoidanceMerit
                      stella.xml.SunAvoidanceMerit
                          stella.xml.DarkSkyMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

public class DarkSkyMerit
extends SunAvoidanceMerit

A dark sky merit combines an AirmassMerit and a SunAvoidanceMerit such, that it acts like the latter if the sun is higher than KEY_DARKLIMIT above the horizon, and as the former in the opposite case.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

private static String	DEFAIRMASS Default airmass parameter name.
private static double	DEFDARKLIMIT Default value for the priority impact.
private static String	DEFSOLHEIGHT Default airmass parameter name.
static String	KEY_AIRMASS The key pointing to the name of the airmass parameter.
static String	KEY_DARKLIMIT The key pointing to the darkness limit.
static String	KEY_SOLHEIGHT The key pointing to the name of the solheight parameter.

Fields inherited from class stella.xml.SunAvoidanceMerit

KEY_SOLDEC, KEY_SOLRA

Fields inherited from class stella.xml.AvoidanceMerit

KEY_DECTARGET, KEY_IMPACT, KEY_RATARGET, KEY_STEEPNESS

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

DarkSkyMerit(Map prop)
Constructs a new airmass merit, defaulting the AvoidanceMerit.KEY_IMPACT and the AvoidanceMerit.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.xml.SunAvoidanceMerit

getAvoidancePosition

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_DARKLIMIT

public static final String KEY_DARKLIMIT

The key pointing to the darkness limit.

See Also:

Constant Field Values

KEY_AIRMASS

public static final String KEY_AIRMASS

The key pointing to the name of the airmass parameter.

See Also:

Constant Field Values

KEY_SOLHEIGHT

public static final String KEY_SOLHEIGHT

The key pointing to the name of the solheight parameter.

See Also:

Constant Field Values

DEFDARKLIMIT

private static final double DEFDARKLIMIT

Default value for the priority impact.

See Also:

Constant Field Values

DEFAIRMASS

private static final String DEFAIRMASS

Default airmass parameter name.

See Also:

Constant Field Values

DEFSOLHEIGHT

private static final String DEFSOLHEIGHT

Default airmass parameter name.

See Also:

Constant Field Values

Constructor Detail

DarkSkyMerit

public DarkSkyMerit(Map prop)

Constructs a new airmass merit, defaulting the AvoidanceMerit.KEY_IMPACT and the AvoidanceMerit.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 AvoidanceMerit.KEY_STEEPNESS parameter.

Specified by:

getMerit in interface Meriting

Overrides:

getMerit in class AvoidanceMerit

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.