stella.merit

Class NumberMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.NumberMerit

All Implemented Interfaces:

Serializable, Cloneable, EndpointDefining, Meriting, PropertySupplying

public class NumberMerit
extends AbstractMerit
implements EndpointDefining

A class defining a decreasing merit as the number of successful observations of the target increases. It models the merit with

 g(t)=k·(π/2-arctan(N/width)·2/π),
 

where N is the number of successful observations, k is a scaling factor and width is a stretching parameter. Though the merit never get zero, one can define a KEY_TERMINAL property, which forces the merit to be zero once this number of successful observations has been surpassed, thus it is EndpointDefining.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static double	DEFIMPACT Default value for the priority impact.
private static int	DEFTERMINAL Default value for the maximum number of observations.
private static double	DEFWIDTH Default value of the merit width.
static String	KEY_IMPACT The key linked to the impact of the merit.
static String	KEY_TERMINAL The key linked to the maximum number of successful observations.
static String	KEY_WIDTH The key linked to the width of the 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
NumberMerit(Map prop) Constructs a number merit, defaulting the KEY_IMPACT and the KEY_WIDTH parameters.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long dummy) Calculates the actual time slot merit.
boolean	isCompleted(GlobalGrouping set, Appointable target) Returns true, if the number of successful observations has reached the requested value.

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

See Also:

Constant Field Values

KEY_WIDTH

public static final String KEY_WIDTH

The key linked to the width of the merit.

See Also:

Constant Field Values

KEY_TERMINAL

public static final String KEY_TERMINAL

The key linked to the maximum number of successful observations.

See Also:

Constant Field Values

DEFIMPACT

private static final double DEFIMPACT

Default value for the priority impact.

See Also:

Constant Field Values

DEFWIDTH

private static final double DEFWIDTH

Default value of the merit width.

See Also:

Constant Field Values

DEFTERMINAL

private static final int DEFTERMINAL

Default value for the maximum number of observations.

See Also:

Constant Field Values

Constructor Detail

NumberMerit

public NumberMerit(Map prop)

Constructs a number merit, defaulting the KEY_IMPACT and the KEY_WIDTH 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 time slot merit. If the number of successful observations is below #KEY_MAXOBSERVATIONS, the KEY_IMPACT merit is returned. If the target definition is not history aware, one is returned.
As this merit focusses inly on number of picks, the time span is ignored.

Specified by:

getMerit in interface Meriting

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

dummy - The relevant time span in ms.

isCompleted

public boolean isCompleted(GlobalGrouping set,
                           Appointable target)

Returns true, if the number of successful observations has reached the requested value.

Specified by:

isCompleted in interface EndpointDefining