stella.xml
Class AtTimeMerit

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.AbstractMerit
                  extended by stella.xml.AtTimeMerit
All Implemented Interfaces:
Serializable, Cloneable, Meriting, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

public class AtTimeMerit
extends AbstractMerit

A class defining a time-slot merit that peaks around a given date. The formula used is, see .

   ts(t)=(2n)^-1/2n*exp(-1/2n)*x^1/n·exp(-x^2),
   x=(t-(t0-trise))/sqr(2n)·trise. 
   
The first factor normalizes the merit to one for t=t0. Before t0-trise a merit of zero is returned.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
private static double DEFRISE
          Default value for the rise time, twelve hours.
private static int DEFSHARP
          Default value for the sharpness.
private static String DEFTIME
          Default time parameter name.
static String KEY_RISE
          The key linked to the time merit rises from zero to peak.
static String KEY_SHARP
          The sharpness of the rise, i.e.
static String KEY_T0
          The key linked to the time when merit peaks.
static String KEY_TIME
          The key pointing to the name of the time parameter.
private  double scale
          To return a mximum merit of one.
private  double sigma
          The scaling factor for the time.
private  double x0
          The zero time when the merit is zero.
 
Fields inherited from class util.PropertyBundles
KEY_LOCALECOUNTRY, KEY_LOCALELANGUAGE, KEY_RESOURCEBUNDLES
 
Fields inherited from class util.PropertyResources
KEY_NOINITONCREATE, localurl, locate, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_URL, urlset
 
Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR
 
Fields inherited from interface util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME
 
Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS
 
Constructor Summary
AtTimeMerit(Map prop)
          Constructs a at-time merit starting at the current time and with a default risetime (DEFRISE) and sharpness (DEFSHARP .
 
Method Summary
 double getMerit(ParameterClustering set, TargetDefinition target, Collection ignore, long spms)
          Calculates the actual time slot merit.
 
Methods inherited from class stella.AbstractMerit
createMerit, getInitializer, initMerit
 
Methods inherited from class util.PropertyBundles
clone, getLocalized, getLocalized, getLocalizedString, getLocalizedString, loadResource
 
Methods inherited from class util.PropertyResources
createFrom, createFrom, createFrom, getApplet, getAsResources, getLocalClassLoader, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, init, keyCreate, keyCreate, reload, setApplet
 
Methods inherited from class util.PropertyContainer
augment, augment, augment, 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, isNew, parseObject, reload, removeProperty, rescanned, setObject, setProperties, setProperty, stringProperties, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface util.ResourceSupplying
getResource, getResourceAsStream, getResources
 
Methods inherited from interface util.PropertySupplying
defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties
 
Methods inherited from interface util.Initializable
init
 

Field Detail

KEY_T0

public static final String KEY_T0
The key linked to the time when merit peaks.

See Also:
Constant Field Values

KEY_RISE

public static final String KEY_RISE
The key linked to the time merit rises from zero to peak.

See Also:
Constant Field Values

KEY_SHARP

public static final String KEY_SHARP
The sharpness of the rise, i.e. n .

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

DEFRISE

private static final double DEFRISE
Default value for the rise time, twelve hours.

See Also:
Constant Field Values

DEFSHARP

private static final int DEFSHARP
Default value for the sharpness.

See Also:
Constant Field Values

DEFTIME

private static final String DEFTIME
Default time parameter name.

See Also:
Constant Field Values

x0

private double x0
The zero time when the merit is zero.


sigma

private double sigma
The scaling factor for the time.


scale

private double scale
To return a mximum merit of one.

Constructor Detail

AtTimeMerit

public AtTimeMerit(Map 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) method. This create method also takes care of proper parameter overloading.

Method Detail

getMerit

public double getMerit(ParameterClustering set,
                       TargetDefinition 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 - The list of targetes relevant to the actual target.
spms - The relevant time span in ms.