AbstractPhaseMerit

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

All Implemented Interfaces:

Serializable, Cloneable, Meriting, PropertySupplying

Direct Known Subclasses:

PhaseAvoidanceMerit, PhaseCoherentMerit, PhaseFillerMerit, PhaseMerit, TransitMerit
```
public abstract class AbstractPhaseMerit
extends AbstractMerit
```
An abstract class that calculates the current phase of an object. This can be acheived either by setting the KEY_ZEROPHASE to the HJD of phase zero, otherwise the first successful observation will be used to define the zero phase.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFHJDCORRECTION` Default hjd correction parameter name.
`private static String`	`DEFJD` Default jd parameter name.
`private static boolean`	`DEFUSEHJD` Default is HJD-cofrrected.
`static String`	`KEY_HJDCORRECTION` The key pointing to the name of the jd parameter.
`static String`	`KEY_JD` The key pointing to the name of the jd parameter.
`static String`	`KEY_PERIODDAY` The period of the observation, days.
`static String`	`KEY_USEHJD` If true, use HJD.
`static String`	`KEY_ZEROPHASE` The jd defining zero phase.
`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 AbstractPhaseMerit(Map<String,String> prop)
Constructs a phase-coherent merit.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPhaseMerit(Map<String,String> prop)` Constructs a phase-coherent merit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected double`	`getDaysSinceT0(TargetDefinition target, GlobalGrouping set)` Calculates the days from phase zero.
`protected double`	`getHjd(Date when, TargetDefinition target)` Returns the HJD of the stated ms time for this target.
`protected double`	`getHjd(long ms, TargetDefinition target)` Returns the HJD of the stated ms time for this target.
`private static double`	`getHjd(long ms, TargetDefinition target, boolean usehjd)` Returns the HJD of the stated ms time for this target.
`protected int`	`getPeriodsSinceT0(TargetDefinition target, GlobalGrouping set)`
`protected double`	`getPhase(TargetDefinition target, GlobalGrouping set)` Returns the current phase.
`protected double`	`getPhase(TargetDefinition target, long time)` Returns the phase at the stated date.
`protected double`	`getT0(TargetDefinition target)` Calculates the phase zero in JD.
`void`	`init()` We have to have a period now.

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 stella.Meriting
getMerit

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - KEY_PERIODDAY
```
public static final String KEY_PERIODDAY
```
    The period of the observation, days.
    
    See Also:
    
    Constant Field Values
  - KEY_ZEROPHASE
```
public static final String KEY_ZEROPHASE
```
    The jd defining zero phase.
    
    See Also:
    
    Constant Field Values
  - KEY_JD
```
public static final String KEY_JD
```
    The key pointing to the name of the jd parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_USEHJD
```
public static final String KEY_USEHJD
```
    If true, use HJD.
    
    See Also:
    
    Constant Field Values
  - KEY_HJDCORRECTION
```
public static final String KEY_HJDCORRECTION
```
    The key pointing to the name of the jd parameter.
    
    See Also:
    
    Constant Field Values
  - DEFJD
```
private static final String DEFJD
```
    Default jd parameter name.
    
    See Also:
    
    Constant Field Values
  - DEFHJDCORRECTION
```
private static final String DEFHJDCORRECTION
```
    Default hjd correction parameter name.
    
    See Also:
    
    Constant Field Values
  - DEFUSEHJD
```
private static final boolean DEFUSEHJD
```
    Default is HJD-cofrrected.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractPhaseMerit
```
protected AbstractPhaseMerit(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()
```
    We have to have a period now.
  - getT0
```
protected double getT0(TargetDefinition target)
```
    Calculates the phase zero in JD. If the phase zero is undefined, we use the first successful observation of this target and calculate the HJD of the center of that observation.
  - getDaysSinceT0
```
protected double getDaysSinceT0(TargetDefinition target,
                                GlobalGrouping set)
```
    Calculates the days from phase zero. If the phase zero is undefined, we use the first successful observation of this target and calculate the HJD of the center of that observation.
  - getPeriodsSinceT0
```
protected int getPeriodsSinceT0(TargetDefinition target,
                                GlobalGrouping set)
```
  - getHjd
```
protected double getHjd(Date when,
                        TargetDefinition target)
```
    Returns the HJD of the stated ms time for this target.
  - getHjd
```
protected double getHjd(long ms,
                        TargetDefinition target)
```
    Returns the HJD of the stated ms time for this target.
  - getHjd
```
private static double getHjd(long ms,
                             TargetDefinition target,
                             boolean usehjd)
```
    Returns the HJD of the stated ms time for this target.
  - getPhase
```
protected double getPhase(TargetDefinition target,
                          long time)
```
    Returns the phase at the stated date.
  - getPhase
```
protected double getPhase(TargetDefinition target,
                          GlobalGrouping set)
```
    Returns the current phase.

Class AbstractPhaseMerit

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

Methods inherited from interface stella.Meriting

Field Detail

serialVersionUID

KEY_PERIODDAY

KEY_ZEROPHASE

KEY_JD

KEY_USEHJD

KEY_HJDCORRECTION

DEFJD

DEFHJDCORRECTION

DEFUSEHJD

Constructor Detail

AbstractPhaseMerit

Method Detail

init

getT0

getDaysSinceT0

getPeriodsSinceT0

getHjd

getHjd

getHjd

getPhase

getPhase