FlatAndScienceGroup

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - globals.parameter.AbstractParameter
    - - stella.globals.FlatAndScienceGroup

All Implemented Interfaces:

Parameter, Cloneable, ErrorDependingParameter, ExitCleaning, Initializable, PropertySupplying, Refreshing, ResourceSupplying
```
public class FlatAndScienceGroup
extends AbstractParameter
implements ErrorDependingParameter, Refreshing
```
This parameter conducts the automatic selection of twilight sky flats.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FlatAndScienceGroup.Db
Test class that retrieves statistic from db and prints it out.
- Nested classes/interfaces inherited from class util.PropertyResources
  PropertyResources.Load, PropertyResources.URLResource

Nested Classes
Modifier and Type	Class and Description
`static class`	`FlatAndScienceGroup.Db` Test class that retrieves statistic from db and prints it out.

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFFILTERLIST` The list of filters served.
`private static String`	`DEFFLATGROUPS` The name of the flat group versus its members.
`private static String`	`DEFFLATMEMBERS` For each filter in filterlist the sky-flat targets to check.
`private static String`	`DEFFLATTYPES` This types indicate flat fields.
`private static String`	`DEFGROUPDEFAULT` Order imposed if multiple groups remain.
`static String`	`DEFNAME` Default name of this parameter.
`private static String`	`DEFPRIORITYDEFAULT` The default filter priority list.
`private static String`	`DEFSCIENCETYPES` These types indicate science targets.
`private static String`	`DEFSETUPIDS` These setups may contain the filter definition.
`private static String`	`DEFTELESCOPE` The name of the telescope for db access.
`private Map<String,Date>`	`flat` The mapping of served filter names to dates of last flat fields.
`private Map<String,List<String>>`	`groups` For each filter group name, we have the list of filters in it.
`private HistorySql`	`hsql` The done db.
`static String`	`KEY_FILTERLIST` The list of filters served.
`static String`	`KEY_FLATGROUPS` The name of the flat group versus its members.
`static String`	`KEY_FLATMEMBERS` For each filter in filterlist the sky-flat targets to check.
`static String`	`KEY_FLATTYPES` This types indicate flat fields.
`static String`	`KEY_GROUPDEFAULT` Order imposed if multiple groups remain.
`static String`	`KEY_HISTORYDB` This are the done database properties, if needed.
`static String`	`KEY_OBSERVEDB` This are the obs database properties, if needed.
`static String`	`KEY_PRIORITYDEFAULT` The default filter priority list.
`static String`	`KEY_SCIENCETYPES` These types indicate science targets.
`static String`	`KEY_SETUPIDS` These setups may contain the filter definition.
`static String`	`KEY_TELESCOPE` The name of the telescope for db access.
`private Map<String,List<String>>`	`members` The mapping of filter names to sky flat target name lists.
`private ObserveSql`	`osql` The obs db.
`private Map<String,Date>`	`science` The mapping of served filter names to dates of last observations.

Fields inherited from class globals.parameter.AbstractParameter
KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources
KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.ErrorDependingParameter
NAMING_EXTENSION

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors
Constructor and Description

FlatAndScienceGroup(Map<String,String> prop)
Constructs a new flat group parameter object, defaulting all values.

Constructors
Constructor and Description
`FlatAndScienceGroup(Map<String,String> prop)` Constructs a new flat group parameter object, defaulting all values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`get()` The filter group is determined by grabbing the filters in the priority order and than selecting a filter group out of all.
`Object`	`getForError(ErrorEvent ee)` Get for error returns no other value than get, only after registering a target the return value may change.
`private List<String>`	`getPriorityList()` This method returns a priority list of filter where flats should be obtained, starting from high to low priorities.
`long`	`getRefreshInterval()` We are a cron for noon.
`void`	`init()` On init, we update our current knowledge of recently observed filters and flats by refreshing.
`boolean`	`isFixedRate()` We are a cron for noon.
`void`	`refresh()` We update the list of observed filters and successfully executed flat fields.
`void`	`registerError(ErrorEvent fin)` Only target finished errors are considered.
`private List<String>`	`screen(List<String> from, String filt)` In a non-destuctive way we screen all entries from the provided list that refer to a flat group name that has the filter in question not in it.
`Object`	`set(Object no)` Sets the value of this parameter.
`private boolean`	`updateFlats()` For each filter in our sky-flat memeber list we check for the last successful observation and keep the most actual one.
`private boolean`	`updateObserved()` For all filters specified in the filterlist, we query the obs-db for their last occurence (=a fits file has been generated).

Methods inherited from class globals.parameter.AbstractParameter
createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, overrideDefaultName, register, rescanned, setName, toString

Methods inherited from class util.PropertyResources
clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer
augment, augment, 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, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface globals.Parameter
getFormatted, getName, getString

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

- Field Detail
  - KEY_TELESCOPE
```
public static final String KEY_TELESCOPE
```
    The name of the telescope for db access.
    
    See Also:
    
    Constant Field Values
  - KEY_FILTERLIST
```
public static final String KEY_FILTERLIST
```
    The list of filters served.
    
    See Also:
    
    Constant Field Values
  - KEY_FLATGROUPS
```
public static final String KEY_FLATGROUPS
```
    The name of the flat group versus its members.
    
    See Also:
    
    Constant Field Values
  - KEY_GROUPDEFAULT
```
public static final String KEY_GROUPDEFAULT
```
    Order imposed if multiple groups remain.
    
    See Also:
    
    Constant Field Values
  - KEY_FLATMEMBERS
```
public static final String KEY_FLATMEMBERS
```
    For each filter in filterlist the sky-flat targets to check.
    
    See Also:
    
    Constant Field Values
  - KEY_SETUPIDS
```
public static final String KEY_SETUPIDS
```
    These setups may contain the filter definition.
    
    See Also:
    
    Constant Field Values
  - KEY_PRIORITYDEFAULT
```
public static final String KEY_PRIORITYDEFAULT
```
    The default filter priority list.
    
    See Also:
    
    Constant Field Values
  - KEY_FLATTYPES
```
public static final String KEY_FLATTYPES
```
    This types indicate flat fields.
    
    See Also:
    
    Constant Field Values
  - KEY_SCIENCETYPES
```
public static final String KEY_SCIENCETYPES
```
    These types indicate science targets.
    
    See Also:
    
    Constant Field Values
  - KEY_HISTORYDB
```
public static final String KEY_HISTORYDB
```
    This are the done database properties, if needed.
    
    See Also:
    
    Constant Field Values
  - KEY_OBSERVEDB
```
public static final String KEY_OBSERVEDB
```
    This are the obs database properties, if needed.
    
    See Also:
    
    Constant Field Values
  - DEFNAME
```
public static final String DEFNAME
```
    Default name of this parameter.
    
    See Also:
    
    Constant Field Values
  - DEFTELESCOPE
```
private static final String DEFTELESCOPE
```
    The name of the telescope for db access.
    
    See Also:
    
    Constant Field Values
  - DEFFILTERLIST
```
private static final String DEFFILTERLIST
```
    The list of filters served.
    
    See Also:
    
    Constant Field Values
  - DEFFLATGROUPS
```
private static final String DEFFLATGROUPS
```
    The name of the flat group versus its members.
    
    See Also:
    
    Constant Field Values
  - DEFGROUPDEFAULT
```
private static final String DEFGROUPDEFAULT
```
    Order imposed if multiple groups remain.
    
    See Also:
    
    Constant Field Values
  - DEFFLATMEMBERS
```
private static final String DEFFLATMEMBERS
```
    For each filter in filterlist the sky-flat targets to check.
    
    See Also:
    
    Constant Field Values
  - DEFSETUPIDS
```
private static final String DEFSETUPIDS
```
    These setups may contain the filter definition.
    
    See Also:
    
    Constant Field Values
  - DEFPRIORITYDEFAULT
```
private static final String DEFPRIORITYDEFAULT
```
    The default filter priority list.
    
    See Also:
    
    Constant Field Values
  - DEFFLATTYPES
```
private static final String DEFFLATTYPES
```
    This types indicate flat fields.
    
    See Also:
    
    Constant Field Values
  - DEFSCIENCETYPES
```
private static final String DEFSCIENCETYPES
```
    These types indicate science targets.
    
    See Also:
    
    Constant Field Values
  - members
```
private Map<String,List<String>> members
```
    The mapping of filter names to sky flat target name lists.
  - groups
```
private Map<String,List<String>> groups
```
    For each filter group name, we have the list of filters in it.
  - science
```
private Map<String,Date> science
```
    The mapping of served filter names to dates of last observations.
  - flat
```
private Map<String,Date> flat
```
    The mapping of served filter names to dates of last flat fields.
  - hsql
```
private transient HistorySql hsql
```
    The done db.
  - osql
```
private transient ObserveSql osql
```
    The obs db.
- Constructor Detail
  - FlatAndScienceGroup
```
public FlatAndScienceGroup(Map<String,String> prop)
```
    Constructs a new flat group parameter object, defaulting all values.
- Method Detail
  - init
```
public void init()
          throws InitException
```
    On init, we update our current knowledge of recently observed filters and flats by refreshing. Additionally, the lookup table matching filter names to available sky-flat group names is initialized and the noon-refresh is initialized.
    
    Specified by:
    
    init in interface Initializable
    
    Overrides:
    
    init in class AbstractParameter
    
    Throws:
    
    InitException
  - get
```
public Object get()
```
    The filter group is determined by grabbing the filters in the priority order and than selecting a filter group out of all. This is done by first using all filter groups available, then discarding all that do not hold the highest priority target. This will leave a list with more than a single entry. We proceed with the next filters in the priority list, now discarding from this already smaller list until only a single element list remains or no more filter are available. Filters that would empty the list completely are ignored, if even after the last filter more than a single filter group prevails, the one higher up in the default list is chosen.
    
    Specified by:
    
    get in interface Parameter
  - set
```
public Object set(Object no)
```
    Description copied from interface: Parameter
    
    Sets the value of this parameter.
    
    Specified by:
    
    set in interface Parameter
    
    Returns:
    
    The previous value of this parameter.
  - refresh
```
public void refresh()
```
    We update the list of observed filters and successfully executed flat fields.
    
    Specified by:
    
    refresh in interface Refreshing
  - isFixedRate
```
public boolean isFixedRate()
```
    We are a cron for noon.
    
    Specified by:
    
    isFixedRate in interface Refreshing
  - getRefreshInterval
```
public long getRefreshInterval()
```
    We are a cron for noon.
    
    Specified by:
    
    getRefreshInterval in interface Refreshing
  - getForError
```
public Object getForError(ErrorEvent ee)
```
    Get for error returns no other value than get, only after registering a target the return value may change.
    
    Specified by:
    
    getForError in interface ErrorDependingParameter
  - registerError
```
public void registerError(ErrorEvent fin)
```
    Only target finished errors are considered. If the target linked to the error was successful, has a filter in the filter list served and is either a science target or a flat field target, the appropriate lookup-table is updated to now reflect the targets pick time.
    
    Specified by:
    
    registerError in interface ErrorDependingParameter
  - screen
```
private List<String> screen(List<String> from,
                            String filt)
```
    In a non-destuctive way we screen all entries from the provided list that refer to a flat group name that has the filter in question not in it.
  - getPriorityList
```
private List<String> getPriorityList()
```
    This method returns a priority list of filter where flats should be obtained, starting from high to low priorities. The priority is determined by first splitting all filters into three groups: A group where the last science observation was after the last flat (or no flat has been taken in this filter), the second group, where the last science observation was before the last flat observation, and the third group, where no science observations have been done. In the first group, the ordering is done by assigning highest priority to this filter with the highest differential time between its science and flat observation, meaning that the flat has been taken quite some time ago. Maximum priority is to the filter that has no flats at all, if this holds for more than one filter, ranking is done according to observational order (oldest first). In the second group, ordering is done according to last flat time: the older the flat entry, the higher the priority. In the last group, ordering is also done according to time of flat entry. If no flat time has been assigned, the filter goes to the top of the list, if this holds for more than a single filter, the defaul ranking defines the order.
  - updateObserved
```
private boolean updateObserved()
                        throws InitException
```
    For all filters specified in the filterlist, we query the obs-db for their last occurence (=a fits file has been generated).
    
    Throws:
    
    InitException
  - updateFlats
```
private boolean updateFlats()
                     throws InitException
```
    For each filter in our sky-flat memeber list we check for the last successful observation and keep the most actual one.
    
    Throws:
    
    InitException

Class FlatAndScienceGroup

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

Field Summary

Fields inherited from class globals.parameter.AbstractParameter

Fields inherited from class util.PropertyResources

Fields inherited from class util.PropertyContainer

Fields inherited from interface stella.ErrorDependingParameter

Fields inherited from interface util.PropertySupplying

Fields inherited from interface util.ResourceSupplying

Constructor Summary

Method Summary

Methods inherited from class globals.parameter.AbstractParameter

Methods inherited from class util.PropertyResources

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface globals.Parameter

Methods inherited from interface util.PropertySupplying

Field Detail

KEY_TELESCOPE

KEY_FILTERLIST

KEY_FLATGROUPS

KEY_GROUPDEFAULT

KEY_FLATMEMBERS

KEY_SETUPIDS

KEY_PRIORITYDEFAULT

KEY_FLATTYPES

KEY_SCIENCETYPES

KEY_HISTORYDB

KEY_OBSERVEDB

DEFNAME

DEFTELESCOPE

DEFFILTERLIST

DEFFLATGROUPS

DEFGROUPDEFAULT

DEFFLATMEMBERS

DEFSETUPIDS

DEFPRIORITYDEFAULT

DEFFLATTYPES

DEFSCIENCETYPES

members

groups

science

flat

hsql

osql

Constructor Detail

FlatAndScienceGroup

Method Detail

init

get

set

refresh

isFixedRate

getRefreshInterval

getForError

registerError

screen

getPriorityList

updateObserved

updateFlats