GuiderMode

java.lang.Object
- util.PropertyContainer
- - stella.adapter.GuiderMode

All Implemented Interfaces:

Cloneable, Guiding.RawFrame, Initializable, PropertySupplying
```
public class GuiderMode
extends PropertyContainer
implements Initializable, Guiding.RawFrame
```
A guider mode combines properties and object needed by the guider unit to do guiding.

Field Summary

Fields
Modifier and Type	Field and Description
`private PIDControl`	`altpid` The PID for de.
`private PIDControl`	`azpid` The PID for ra.
`private static File`	`DEFBIASGUIDEFITS` The default fits file holding guider bias image data.
`private static long`	`DEFBIASGUIDETIME` The default exposure time in milli seconds of the bias frame.
`private static File`	`DEFDARKGUIDEFITS` The default fits file holding guider bias image data.
`private static long`	`DEFDARKGUIDETIME` The default exposure time in milli seconds of the bias frame.
`private static int`	`DEFDATAMAXGUIDE` The default data max for 'good' filtered pixels.
`private static int`	`DEFDATAMINGUIDE` The default data min for 'good' filtered pixels.
`private static double`	`DEFEXPOSEGUIDE` The default S/N on guide.
`private static Dimension`	`DEFGUIDEBINNING` The default binning on guide.
`private static Rectangle`	`DEFGUIDEFRAME` The default guiding frame.
`private static int`	`DEFMAXMISSES` The default number of maximum step losses.
`private static double`	`DEFMAXSHIFTGUIDE` The default maximum shift for a successful guide, pixel.
`private static double`	`DEFMAXSHIFTTARGET` The default maximum shift for a successful match, pixel.
`private static int`	`DEFMAXSTEPLOST` The default number of maximum step losses.
`private static int`	`DEFMAXTARGETLOST` The default number of maximum target losses.
`private static double`	`DEFMINACQUIRE` The minimum acquire shift.
`private static double`	`DEFMINOFFSETGUIDE` The default minimum shift to be applied, degrees.
`private static long`	`DEFMINTIMEGUIDE` Minimum exposure time on guiding in ms.
`private static String`	`DEFPIDALTITUDE` The default properties file for the PID altitude.
`private static String`	`DEFPIDAZIMUTH` The default properties file for the PID azimuth.
`private static long`	`DEFPIDPERIOD` The default period the PID on the guider is optimized for
`private static int`	`DEFSEARCHBOXGUIDE` The default search box, unbiased.
`static String`	`KEY_BIASGUIDEFITS` Headerless name of the bias fits file, if we have any.
`static String`	`KEY_BIASGUIDETIME` Integration time on the bias fits.
`static String`	`KEY_DARKGUIDEFITS` Headerless name of the dark fits file, if we have any.
`static String`	`KEY_DARKGUIDETIME` Time of the dark fits file, if we have any.
`static String`	`KEY_DATAMAXGUIDE` A default data maximum value for star detection.
`static String`	`KEY_DATAMINGUIDE` A default data minimum value for star guiding.
`static String`	`KEY_EXPOSEGUIDE` Signal to noise wanted on guide.
`static String`	`KEY_GUIDEBINNING` The binning used during guiding.
`static String`	`KEY_GUIDEFRAME` The window on the guider ccd used on guiding, unbinned.
`static String`	`KEY_MAXMISSES` Maximum allowed guiding losses until internal acquire.
`static String`	`KEY_MAXSHIFTGUIDE` Maximum allowed shift for pinhole during guide.
`static String`	`KEY_MAXSHIFTTARGET` Maximum allowed shift for matched target.
`static String`	`KEY_MAXSTEPLOST` Maximum allowed star losses until target lost.
`static String`	`KEY_MAXTARGETLOST` Maximum allowed target losses until target drop.
`static String`	`KEY_MINACQUIRE` Minimum required shift during guider reacquire, in degrees.
`static String`	`KEY_MINOFFSETGUIDE` Minimum required shift during guide.
`static String`	`KEY_MINTIMEGUIDE` Minimum exposure time on guiding in ms.
`static String`	`KEY_MODENAME` The name of this mode.
`static String`	`KEY_PIDALTITUDE` The properties of the `PIDControl` class in altitude.
`static String`	`KEY_PIDAZIMUTH` The properties of the `PIDControl` class in azimuth.
`static String`	`KEY_PIDPERIOD` Period the PIDs are optimized for.
`static String`	`KEY_SEARCHBOXGUIDE` A search box for star detection, unbinned.

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

GuiderMode(Map<String,String> prop)
Constructs a new guider mode from its properties.

Constructors
Constructor and Description
`GuiderMode(Map<String,String> prop)` Constructs a new guider mode from its properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearPIDs()` We clear the PIDs.
`File`	`getBiasFrame()` Returns the file holfing the bias image.
`long`	`getBiasTime()` Returns the exposure time of the bias frame.
`Dimension`	`getBinning()` Returns the guiding binning for this mode.
`File`	`getDarkFrame()` Returns the file holding the dark image.
`long`	`getDarkTime()` Returns the exposure time of the bias frame.
`int`	`getDataMax()` Returns the datamax for searching stars for this mode.
`int`	`getDataMin()` Returns the datamin for searching stars for this mode.
`int`	`getMaxMisses()` Number of allowed guiding losses until guider re-acquire is needed in this mode.
`double`	`getMaxShift()` Returns a pixel distance of the maximum shift allowed during guiding in this mode.
`double`	`getMaxShiftTarget()` Returns the maximum distance a star image may be off to the pinhole to be considered still the target we guide on.
`int`	`getMaxStepLost()` Number of allowed guiding losses until master re-acquire is needed in this mode.
`int`	`getMaxTargetLost()` Number of allowed target losses until abort is needed in this mode.
`double`	`getMinAcquire()` Returns a degree distance of the minimum shift that might be applied on permanent fiber misses.
`long`	`getMinExposure()` Returns the minimum exposure time for this mode, ms.
`double`	`getMinOffset()` Returns a degree distance of the minimum shift not considered negligable during guide.
`String`	`getModeName()` Gets the name of the guiding mode.
`Vector2D`	`getPIDCorrection(Vector2D measured)` From a measured shift in az/alt, calculate the PID shift.
`long`	`getPIDPeriod()` Returns the period at which this mode's PID should be fed ion ms.
`Rectangle`	`getReadoutFrame()` Returns the guiding frame for this mode.
`int`	`getSearchBox()` Returns the search box size for searching stars for this mode.
`double`	`getSN()` Returns the target S/N for this mode.
`void`	`init()` Initializes this guider mode.

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_MODENAME
```
public static final String KEY_MODENAME
```
    The name of this mode.
    
    See Also:
    
    Constant Field Values
  - KEY_GUIDEFRAME
```
public static final String KEY_GUIDEFRAME
```
    The window on the guider ccd used on guiding, unbinned.
    
    See Also:
    
    Constant Field Values
  - KEY_GUIDEBINNING
```
public static final String KEY_GUIDEBINNING
```
    The binning used during guiding.
    
    See Also:
    
    Constant Field Values
  - KEY_EXPOSEGUIDE
```
public static final String KEY_EXPOSEGUIDE
```
    Signal to noise wanted on guide.
    
    See Also:
    
    Constant Field Values
  - KEY_MINTIMEGUIDE
```
public static final String KEY_MINTIMEGUIDE
```
    Minimum exposure time on guiding in ms. No maximum time.
    
    See Also:
    
    Constant Field Values
  - KEY_DATAMINGUIDE
```
public static final String KEY_DATAMINGUIDE
```
    A default data minimum value for star guiding.
    
    See Also:
    
    Constant Field Values
  - KEY_DATAMAXGUIDE
```
public static final String KEY_DATAMAXGUIDE
```
    A default data maximum value for star detection.
    
    See Also:
    
    Constant Field Values
  - KEY_SEARCHBOXGUIDE
```
public static final String KEY_SEARCHBOXGUIDE
```
    A search box for star detection, unbinned.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXSHIFTGUIDE
```
public static final String KEY_MAXSHIFTGUIDE
```
    Maximum allowed shift for pinhole during guide. Pixel distance.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXSHIFTTARGET
```
public static final String KEY_MAXSHIFTTARGET
```
    Maximum allowed shift for matched target. Pixel distance.
    
    See Also:
    
    Constant Field Values
  - KEY_MINOFFSETGUIDE
```
public static final String KEY_MINOFFSETGUIDE
```
    Minimum required shift during guide. Distance in degrees.
    
    See Also:
    
    Constant Field Values
  - KEY_MINACQUIRE
```
public static final String KEY_MINACQUIRE
```
    Minimum required shift during guider reacquire, in degrees.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXMISSES
```
public static final String KEY_MAXMISSES
```
    Maximum allowed guiding losses until internal acquire.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXSTEPLOST
```
public static final String KEY_MAXSTEPLOST
```
    Maximum allowed star losses until target lost.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXTARGETLOST
```
public static final String KEY_MAXTARGETLOST
```
    Maximum allowed target losses until target drop.
    
    See Also:
    
    Constant Field Values
  - KEY_PIDAZIMUTH
```
public static final String KEY_PIDAZIMUTH
```
    The properties of the PIDControl class in azimuth.
    
    See Also:
    
    Constant Field Values
  - KEY_PIDALTITUDE
```
public static final String KEY_PIDALTITUDE
```
    The properties of the PIDControl class in altitude.
    
    See Also:
    
    Constant Field Values
  - KEY_PIDPERIOD
```
public static final String KEY_PIDPERIOD
```
    Period the PIDs are optimized for.
    
    See Also:
    
    Constant Field Values
  - KEY_BIASGUIDEFITS
```
public static final String KEY_BIASGUIDEFITS
```
    Headerless name of the bias fits file, if we have any.
    
    See Also:
    
    Constant Field Values
  - KEY_BIASGUIDETIME
```
public static final String KEY_BIASGUIDETIME
```
    Integration time on the bias fits.
    
    See Also:
    
    Constant Field Values
  - KEY_DARKGUIDEFITS
```
public static final String KEY_DARKGUIDEFITS
```
    Headerless name of the dark fits file, if we have any.
    
    See Also:
    
    Constant Field Values
  - KEY_DARKGUIDETIME
```
public static final String KEY_DARKGUIDETIME
```
    Time of the dark fits file, if we have any.
    
    See Also:
    
    Constant Field Values
  - DEFGUIDEFRAME
```
private static final Rectangle DEFGUIDEFRAME
```
    The default guiding frame.
  - DEFGUIDEBINNING
```
private static final Dimension DEFGUIDEBINNING
```
    The default binning on guide.
  - DEFEXPOSEGUIDE
```
private static final double DEFEXPOSEGUIDE
```
    The default S/N on guide. .
    
    See Also:
    
    Constant Field Values
  - DEFMINTIMEGUIDE
```
private static final long DEFMINTIMEGUIDE
```
    Minimum exposure time on guiding in ms. No maximum time.
    
    See Also:
    
    Constant Field Values
  - DEFDATAMINGUIDE
```
private static final int DEFDATAMINGUIDE
```
    The default data min for 'good' filtered pixels.
    
    See Also:
    
    Constant Field Values
  - DEFDATAMAXGUIDE
```
private static final int DEFDATAMAXGUIDE
```
    The default data max for 'good' filtered pixels.
    
    See Also:
    
    Constant Field Values
  - DEFSEARCHBOXGUIDE
```
private static final int DEFSEARCHBOXGUIDE
```
    The default search box, unbiased.
    
    See Also:
    
    Constant Field Values
  - DEFMAXSHIFTGUIDE
```
private static final double DEFMAXSHIFTGUIDE
```
    The default maximum shift for a successful guide, pixel.
    
    See Also:
    
    Constant Field Values
  - DEFMAXSHIFTTARGET
```
private static final double DEFMAXSHIFTTARGET
```
    The default maximum shift for a successful match, pixel.
    
    See Also:
    
    Constant Field Values
  - DEFMINOFFSETGUIDE
```
private static final double DEFMINOFFSETGUIDE
```
    The default minimum shift to be applied, degrees.
    
    See Also:
    
    Constant Field Values
  - DEFMINACQUIRE
```
private static final double DEFMINACQUIRE
```
    The minimum acquire shift. Close to maxshiftguide time guiderscale.
    
    See Also:
    
    Constant Field Values
  - DEFMAXMISSES
```
private static final int DEFMAXMISSES
```
    The default number of maximum step losses.
    
    See Also:
    
    Constant Field Values
  - DEFMAXSTEPLOST
```
private static final int DEFMAXSTEPLOST
```
    The default number of maximum step losses.
    
    See Also:
    
    Constant Field Values
  - DEFMAXTARGETLOST
```
private static final int DEFMAXTARGETLOST
```
    The default number of maximum target losses.
    
    See Also:
    
    Constant Field Values
  - DEFPIDAZIMUTH
```
private static final String DEFPIDAZIMUTH
```
    The default properties file for the PID azimuth.
    
    See Also:
    
    Constant Field Values
  - DEFPIDALTITUDE
```
private static final String DEFPIDALTITUDE
```
    The default properties file for the PID altitude.
    
    See Also:
    
    Constant Field Values
  - DEFPIDPERIOD
```
private static final long DEFPIDPERIOD
```
    The default period the PID on the guider is optimized for
    
    See Also:
    
    Constant Field Values
  - DEFBIASGUIDEFITS
```
private static final File DEFBIASGUIDEFITS
```
    The default fits file holding guider bias image data.
  - DEFBIASGUIDETIME
```
private static final long DEFBIASGUIDETIME
```
    The default exposure time in milli seconds of the bias frame.
    
    See Also:
    
    Constant Field Values
  - DEFDARKGUIDEFITS
```
private static final File DEFDARKGUIDEFITS
```
    The default fits file holding guider bias image data.
  - DEFDARKGUIDETIME
```
private static final long DEFDARKGUIDETIME
```
    The default exposure time in milli seconds of the bias frame.
    
    See Also:
    
    Constant Field Values
  - azpid
```
private PIDControl azpid
```
    The PID for ra.
  - altpid
```
private PIDControl altpid
```
    The PID for de.
- Constructor Detail
  - GuiderMode
```
public GuiderMode(Map<String,String> prop)
```
    Constructs a new guider mode from its properties. Useable only after init.
- Method Detail
  - init
```
public void init()
```
    Initializes this guider mode. Makes the PID-control for azimuth and altitude ready to use.
    
    Specified by:
    
    init in interface Initializable
  - clearPIDs
```
public void clearPIDs()
```
    We clear the PIDs.
  - getModeName
```
public String getModeName()
```
    Gets the name of the guiding mode.
  - getPIDCorrection
```
public Vector2D getPIDCorrection(Vector2D measured)
```
    From a measured shift in az/alt, calculate the PID shift. This shift is then applied to the telescope. Must be initialized.
    
    Returns:
    
    The azimuth shift in x, altitude shift in y or null if no PIDs.
  - getReadoutFrame
```
public Rectangle getReadoutFrame()
```
    Returns the guiding frame for this mode.
    
    Specified by:
    
    getReadoutFrame in interface Guiding.RawFrame
  - getBinning
```
public Dimension getBinning()
```
    Returns the guiding binning for this mode.
    
    Specified by:
    
    getBinning in interface Guiding.RawFrame
  - getBiasFrame
```
public File getBiasFrame()
```
    Returns the file holfing the bias image.
    
    Specified by:
    
    getBiasFrame in interface Guiding.RawFrame
  - getBiasTime
```
public long getBiasTime()
```
    Returns the exposure time of the bias frame. Non-zero only on shutter-less systems.
    
    Specified by:
    
    getBiasTime in interface Guiding.RawFrame
  - getDarkTime
```
public long getDarkTime()
```
    Returns the exposure time of the bias frame. Non-zero only on shutter-less systems.
    
    Specified by:
    
    getDarkTime in interface Guiding.RawFrame
  - getDarkFrame
```
public File getDarkFrame()
```
    Returns the file holding the dark image.
    
    Specified by:
    
    getDarkFrame in interface Guiding.RawFrame
  - getPIDPeriod
```
public long getPIDPeriod()
```
    Returns the period at which this mode's PID should be fed ion ms.
  - getSN
```
public double getSN()
```
    Returns the target S/N for this mode.
  - getDataMin
```
public int getDataMin()
```
    Returns the datamin for searching stars for this mode.
  - getDataMax
```
public int getDataMax()
```
    Returns the datamax for searching stars for this mode.
  - getSearchBox
```
public int getSearchBox()
```
    Returns the search box size for searching stars for this mode.
  - getMinExposure
```
public long getMinExposure()
```
    Returns the minimum exposure time for this mode, ms.
  - getMaxShift
```
public double getMaxShift()
```
    Returns a pixel distance of the maximum shift allowed during guiding in this mode.
  - getMaxShiftTarget
```
public double getMaxShiftTarget()
```
    Returns the maximum distance a star image may be off to the pinhole to be considered still the target we guide on. This distance is used if the pinhole was not found, but a star shift was recovered using the whole frame. Only if the distance of the matching shift is below this value, we consider it to be our target.
    
    Returns:
    
    a maximum distance in pixel.
  - getMinOffset
```
public double getMinOffset()
```
    Returns a degree distance of the minimum shift not considered negligable during guide.
  - getMinAcquire
```
public double getMinAcquire()
```
    Returns a degree distance of the minimum shift that might be applied on permanent fiber misses. The guider unit does its own re-acquire.
  - getMaxMisses
```
public int getMaxMisses()
```
    Number of allowed guiding losses until guider re-acquire is needed in this mode.
  - getMaxStepLost
```
public int getMaxStepLost()
```
    Number of allowed guiding losses until master re-acquire is needed in this mode.
  - getMaxTargetLost
```
public int getMaxTargetLost()
```
    Number of allowed target losses until abort is needed in this mode.

Class GuiderMode

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_MODENAME

KEY_GUIDEFRAME

KEY_GUIDEBINNING

KEY_EXPOSEGUIDE

KEY_MINTIMEGUIDE

KEY_DATAMINGUIDE

KEY_DATAMAXGUIDE

KEY_SEARCHBOXGUIDE

KEY_MAXSHIFTGUIDE

KEY_MAXSHIFTTARGET

KEY_MINOFFSETGUIDE

KEY_MINACQUIRE

KEY_MAXMISSES

KEY_MAXSTEPLOST

KEY_MAXTARGETLOST

KEY_PIDAZIMUTH

KEY_PIDALTITUDE

KEY_PIDPERIOD

KEY_BIASGUIDEFITS

KEY_BIASGUIDETIME

KEY_DARKGUIDEFITS

KEY_DARKGUIDETIME

DEFGUIDEFRAME

DEFGUIDEBINNING

DEFEXPOSEGUIDE

DEFMINTIMEGUIDE

DEFDATAMINGUIDE

DEFDATAMAXGUIDE

DEFSEARCHBOXGUIDE

DEFMAXSHIFTGUIDE

DEFMAXSHIFTTARGET

DEFMINOFFSETGUIDE

DEFMINACQUIRE

DEFMAXMISSES

DEFMAXSTEPLOST

DEFMAXTARGETLOST

DEFPIDAZIMUTH

DEFPIDALTITUDE

DEFPIDPERIOD

DEFBIASGUIDEFITS

DEFBIASGUIDETIME

DEFDARKGUIDEFITS

DEFDARKGUIDETIME

azpid

altpid

Constructor Detail

GuiderMode

Method Detail

init

clearPIDs

getModeName

getPIDCorrection

getReadoutFrame

getBinning

getBiasFrame

getBiasTime

getDarkTime

getDarkFrame

getPIDPeriod

getSN

getDataMin

getDataMax

getSearchBox

getMinExposure

getMaxShift

getMaxShiftTarget

getMinOffset

getMinAcquire

getMaxMisses

getMaxStepLost

getMaxTargetLost