stella.merit

Class PhaseFillerMerit

java.lang.Object

util.PropertyContainer

stella.merit.AbstractMerit

stella.merit.AbstractPhaseMerit

stella.merit.PhaseFillerMerit

All Implemented Interfaces:

Serializable, Cloneable, EndpointDefining, Meriting, Initializable, PropertySupplying

public class PhaseFillerMerit
extends AbstractPhaseMerit
implements EndpointDefining, Initializable

A class that tries to match observations such, that phase gaps are minimized. It is intended for targets that have an unknown period at observation start, but later, when a period has been established, the gaps in phase space are gradually filled. For that, we do the following: The current number of successful observations is used to construct a number of phase slots in a way that the number of slots exceeds the number of successful observations by at least one, but not more than KEY_PHASESLOTS. On all these phase slots, that have already a successful observation in it, the corresponding merit is set to zero. If an observation is timed to fall in a non-null phase slot, a gaussian peaking at the center of the slot and having a full-width half maximum according to KEY_PHASEFWHM (in multiples of slot width) is evaluated. The maximum merit is one.
The merit is end-point defining either if the maximum number of observation has been reached, KEY_MAXOBS, and the number of open slots is less then KEY_PHASESLOTS. If the phase uncertainty exceeds the current slot width, the endpoint is also reached. Zero in KEY_MAXOBS means unlimited number of observations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFMAXOBS Default unlimited number of observations.
private static double	DEFPHASEFWHM Default value for the width in phase space.
private static double	DEFPHASESHIFT Default maximum phase shift.
private static int	DEFPHASESLOTS Default increase in phase slots.
static String	KEY_MAXOBS Observe at these distinct phases.
static String	KEY_PHASEFWHM The key linked to FWHM of the observation intervall in phase space.
static String	KEY_PHASESHIFT If the uncertainty shifts the phase more than this, we stop.
static String	KEY_PHASESLOTS 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 double[]	phases The list of phases we want to observe at.
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
PhaseFillerMerit(Map<String,String> prop) Constructs a phase-coherent merit.

Method Summary

Modifier and Type	Method and Description
private void	clearPhases(HistoryAware target, int back) Grabs a target and goes backward through its success list, deleting on the way all phases already observed.
private static double	forPhase(double phase, double peak, double sig) Calculates the merit at the current phase for the given peak location and shape.
double	getMerit(GlobalGrouping set, Appointable target, Collection ignore, long within) Calculates the actual time slot merit.
boolean	isCompleted(GlobalGrouping set, Appointable target) Check, if the observation is complete, which is the case if the number of unfilled period slots is less then KEY_PHASESLOTS and if the total number of successful observations is at least equal to KEY_MAXOBS.
private boolean	uncertainty(GlobalGrouping set, Appointable target) Return true if the relative phase shift exceed the limit.

Methods inherited from class stella.merit.AbstractPhaseMerit

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

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

Methods inherited from interface util.Initializable

init

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KEY_PHASESLOTS

public static final String KEY_PHASESLOTS

The number of phase points to observe.

See Also:

Constant Field Values

KEY_MAXOBS

public static final String KEY_MAXOBS

Observe at these distinct phases.

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_PHASEFWHM

public static final String KEY_PHASEFWHM

The key linked to FWHM of the observation intervall in phase space.

See Also:

Constant Field Values

DEFPHASESLOTS

private static final int DEFPHASESLOTS

Default increase in phase slots.

See Also:

Constant Field Values

DEFMAXOBS

private static final int DEFMAXOBS

Default unlimited number of observations.

See Also:

Constant Field Values

DEFPHASEFWHM

private static final double DEFPHASEFWHM

Default value for the width in phase space.

See Also:

Constant Field Values

DEFPHASESHIFT

private static final double DEFPHASESHIFT

Default maximum phase shift.

See Also:

Constant Field Values

phases

private double[] phases

The list of phases we want to observe at.

Constructor Detail

PhaseFillerMerit

public PhaseFillerMerit(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

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.

clearPhases

private void clearPhases(HistoryAware target,
                         int back)

Grabs a target and goes backward through its success list, deleting on the way all phases already observed. The caller ensures that we have at least the number of successful observations requested for deletion.

forPhase

private static final double forPhase(double phase,
                                     double peak,
                                     double sig)

Calculates the merit at the current phase for the given peak location and shape.

Parameters:

phase - The merit phase

peak - The individual phase peak.

sigma - Width of individual peak.

isCompleted

public boolean isCompleted(GlobalGrouping set,
                           Appointable target)

Check, if the observation is complete, which is the case if the number of unfilled period slots is less then KEY_PHASESLOTS and if the total number of successful observations is at least equal to KEY_MAXOBS. If maxobs is zero, the only completeness criterium is the uncertainty criterium (which may also stop observations if maxobs is not reached): This is done by matching the phase shift due to period uncertainties to the maximum allowed phase shift.

Specified by:

isCompleted in interface EndpointDefining

uncertainty

private boolean uncertainty(GlobalGrouping set,
                            Appointable target)

Return true if the relative phase shift exceed the limit.