stella.merit

Class JdModulusMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.JdModulusMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

public class JdModulusMerit
extends AbstractMerit

A class defining a time-slot merit that is one if the modulus of the integer of the actual Jd with KEY_MODULUS yields KEY_REMAINDER, zero otherwise. It can be used during observations like photometric calibrations, where a number of fields should be observed nightly during a given period. If one has three fields that should be observed during a +/- 7 days from new moon, add this merit to each of the fields, setting modulus to three and the remainder to 0, 1, 2, respectively.

The default implementation returns one always.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFJD Default time parameter name.
private static int	DEFMODULUS Default value for the rise time, twelve hours.
private static int	DEFREMAINDER Default value for the sharpness.
static String	KEY_JD The key pointing to the name of the time parameter.
static String	KEY_MODULUS The key linked to the time merit rises from zero to peak.
static String	KEY_REMAINDER The sharpness of the rise, i.e.

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
JdModulusMerit(Map<String,String> prop) Constructs a at-time merit starting at the current time and with a default risetime (#DEFRISE) and sharpness (#DEFSHARP .

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long spms) Calculates the actual time slot merit.

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_MODULUS

public static final String KEY_MODULUS

The key linked to the time merit rises from zero to peak.

See Also:

Constant Field Values

KEY_REMAINDER

public static final String KEY_REMAINDER

The sharpness of the rise, i.e. n .

See Also:

Constant Field Values

KEY_JD

public static final String KEY_JD

The key pointing to the name of the time parameter.

See Also:

Constant Field Values

DEFMODULUS

private static final int DEFMODULUS

Default value for the rise time, twelve hours.

See Also:

Constant Field Values

DEFREMAINDER

private static final int DEFREMAINDER

Default value for the sharpness.

See Also:

Constant Field Values

DEFJD

private static final String DEFJD

Default time parameter name.

See Also:

Constant Field Values

Constructor Detail

JdModulusMerit

public JdModulusMerit(Map<String,String> prop)

Constructs a at-time merit starting at the current time and with a default risetime (#DEFRISE) and sharpness (#DEFSHARP . 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 spms)

Calculates the actual time slot merit. We return the maximum of the merit from now until the specified time span.

Parameters:

set - Current observing conditions.

target - The actual target.

ignore - All targets, observable or not.

spms - The relevant time span in ms.