AbstractAutoGuider

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - stella.util.GenericUnit
    - - stella.acquire.AncillaryCameraUnit
      - stella.acquire.AcquisitionUnit
        
        stella.acquire.AbstractAutoGuider

All Implemented Interfaces:

ImageProcessing, GlobalDepending, Cloneable, AutoGuiding, PersitentAcquiring, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

StarAutoGuider
```
public abstract class AbstractAutoGuider
extends AcquisitionUnit
implements AutoGuiding, ImageProcessing
```
The abstract auto guider provides the base skeleton for an auto guider with an unspecified CCD-readout provider and an unspecified shift detection. It allows PID-controlled offsets to be relayed to the telescope, mode selection based on environmental conditions, mode changes during guiding and limited re-adjustment of guiding efficiency. All offset can be recorded in binary files.

Author:

wooz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractAutoGuider.CommonModes
The known modes each auto guider must support.
- Nested classes/interfaces inherited from class stella.acquire.AcquisitionUnit
  AcquisitionUnit.Modes
- Nested classes/interfaces inherited from class util.PropertyResources
  PropertyResources.Load, PropertyResources.URLResource

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractAutoGuider.CommonModes` The known modes each auto guider must support.

Field Summary

Fields
Modifier and Type	Field and Description
`private AutoGuidingMode`	`active` The guiding mode currently active.
`private static double`	`DEFOFFSETSIGMA` Insignificant offset.
`private static double`	`DEFOSCILLATESIGMA` Insignificant oscillation.
`private static boolean`	`DEFWAITONGUIDE` If true, we wait for offset completion on guide.
`private AutoGuiderReadoutProviding`	`frame` The instance queried by the acquisition CCD for exposures.
`private int`	`guidelost` Counts consecutive losses on the pinhole.
`private Value`	`highwind` Value that has the wind-speed maximum.
`private double`	`increase` A prior detected atmospheric transparency loss for a texp increase.
`static String`	`KEY_ABORTLEFT` Abort only, if we have at least this amount of time left.
`static String`	`KEY_EXPOSURETIMELEFT` The parameter holding the exposure time left.
`static String`	`KEY_FRACTIONALEXPOSE` The parameter holding the fractional exposure time.
`static String`	`KEY_INCREASEGUIDINGLOST` If guiding is lost, increase exposure time by this factor.
`static String`	`KEY_KEEPOFFSETS` If true, we record the az/alt offset in a data output stream.
`static String`	`KEY_KEEPPIDS` If true, we record the pid offset in a data output stream.
`static String`	`KEY_LOSTCOUNT` Issued to the local parameter cluster as number of target losts.
`static String`	`KEY_MODECHANGE` Minimum lost guidings to allow mode change, zero is no change.
`static String`	`KEY_MODESEEING` Minimum seeing at guiding to allow mode change.
`static String`	`KEY_MODEWIND` Minimum wind speed at guiding to allow mode change.
`static String`	`KEY_OFFSETDIR` Directory where the offset streams should be put.
`static String`	`KEY_OFFSETSIGMA` If the average offset is less than this times sigma, we do not send.
`static String`	`KEY_OSCILLATESIGMA` If the average offset is less than this times sigma, we do oscilate.
`static String`	`KEY_SEEING` Issued to the local parameter cluster as the seeing estimate.
`static String`	`KEY_SPURIOUSCOUNT` Issued to the local parameter cluster as number of guiding losts.
`static String`	`KEY_WAITONGUIDE` If true, we wait for offset completion on guide.
`static String`	`KEY_WINDMAX` The wind-speed maxometer parameter.
`private long`	`lastsent` Timestamp of the last offset command sent to the telescope.
`private List<Vector2D>`	`losses` The offsets in the telescope system recorded during pinhole misses.
`private Value`	`lostcount` Value that count star losses.
`private int`	`modelost` Counts consecutive losses of optimum guiding mode.
`private boolean`	`modeswitch` Principal switch that denies automatic mode changes.
`private DataOutputStream`	`offrecord` If measured offset should be written into a stream.
`private static String`	`OFFSETEXTENSION` The extension for the recorded offsets.
`private List<Vector2D>`	`offsets` The offsets in the telescope system recorded per PID period.
`private AbstractAutoGuider.CommonModes`	`original` If the target requested mode is AUTO of the common ones.
`private DataOutputStream`	`pidrecord` If PID-mitigated offset should be written into a stream.
`private static String`	`PIDSEXTENSION` The extension for the recorded pids.
`static String`	`POSTFIX_MODEPROPERTIES` Modes are defined as MODE_XXX+this key, e.g.
`private Value`	`seeing` Value that has the average seeing.
`private Value`	`spuriouscount` Value that count spurious losses.
`private int`	`starlost` Counts consecutive losses of the guide star.
`private int`	`targetlost` Counts consecutive losses of the target.

Fields inherited from class stella.acquire.AcquisitionUnit
KEY_KEEPFITS, KEY_KEEPWHAT

Fields inherited from class stella.acquire.AncillaryCameraUnit
KEY_FITSDIR, KEY_XTENSION

Fields inherited from class stella.util.GenericUnit
KEY_UNITTYPE

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 util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAutoGuider(Map<String,String> props)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAutoGuider(Map<String,String> props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`abort()` Abort signaled by the reducer object.
`private Vector2D`	`applicableOffset()` Averages on all accumulated offsets, feeds the significant averages to the PIDs and returns their correction.
`protected boolean`	`applyNewMode(AutoGuidingMode apply)` This method is called if a new guiding mode should be applied.
`private Pair<Vector2D,Vector2D>`	`averageShift(List<Vector2D> shifts)` Averages one of a list of offsets stored as two-dimensional vectors.
`private void`	`cancelGuiding()` Method to ensure that continuous operation will be canceled as soon as possible.
`private Vector2D`	`checkForFullOffset()` This method is called if the guide star was still recovered, but has never been on the pinhole for quite some time.
`private void`	`closeAllOffsetStreams()` Makes sure that all streams are closed.
`private void`	`closeStream(OutputStream record)` Makes sure that the specified stream is closed.
`void`	`configureUnit()` We test is all common modes are available, i.e., all common modes have properties.
`abstract AutoGuiderReadoutProviding`	`createReadout(Map<String,String> prop)` The readout provide must be able to supply the required readout frame, binning and exposure time at any time within the guiding process.
`private AutoGuidingMode`	`getCurrentlyBestMode()` From the current wind and seeing conditions, we deduce one of the common guiding modes to be selected: `AbstractAutoGuider.CommonModes.WIND` if the maximum wind speed exceeds the `KEY_MODEWIND` property, `AbstractAutoGuider.CommonModes.SEEING` if the windspeed is apt, but the average seeing is higher than `KEY_MODESEEING`, `AbstractAutoGuider.CommonModes.NORMAL` otherwise.
`List<StarProspect>`	`getExpectedStars(double texp, Rectangle readout, Dimension bin, boolean single)` From a readout frame plus binning on a detector, return a list of star one expects to see on the CCD.
`protected AutoGuidingMode`	`getModeFromName(String modename)` Each mode must be present in the autoguiders properties as a `<modename>modeproperties` entry.
`private File`	`getOffsetStreamDirectory()`
`private Map<String,String>`	`getPropertiesForModeName(String modename)`
`protected Map<String,String>`	`getReadoutProperties()` Returns the properties used to construct the readout provider.
`private String`	`getRecordName(String ext)`
`private DataOutputStream`	`getRecordStream(String ext)`
`Vector2D`	`guideShift(Rectangle readout, Dimension bin, double t0, MImageHDU reduced, Guiding ag)`
`void`	`ioException(IOException atread)` Signals that an I/O Exception has occurred.
`protected boolean`	`isAllowModeSwitch()` Returns the status of the principal mode switch.
`protected void`	`measuredShift(Date now, Vector2D pixel, boolean onpin)` This is the callback method from the image reducing instance.
`boolean`	`processFits(MFits ccd, Rectangle readout, Dimension bin, double expt, Date dateobs, int count)` Reduces a fits image.
`void`	`registerGlobals(GlobalGrouping set)` We scan the parameter set for the windspeed, seeing, a counter for spurious guiding losses and target losses.
`private void`	`restart()` We try to reset the CCD.
`protected void`	`setAllowModeSwitch(boolean modeswitch)` Disables automatic adjustment of the active guiding mode if called with false.
`protected boolean`	`setMode(AutoGuidingMode apply)`
`private double`	`significant(Vector2D avsig)` Checks the absolute value in the first argument versus the significance level and the standard deviation in the second argument.
`boolean`	`startGuiding(AutoGuidingMode apply, Guiding ag, TransparencyMeasuring prior)` Starts guiding in the requested mode.
`boolean`	`stopGuiding(Guiding ag)` Stops an active guiding and blocks until all exposures are finished.
`private void`	`writeRecord(DataOutputStream record, double az, double alt)` If the record file is non null, write the two doubles as floats into it.

Methods inherited from class stella.acquire.AcquisitionUnit
getAcquisitionResource, getBinaryAcquisition, getExpectedStars, getOneExtension, getRaw, persitent, reduce16, sendFieldOfView, sendShifts, sendTelescopeOffset, setAcquisitionAndGuiding, setCount, setTry

Methods inherited from class stella.acquire.AncillaryCameraUnit
binningAndWindow, getAcquisitionExtension, getFitsDirectory, getOneExposure, isManual, reducedFloat, save, save, setManual

Methods inherited from class stella.util.GenericUnit
defaultGuidingStar, getMaster, getUnitType, init, isValid, isValid, setMaster

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, 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.acquire.AutoGuiding
getGuiding

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_OFFSETDIR
```
public static final String KEY_OFFSETDIR
```
    Directory where the offset streams should be put.
    
    See Also:
    
    Constant Field Values
  - KEY_KEEPOFFSETS
```
public static final String KEY_KEEPOFFSETS
```
    If true, we record the az/alt offset in a data output stream.
    
    See Also:
    
    Constant Field Values
  - KEY_KEEPPIDS
```
public static final String KEY_KEEPPIDS
```
    If true, we record the pid offset in a data output stream.
    
    See Also:
    
    Constant Field Values
  - KEY_LOSTCOUNT
```
public static final String KEY_LOSTCOUNT
```
    Issued to the local parameter cluster as number of target losts.
    
    See Also:
    
    Constant Field Values
  - KEY_SPURIOUSCOUNT
```
public static final String KEY_SPURIOUSCOUNT
```
    Issued to the local parameter cluster as number of guiding losts.
    
    See Also:
    
    Constant Field Values
  - KEY_SEEING
```
public static final String KEY_SEEING
```
    Issued to the local parameter cluster as the seeing estimate.
    
    See Also:
    
    Constant Field Values
  - KEY_WINDMAX
```
public static final String KEY_WINDMAX
```
    The wind-speed maxometer parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_EXPOSURETIMELEFT
```
public static final String KEY_EXPOSURETIMELEFT
```
    The parameter holding the exposure time left.
    
    See Also:
    
    Constant Field Values
  - KEY_FRACTIONALEXPOSE
```
public static final String KEY_FRACTIONALEXPOSE
```
    The parameter holding the fractional exposure time.
    
    See Also:
    
    Constant Field Values
  - KEY_MODECHANGE
```
public static final String KEY_MODECHANGE
```
    Minimum lost guidings to allow mode change, zero is no change.
    
    See Also:
    
    Constant Field Values
  - KEY_MODEWIND
```
public static final String KEY_MODEWIND
```
    Minimum wind speed at guiding to allow mode change.
    
    See Also:
    
    Constant Field Values
  - KEY_MODESEEING
```
public static final String KEY_MODESEEING
```
    Minimum seeing at guiding to allow mode change.
    
    See Also:
    
    Constant Field Values
  - KEY_WAITONGUIDE
```
public static final String KEY_WAITONGUIDE
```
    If true, we wait for offset completion on guide.
    
    See Also:
    
    Constant Field Values
  - KEY_ABORTLEFT
```
public static final String KEY_ABORTLEFT
```
    Abort only, if we have at least this amount of time left.
    
    See Also:
    
    Constant Field Values
  - KEY_INCREASEGUIDINGLOST
```
public static final String KEY_INCREASEGUIDINGLOST
```
    If guiding is lost, increase exposure time by this factor.
    
    See Also:
    
    Constant Field Values
  - KEY_OFFSETSIGMA
```
public static final String KEY_OFFSETSIGMA
```
    If the average offset is less than this times sigma, we do not send.
    
    See Also:
    
    Constant Field Values
  - KEY_OSCILLATESIGMA
```
public static final String KEY_OSCILLATESIGMA
```
    If the average offset is less than this times sigma, we do oscilate.
    
    See Also:
    
    Constant Field Values
  - DEFWAITONGUIDE
```
private static final boolean DEFWAITONGUIDE
```
    If true, we wait for offset completion on guide.
    
    See Also:
    
    Constant Field Values
  - DEFOFFSETSIGMA
```
private static final double DEFOFFSETSIGMA
```
    Insignificant offset.
    
    See Also:
    
    Constant Field Values
  - DEFOSCILLATESIGMA
```
private static final double DEFOSCILLATESIGMA
```
    Insignificant oscillation.
    
    See Also:
    
    Constant Field Values
  - OFFSETEXTENSION
```
private static final String OFFSETEXTENSION
```
    The extension for the recorded offsets.
    
    See Also:
    
    Constant Field Values
  - PIDSEXTENSION
```
private static final String PIDSEXTENSION
```
    The extension for the recorded pids.
    
    See Also:
    
    Constant Field Values
  - frame
```
private AutoGuiderReadoutProviding frame
```
    The instance queried by the acquisition CCD for exposures.
  - original
```
private AbstractAutoGuider.CommonModes original
```
    If the target requested mode is AUTO of the common ones.
  - active
```
private AutoGuidingMode active
```
    The guiding mode currently active.
  - guidelost
```
private int guidelost
```
    Counts consecutive losses on the pinhole.
  - starlost
```
private int starlost
```
    Counts consecutive losses of the guide star.
  - targetlost
```
private int targetlost
```
    Counts consecutive losses of the target.
  - modelost
```
private int modelost
```
    Counts consecutive losses of optimum guiding mode.
  - offrecord
```
private DataOutputStream offrecord
```
    If measured offset should be written into a stream.
  - pidrecord
```
private DataOutputStream pidrecord
```
    If PID-mitigated offset should be written into a stream.
  - offsets
```
private List<Vector2D> offsets
```
    The offsets in the telescope system recorded per PID period.
  - losses
```
private List<Vector2D> losses
```
    The offsets in the telescope system recorded during pinhole misses.
  - lastsent
```
private long lastsent
```
    Timestamp of the last offset command sent to the telescope.
  - modeswitch
```
private boolean modeswitch
```
    Principal switch that denies automatic mode changes.
  - spuriouscount
```
private Value spuriouscount
```
    Value that count spurious losses.
  - lostcount
```
private Value lostcount
```
    Value that count star losses.
  - highwind
```
private Value highwind
```
    Value that has the wind-speed maximum.
  - seeing
```
private Value seeing
```
    Value that has the average seeing.
  - increase
```
private double increase
```
    A prior detected atmospheric transparency loss for a texp increase.
  - POSTFIX_MODEPROPERTIES
```
public static final String POSTFIX_MODEPROPERTIES
```
    Modes are defined as MODE_XXX+this key, e.g. 'normalmodeproperties'.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractAutoGuider
```
protected AbstractAutoGuider(Map<String,String> props)
```
    Parameters:
    
    props -
- Method Detail
  - configureUnit
```
public void configureUnit()
                   throws ConfigurationException
```
    We test is all common modes are available, i.e., all common modes have properties.
    
    Specified by:
    
    configureUnit in class AncillaryCameraUnit
    
    Throws:
    
    ConfigurationException
  - getExpectedStars
```
public List<StarProspect> getExpectedStars(double texp,
                                           Rectangle readout,
                                           Dimension bin,
                                           boolean single)
```
    Description copied from class: AcquisitionUnit
    
    From a readout frame plus binning on a detector, return a list of star one expects to see on the CCD.
    
    Specified by:
    
    getExpectedStars in class AcquisitionUnit
    
    Parameters:
    
    texp - Exposure time in seconds.
    
    Returns:
  - registerGlobals
```
public void registerGlobals(GlobalGrouping set)
```
    We scan the parameter set for the windspeed, seeing, a counter for spurious guiding losses and target losses.
    
    Specified by:
    
    registerGlobals in interface GlobalDepending
    
    Overrides:
    
    registerGlobals in class GenericUnit
  - startGuiding
```
public boolean startGuiding(AutoGuidingMode apply,
                            Guiding ag,
                            TransparencyMeasuring prior)
```
    Description copied from interface: AutoGuiding
    
    Starts guiding in the requested mode. If the mode is null, the best mode should be deduced automatically. During guiding, #guideShift(Rectangle, Dimension, double, MImageHDU, AcquisitionAndGuiding) will be called repeatedly.
    
    Specified by:
    
    startGuiding in interface AutoGuiding
    
    Returns:
  - stopGuiding
```
public boolean stopGuiding(Guiding ag)
```
    Stops an active guiding and blocks until all exposures are finished. Closes all possibly open offset streams and stops the continuous acquisition of the guider CCD. Clears the reduce and readout providing instances. Nulls the active mode.
    
    Specified by:
    
    stopGuiding in interface AutoGuiding
    
    Returns:
    
    Blocks until continuous operation ceases, return true.
  - ioException
```
public void ioException(IOException atread)
```
    Description copied from interface: ImageProcessing
    
    Signals that an I/O Exception has occurred.
    
    Specified by:
    
    ioException in interface ImageProcessing
  - processFits
```
public boolean processFits(MFits ccd,
                           Rectangle readout,
                           Dimension bin,
                           double expt,
                           Date dateobs,
                           int count)
```
    Description copied from interface: ImageProcessing
    
    Reduces a fits image. The fits consists of fully accessible MImageHDU, i.e. with a filled buffer
    The readout frame is always in unbinned pixel. The exposure time is in milliseconds.
    
    Specified by:
    
    processFits in interface ImageProcessing
    
    Parameters:
    
    ccd - The non-null, data-carrying FITS object from the camera.
    
    readout - Unbinned readout window, if null entire CCD read.
    
    bin - The binning used, if null 1x1 binning.
    
    expt - The applied exposure time in milliseconds.
    
    dateobs - The actual date of the exposure, if null use system time.
    
    Returns:
    
    True on success.
  - guideShift
```
public Vector2D guideShift(Rectangle readout,
                           Dimension bin,
                           double t0,
                           MImageHDU reduced,
                           Guiding ag)
                    throws NoShiftException
```
    Specified by:
    
    guideShift in interface AutoGuiding
    
    Parameters:
    
    readout -
    
    bin -
    
    expt -
    
    reduced -
    
    Returns:
    
    Throws:
    
    NoShiftException
  - isAllowModeSwitch
```
protected boolean isAllowModeSwitch()
```
    Returns the status of the principal mode switch. If true, mode switching is allowed, if the target did not request a special mode (the target requested AUTO or null and our default mode is AUTO) and the guider's properties has a modelost count that is not zero.
    
    Returns:
    
    the modeswitch
  - setAllowModeSwitch
```
protected void setAllowModeSwitch(boolean modeswitch)
```
    Disables automatic adjustment of the active guiding mode if called with false. If called with true, several other conditions must be met to allow automatic mode changes.
    
    Parameters:
    
    modeswitch - the modeswitch to set
    
    See Also:
    
    isAllowModeSwitch()
  - getCurrentlyBestMode
```
private AutoGuidingMode getCurrentlyBestMode()
```
    From the current wind and seeing conditions, we deduce one of the common guiding modes to be selected: AbstractAutoGuider.CommonModes.WIND if the maximum wind speed exceeds the KEY_MODEWIND property, AbstractAutoGuider.CommonModes.SEEING if the windspeed is apt, but the average seeing is higher than KEY_MODESEEING, AbstractAutoGuider.CommonModes.NORMAL otherwise.
    The requested mode is then located via its name and must be present in the guiders properties.
    
    Returns:
    
    The currently best mode.
    
    See Also:
    
    getModeFromName(String)
  - getModeFromName
```
protected AutoGuidingMode getModeFromName(String modename)
                                   throws NoSuchModeException
```
    Each mode must be present in the autoguiders properties as a <modename>modeproperties entry. If not found, a NoSuchModeException is thrown.
    
    Parameters:
    
    modename -
    
    Returns:
    
    The autoguiding mode of the stated name.
    
    Throws:
    
    NoSuchModeException
  - getPropertiesForModeName
```
private Map<String,String> getPropertiesForModeName(String modename)
                                             throws NoSuchModeException
```
    Parameters:
    
    modename -
    
    Returns:
    
    Throws:
    
    NoSuchModeException
  - getRecordName
```
private String getRecordName(String ext)
```
  - getRecordStream
```
private DataOutputStream getRecordStream(String ext)
```
  - closeAllOffsetStreams
```
private void closeAllOffsetStreams()
```
    Makes sure that all streams are closed.
    
    Throws:
    
    IOException
  - closeStream
```
private void closeStream(OutputStream record)
```
    Makes sure that the specified stream is closed.
  - cancelGuiding
```
private void cancelGuiding()
```
    Method to ensure that continuous operation will be canceled as soon as possible. Returns immediately.
  - restart
```
private void restart()
```
    We try to reset the CCD. If this is not possible, either because the CCD is not resettable in the first place or if resetting fails, we cancel guiding and drop the target.
  - abort
```
private void abort()
```
    Abort signaled by the reducer object. Means that there is a severe error.
  - measuredShift
```
protected void measuredShift(Date now,
                             Vector2D pixel,
                             boolean onpin)
                      throws PositioningException
```
    This is the callback method from the image reducing instance. Depending on the mode, we accumulate shifts until the pid-period is surpassed. We then average the shifts, feed them into the PID and then apply it to the telescope, if not negligible.
    
    Throws:
    
    PositioningException
  - applicableOffset
```
private Vector2D applicableOffset()
```
    Averages on all accumulated offsets, feeds the significant averages to the PIDs and returns their correction.
    
    Returns:
  - significant
```
private double significant(Vector2D avsig)
```
    Checks the absolute value in the first argument versus the significance level and the standard deviation in the second argument.
    
    Parameters:
    
    avsig -
    
    Returns:
    
    Zero or the first argument
  - checkForFullOffset
```
private Vector2D checkForFullOffset()
```
    This method is called if the guide star was still recovered, but has never been on the pinhole for quite some time. This method checks, if a full shift instead of a PID-mitigated shift is feasible.
    
    Returns:
  - applyNewMode
```
protected boolean applyNewMode(AutoGuidingMode apply)
                        throws PositioningException
```
    This method is called if a new guiding mode should be applied. We first empty the old PID, then call
    
    Parameters:
    
    apply -
    
    Returns:
    
    Throws:
    
    PositioningException
  - setMode
```
protected boolean setMode(AutoGuidingMode apply)
```
  - writeRecord
```
private void writeRecord(DataOutputStream record,
                         double az,
                         double alt)
```
    If the record file is non null, write the two doubles as floats into it.
  - averageShift
```
private Pair<Vector2D,Vector2D> averageShift(List<Vector2D> shifts)
```
    Averages one of a list of offsets stored as two-dimensional vectors. Returns the average and the standard deviation in one Vector2D.
  - createReadout
```
public abstract AutoGuiderReadoutProviding createReadout(Map<String,String> prop)
```
    The readout provide must be able to supply the required readout frame, binning and exposure time at any time within the guiding process. It is perfectly legal to provide a non-changing frame, binning, and/or exposure time, in which case the appropriate isFixed... methods should return true.
    
    Returns:
    
    The equivalent to a readout provider.
  - getReadoutProperties
```
protected Map<String,String> getReadoutProperties()
```
    Returns the properties used to construct the readout provider. Default implementations returns my properties.
    
    Returns:
  - getOffsetStreamDirectory
```
private File getOffsetStreamDirectory()
```

Class AbstractAutoGuider

Nested Class Summary

Nested classes/interfaces inherited from class stella.acquire.AcquisitionUnit

Nested classes/interfaces inherited from class util.PropertyResources

Field Summary

Fields inherited from class stella.acquire.AcquisitionUnit

Fields inherited from class stella.acquire.AncillaryCameraUnit

Fields inherited from class stella.util.GenericUnit

Fields inherited from class util.PropertyResources

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.ResourceSupplying

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class stella.acquire.AcquisitionUnit

Methods inherited from class stella.acquire.AncillaryCameraUnit

Methods inherited from class stella.util.GenericUnit

Methods inherited from class util.PropertyResources

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface stella.acquire.AutoGuiding

Methods inherited from interface util.PropertySupplying

Field Detail

KEY_OFFSETDIR

KEY_KEEPOFFSETS

KEY_KEEPPIDS

KEY_LOSTCOUNT

KEY_SPURIOUSCOUNT

KEY_SEEING

KEY_WINDMAX

KEY_EXPOSURETIMELEFT

KEY_FRACTIONALEXPOSE

KEY_MODECHANGE

KEY_MODEWIND

KEY_MODESEEING

KEY_WAITONGUIDE

KEY_ABORTLEFT

KEY_INCREASEGUIDINGLOST

KEY_OFFSETSIGMA

KEY_OSCILLATESIGMA

DEFWAITONGUIDE

DEFOFFSETSIGMA

DEFOSCILLATESIGMA

OFFSETEXTENSION

PIDSEXTENSION

frame

original

active

guidelost

starlost

targetlost

modelost

offrecord

pidrecord

offsets

losses

lastsent

modeswitch

spuriouscount

lostcount

highwind

seeing

increase

POSTFIX_MODEPROPERTIES

Constructor Detail

AbstractAutoGuider

Method Detail

configureUnit

getExpectedStars

registerGlobals

startGuiding

stopGuiding

ioException

processFits

guideShift

isAllowModeSwitch

setAllowModeSwitch

getCurrentlyBestMode

getModeFromName

getPropertiesForModeName