stella.merit

Class ZenithMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.ZenithMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class ZenithMerit
extends AbstractMerit

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

 gain(t) = w/zs
 

Here, w is the KEY_IMPACT factor and s is the KEY_STEEPNESS. The airmass to the target must be provided in the parameter set handed over.

See Also:

AirmassMerit, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFAIRMASS Default airmass parameter name.
private static double	DEFIMPACT Default value for the priority impact.
private static double	DEFSTEEPNESS Default value for the priority stretch.
static String	KEY_AIRMASS The key pointing to the name of the airmass parameter.
static String	KEY_IMPACT The key linked to the impact of the airmass merit.
static String	KEY_STEEPNESS The key linked to the steepness of the airmass merit.

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
ZenithMerit(Map prop) Constructs a new airmass merit, defaulting the KEY_IMPACT and the KEY_STEEPNESS parameters.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long span) Calculates the actual gain using the airmass of the target.

Methods inherited from class stella.merit.AbstractMerit

createMerit, getInitializer, initMerit

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, 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, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_IMPACT

public static final String KEY_IMPACT

The key linked to the impact of the airmass merit.

See Also:

Constant Field Values

KEY_STEEPNESS

public static final String KEY_STEEPNESS

The key linked to the steepness of the airmass merit.

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

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 priority stretch.

See Also:

Constant Field Values

DEFAIRMASS

private static final String DEFAIRMASS

Default airmass parameter name.

See Also:

Constant Field Values

Constructor Detail

ZenithMerit

public ZenithMerit(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<java.lang.String, java.lang.String>) method. This create method also takes care of proper parameter overloading.

Method Detail

getMerit

public double getMerit(GlobalGrouping set,
                       Appointable 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 - All targets, observable or not.

span - The relevant time span in ms.