stella.merit

Class AvoidanceMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.AvoidanceMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

Direct Known Subclasses:

MoonAvoidanceMerit, SunAvoidanceMerit

public abstract class AvoidanceMerit
extends AbstractMerit

A merit calculating its gain from the distance to a certain location in the sky. Subclasses may be used for Sun or Moon avoidance.

 gain(t) = w*ds
 

Here, w is the {link #KEY_IMPACT} factor and s is the KEY_STEEPNESS. The distance of the target to the given point-of-avoidance is d.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFDECTARGET Default dec-target parameter name.
private static double	DEFIMPACT Default value for the avoidance impact.
private static String	DEFRATARGET Default ra-target parameter name.
private static double	DEFSTEEPNESS Default value for the avoidance steepness.
static String	KEY_DECTARGET The key pointing to the name of the dec-target parameter.
static String	KEY_IMPACT The key linked to the impact of the airmass merit.
static String	KEY_RATARGET The key pointing to the name of the ra-target parameter.
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

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

Method Summary

Modifier and Type	Method and Description
protected abstract Position	getAvoidancePosition(GlobalGrouping set, TargetDefinition target) Calculates the position that should be avoided from the current parameters and the actual target.
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long dummy) Calculates the actual gain using the distance of the target to the avoidance position.

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_RATARGET

public static final String KEY_RATARGET

The key pointing to the name of the ra-target parameter.

See Also:

Constant Field Values

KEY_DECTARGET

public static final String KEY_DECTARGET

The key pointing to the name of the dec-target parameter.

See Also:

Constant Field Values

DEFIMPACT

private static final double DEFIMPACT

Default value for the avoidance impact.

See Also:

Constant Field Values

DEFSTEEPNESS

private static final double DEFSTEEPNESS

Default value for the avoidance steepness.

See Also:

Constant Field Values

DEFRATARGET

private static final String DEFRATARGET

Default ra-target parameter name.

See Also:

Constant Field Values

DEFDECTARGET

private static final String DEFDECTARGET

Default dec-target parameter name.

See Also:

Constant Field Values

Constructor Detail

AvoidanceMerit

protected AvoidanceMerit(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 dummy)

Calculates the actual gain using the distance of the target to the avoidance position. This position is calculated with a call to the (abstract) getAvoidancePosition(globals.GlobalGrouping, target.TargetDefinition) method. Subclasses may provide their distinguished avoidance positions, with the only limitation that this position must be deducable from the parameters.
The time dependance of this parameter should be very slow, thus we ignore any time-span stated.

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

dummy - The relevant time span in ms.

getAvoidancePosition

protected abstract Position getAvoidancePosition(GlobalGrouping set,
                                                 TargetDefinition target)

Calculates the position that should be avoided from the current parameters and the actual target.