stella.merit

Class BeforeAfterMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.BeforeAfterMerit

All Implemented Interfaces:

Serializable, Cloneable, EndpointDefining, Meriting, PropertySupplying

public class BeforeAfterMerit
extends AbstractMerit
implements EndpointDefining

A class defining a time-slot merit that allows observation either after or before a time defined with KEY_T0. If the KEY_WIDTH is positive, the merit blocks observation before t0, if it is negative, the merit blocks observation after t0. The absoulte value of KEY_WIDTH defines the sharpness of the merit as in

 ts(t) = ln(±(t-t0)/width+1)
 

If the logarithm evaluates to a negative value, zero is returned. For a positive KEY_WIDTH, i.e. for a before merit, this class also has the power of defining an end-point, i.e. this class implements EndpointDefining.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFTIME Default time parameter name.
private static double	DEFWIDTH Default value for the width, one hour.
static String	KEY_T0 The key linked to the impact of the airmass merit.
static String	KEY_TIME The key pointing to the name of the time parameter.
static String	KEY_WIDTH The key linked to the maximum number of successful observations.
private static long	serialVersionUID

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
BeforeAfterMerit(Map<String,String> prop) Constructs a at-time merit centered at the current time and with a default width of DEFWIDTH.

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection<Appointable> ignore, long within) Calculates the actual time slot merit.
boolean	isCompleted(GlobalGrouping set, Appointable target) Test if this target is completed.

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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KEY_T0

public static final String KEY_T0

The key linked to the impact of the airmass merit.

See Also:

Constant Field Values

KEY_WIDTH

public static final String KEY_WIDTH

The key linked to the maximum number of successful observations.

See Also:

Constant Field Values

KEY_TIME

public static final String KEY_TIME

The key pointing to the name of the time parameter.

See Also:

Constant Field Values

DEFWIDTH

private static final double DEFWIDTH

Default value for the width, one hour.

See Also:

Constant Field Values

DEFTIME

private static final String DEFTIME

Default time parameter name.

See Also:

Constant Field Values

Constructor Detail

BeforeAfterMerit

public BeforeAfterMerit(Map<String,String> prop)

Constructs a at-time merit centered at the current time and with a default width of DEFWIDTH. 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<Appointable> ignore,
                       long within)

Calculates the actual time slot merit. The current time is substracted from KEY_T0, and dived through the KEY_WIDTH. The remaining value is used in a logarithm.

Specified by:

getMerit in interface Meriting

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

within - The relevant time span in ms.

isCompleted

public boolean isCompleted(GlobalGrouping set,
                           Appointable target)

Test if this target is completed. Only in the 'after' mode, a definitie decision is possible: if the current time is past the zero-time, this method returns true.

Specified by:

isCompleted in interface EndpointDefining