stella.merit

Class TransitMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.AbstractPhaseMerit

stella.merit.TransitMerit

All Implemented Interfaces:

Serializable, Cloneable, EndpointDefining, Meriting, Initializable, PropertySupplying

Direct Known Subclasses:

TransitOnOffMerit

public class TransitMerit
extends AbstractPhaseMerit
implements EndpointDefining, Initializable

A class defining a time-slot merit that allows observation of a transiting target. It must define the AbstractPhaseMerit.KEY_ZEROPHASE of its parental class along with the period. The duration t_d of the transit has to be set with KEY_TRANSITDURATION. It is the time between first and fourth contact. If a list of transit numbers, KEY_TRANSITS is stated, the merit is only active around these transits, with the transit at jd0 being transit number zero. It is good practice to also state an KEY_INGRESS and KEY_OVER time, but if these times are not given, they are calculated from the transit time. The merit now is zero, except for the brief period (n is a non-forbidden transit number):

 t_0 = jd_0+n*P<br>t_0-td/2-ingress<t<t_0-td/2-over
 

It is endpoint defining, but only if the KEY_UNCERTAINTY is set, then it ends when the phase error extends #KEY_PHASESHIFT. The phase error is:

 δφ=δP/P*(φ+int((t-t0)/P)/P)+1/P*int((t-t0)δP/P²
 ;)
 

This merit can be combined with a ConstantMerit or a OneObservationMerit to further constrain target picking.
This merit also incorporates the EndpointDefining interface. The isCompleted(globals.GlobalGrouping, stella.Appointable) method returns true as soon as all phase-requested observations have been made or no further prediction on the first contact.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static double	DEFINGRESS Default ingress time.
private static double	DEFOVER Default over time.
static String	KEY_INGRESS Observe start this time before first contact.
static String	KEY_OVER Observe may not start later than this time before first contact.
static String	KEY_TRANSITDURATION The duration of the transit in seconds.
static String	KEY_TRANSITS The number of phase points to observe.
static String	KEY_UNCERTAINTY If set, the uncertainty in the period as a fraction of the period.
private List<Integer>	nr If not null, the allowed transit numbers.

Fields inherited from class stella.merit.AbstractPhaseMerit

KEY_HJDCORRECTION, KEY_JD, KEY_PERIODDAY, KEY_USEHJD, KEY_ZEROPHASE

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
TransitMerit(Map<String,String> prop) Constructs a phase-coherent merit.

Method Summary

Modifier and Type	Method and Description
protected double	forPhase(double phi, long within)
double	getMerit(GlobalGrouping set, Appointable target, Collection<Appointable> ignore, long within) Calculates the actual time slot merit.
void	init() Generates the list of phases we want to observe.
boolean	isCompleted(GlobalGrouping set, Appointable target) Check, if the observation is complete.

Methods inherited from class stella.merit.AbstractPhaseMerit

getDaysSinceT0, getHjd, getHjd, getPeriodsSinceT0, getPhase, getPhase, getT0

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_TRANSITS

public static final String KEY_TRANSITS

The number of phase points to observe.

See Also:

Constant Field Values

KEY_TRANSITDURATION

public static final String KEY_TRANSITDURATION

The duration of the transit in seconds.

See Also:

Constant Field Values

KEY_INGRESS

public static final String KEY_INGRESS

Observe start this time before first contact.

See Also:

Constant Field Values

KEY_OVER

public static final String KEY_OVER

Observe may not start later than this time before first contact.

See Also:

Constant Field Values

KEY_UNCERTAINTY

public static final String KEY_UNCERTAINTY

If set, the uncertainty in the period as a fraction of the period.

See Also:

Constant Field Values

DEFINGRESS

private static final double DEFINGRESS

Default ingress time.

See Also:

Constant Field Values

DEFOVER

private static final double DEFOVER

Default over time.

See Also:

Constant Field Values

nr

private List<Integer> nr

If not null, the allowed transit numbers.

Constructor Detail

TransitMerit

public TransitMerit(Map<String,String> prop)

Constructs a phase-coherent merit. At least the period should be stated in the target definition. 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

init

public void init()

Generates the list of phases we want to observe.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractPhaseMerit

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 the first successful observation of the target. The remaining value is used in a multiple Gauss-curve in phase space to calculate a merit.

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.

forPhase

protected double forPhase(double phi,
                          long within)

isCompleted

public boolean isCompleted(GlobalGrouping set,
                           Appointable target)

Check, if the observation is complete. Again, this is done by matching the phase shift due to period uncertainties to the maximum allowed phase shift.

Specified by:

isCompleted in interface EndpointDefining