stella.merit

Class PhaseAvoidanceMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.AbstractPhaseMerit

stella.merit.PhaseAvoidanceMerit

All Implemented Interfaces:

Serializable, Cloneable, EndpointDefining, Meriting, Initializable, PropertySupplying

public class PhaseAvoidanceMerit
extends AbstractPhaseMerit
implements EndpointDefining, Initializable

A class defining a time-slot merit that allows observation of a target at all phases except the ones states in the avoidance list. A avoidance list consists of pairs of numbers, the first the start of the phase to be avoided, the second the end phase. The first number must always be the smaller one, so an avoidance that should stretch from 0.8 to 0.1 must read as 0.8,1.0;0.0,0.1.
This merit is particularily useful to fill phase gaps.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhaseAvoidanceMerit.Xml Creats an XML-segment out of the command line arguments, which are jd0 (t0), period in days and as a single string the phases to avoid.

Field Summary

Fields

Modifier and Type	Field and Description
private List<Vector2D>	avoid The list of phases we want to avoid, x is start phase, y end phase.
private static double	DEFPHASESHIFT Default maximum phase shift.
private static double	DEFUNCERTAINTY Default uncertainty.
static String	KEY_AVOID The key linked to the pair list of phases to avoid.
static String	KEY_PHASESHIFT If the uncertainty shifts the phase more than this, we stop.
static String	KEY_UNCERTAINTY If set, the uncertainty in the period as a fraction of the period.
private static long	serialVersionUID

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

Method Summary

Modifier and Type	Method and Description
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long within) Calculates the actual time slot merit.
void	init() Constructs the phases to avoid from the KEY_AVOID property that must point to a double-list of numbers, where the inner list consists of number pair separated by ',', and the outer list, with an arbitrary length, separated by ';'.
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

serialVersionUID

private static final long serialVersionUID

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

KEY_PHASESHIFT

public static final String KEY_PHASESHIFT

If the uncertainty shifts the phase more than this, we stop.

See Also:

Constant Field Values

KEY_AVOID

public static final String KEY_AVOID

The key linked to the pair list of phases to avoid.

See Also:

Constant Field Values

DEFUNCERTAINTY

private static final double DEFUNCERTAINTY

Default uncertainty.

See Also:

Constant Field Values

DEFPHASESHIFT

private static final double DEFPHASESHIFT

Default maximum phase shift.

See Also:

Constant Field Values

avoid

private List<Vector2D> avoid

The list of phases we want to avoid, x is start phase, y end phase.

Constructor Detail

PhaseAvoidanceMerit

public PhaseAvoidanceMerit(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()

Constructs the phases to avoid from the KEY_AVOID property that must point to a double-list of numbers, where the inner list consists of number pair separated by ',', and the outer list, with an arbitrary length, separated by ';'.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractPhaseMerit

getMerit

public double getMerit(GlobalGrouping set,
                       Appointable target,
                       Collection 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.

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