EvenlySpacedMerit

java.lang.Object
- util.PropertyContainer
- - stella.merit.AbstractMerit
  - - stella.merit.EvenlySpacedMerit

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

Direct Known Subclasses:

FixedBlockMerit, FixedDelayMerit, FixedRateMerit
```
public abstract class EvenlySpacedMerit
extends AbstractMerit
```
A class defining evently spaced time slot merits. Evenly spaced means that this merit tries to keep the time between observations of the target at a fixed frequency. It comes in two flavours, FixedDelayMerit and FixedRateMerit. These two classes differ in the way they evaluate the crucial parameter t₀. The formular used for calculating this time slot merit is
```
    ts(t) = w[(t-t₀)/p]^α
 
```
Here, w is the {link #KEY_IMPACT} factor and p is the period aimed at. α is a double that defines the 'forgiveness' of the merit if the time aimed at is not yet reached. Values below one allow a rather shallow influence of the observation time aimed at, in the way that target picking is possible before the aim time and not much increased once this time has passed. Values above one more or less block target selection prior to the aim time with a sharp increase of propability once this time has passed.
If combined with a OneObservationMerit this merit can be used to additionally specify a number of maximum observations.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static double`	`DEFPERIODDAY` Default value for the period.
`private static double`	`DEFSTEEPNESS` Default value for the period.
`private static String`	`DEFTIME` Default time parameter name.
`private static double`	`DEFZEROFRACTION` Default no picking half of the period.
`private static double`	`DEFZEROSUBTRACT` Default no picking half of the period.
`static String`	`KEY_PERIOD` The key linked to the period of the observations.
`static String`	`KEY_PERIODDAY` The key linked to the period of the observations.
`static String`	`KEY_STEEPNESS` The key linked to the steepness of the aim time influence.
`static String`	`KEY_TIME` The key pointing to the name of the time parameter.
`static String`	`KEY_ZEROFRACTION` The key linked to the fraction of the period the merit stay zero.
`static String`	`KEY_ZEROSUBTRACT` The key linked to the fraction of the period the merit stay zero.
`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
Modifier Constructor and Description

protected EvenlySpacedMerit(Map<String,String> prop)
Constructs an evenly spaced merit.

Constructors
Modifier	Constructor and Description
`protected`	`EvenlySpacedMerit(Map<String,String> prop)` Constructs an evenly spaced merit.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getMerit(GlobalGrouping set, Appointable target, Collection<Appointable> ignore, long within)` Calculates the actual time slot merit.
`protected abstract Date`	`getT0(GlobalGrouping set, Appointable target)` Returns t0, a measurement of the last valid observations.
`protected Date`	`getT0FromSubmitted(GlobalGrouping set, Date submit)`

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_PERIOD
```
public static final String KEY_PERIOD
```
    The key linked to the period of the observations.
    
    See Also:
    
    Constant Field Values
  - KEY_PERIODDAY
```
public static final String KEY_PERIODDAY
```
    The key linked to the period of the observations.
    
    See Also:
    
    Constant Field Values
  - KEY_ZEROFRACTION
```
public static final String KEY_ZEROFRACTION
```
    The key linked to the fraction of the period the merit stay zero.
    
    See Also:
    
    Constant Field Values
  - KEY_ZEROSUBTRACT
```
public static final String KEY_ZEROSUBTRACT
```
    The key linked to the fraction of the period the merit stay zero.
    
    See Also:
    
    Constant Field Values
  - KEY_STEEPNESS
```
public static final String KEY_STEEPNESS
```
    The key linked to the steepness of the aim time influence.
    
    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
  - DEFPERIODDAY
```
private static final double DEFPERIODDAY
```
    Default value for the period. One day.
    
    See Also:
    
    Constant Field Values
  - DEFSTEEPNESS
```
private static final double DEFSTEEPNESS
```
    Default value for the period. One day.
    
    See Also:
    
    Constant Field Values
  - DEFZEROFRACTION
```
private static final double DEFZEROFRACTION
```
    Default no picking half of the period.
    
    See Also:
    
    Constant Field Values
  - DEFZEROSUBTRACT
```
private static final double DEFZEROSUBTRACT
```
    Default no picking half of the period.
    
    See Also:
    
    Constant Field Values
  - DEFTIME
```
private static final String DEFTIME
```
    Default time parameter name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EvenlySpacedMerit
```
protected EvenlySpacedMerit(Map<String,String> prop)
```
    Constructs an evenly spaced merit. Only non-abstract subclasses of this merit may be used.
- Method Detail
  - getMerit
```
public double getMerit(GlobalGrouping set,
                       Appointable target,
                       Collection<Appointable> ignore,
                       long within)
```
    Calculates the actual time slot merit. The current time minus the flavour-depending zero time is weighed to the required period (in ms). Depending on the time offset and the KEY_STEEPNESS of the merit, a value between zero and positive infinity is returned. The value returned one period after t0 is always one.
    This merit is strictly increasing, thus we use the end time for evaluation.
    
    Parameters:
    
    set - Current observing conditions.
    
    target - The actual target.
    
    ignore - All targets, observable or not.
    
    within - The relevant time span in ms.
  - getT0FromSubmitted
```
protected Date getT0FromSubmitted(GlobalGrouping set,
                                  Date submit)
```
  - getT0
```
protected abstract Date getT0(GlobalGrouping set,
                              Appointable target)
```
    Returns t0, a measurement of the last valid observations. This method defines the two flavours of this merit.

Class EvenlySpacedMerit

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class stella.merit.AbstractMerit

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

KEY_PERIOD

KEY_PERIODDAY

KEY_ZEROFRACTION

KEY_ZEROSUBTRACT

KEY_STEEPNESS

KEY_TIME

DEFPERIODDAY

DEFSTEEPNESS

DEFZEROFRACTION

DEFZEROSUBTRACT

DEFTIME

Constructor Detail

EvenlySpacedMerit

Method Detail

getMerit

getT0FromSubmitted

getT0