public class AutoGuidingMode extends PropertyResources implements Initializable, ImageReducing
AutoGuiderImageProcessing, in particular the bias/dark/flat frames
and the Gauss filtering, searchbox and datamin/max settings. Others are
used by the AutoGuiderReadoutProviding instance, like the size and
binning, but also the requested mode signal to noise. Finally, the
auto-guider itself uses the information on the PIDs and the maximum step lost
and shift info to actually produce a guiding offset.PropertyResources.Load, PropertyResources.URLResource| Modifier and Type | Field and Description |
|---|---|
private PIDControl |
azpid
The PID for ra/azimuth/first axis.
|
private static long |
DEFDARKGUIDETIME
The default exposure time in milliseconds of the dark 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 Dimension |
DEFGUIDEBINNING
The default binning on guide.
|
private static double |
DEFGUIDEFIELDOFVIEW
The default FoV on guide.
|
private static double |
DEFGUIDESIGNAL
The default S/N on guide.
|
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 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.
|
private PIDControl |
elpid
The PID for de/elevation/second axis.
|
private ArrayLayout |
frame
Layout of bias/dark/flat frame.
|
static String |
KEY_BIASGUIDEFITS
Headerless name of the bias fits file, if we have any.
|
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_FLATGUIDEFITS
Headerless name of the flat fits file, if we have any.
|
static String |
KEY_GAUSSFWHMGUIDE
FWHM of the gaussian filter applied.
|
static String |
KEY_GAUSSTRUNCATEGUIDE
Truncation of the gaussian filter applied.
|
static String |
KEY_GUIDEBINNING
The binning used during guiding.
|
static String |
KEY_GUIDEFIELDOFVIEW
The field-of-view during guiding in degrees.
|
static String |
KEY_GUIDESIGNAL
Signal to noise wanted on guide.
|
static String |
KEY_GUIDESIZE
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_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.
|
private float[] |
mbias
If a bias frame was assigned to this object, we read it on init.
|
private float[] |
mdark
If a dark frame was assigned to this object, we read it on init.
|
private float[] |
mflat
If a flat frame was assigned to this object, we read it on init.
|
private static String |
UNKNOWN |
KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URLKEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATORKEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOMECONFIG, KEY_CLASS| Constructor and Description |
|---|
AutoGuidingMode(Map<String,String> prop)
Constructs a new guider mode from its properties.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clearPIDs()
We clear the PIDs.
|
boolean |
equals(Object obj) |
float[] |
getBias(MImageHDU raw)
Returns a bias frame as a one-dimensional float.
|
Dimension |
getBinning()
Returns the guiding binning for this mode.
|
float[] |
getDark(MImageHDU raw,
double exptime)
Returns a dark frame as a one-dimensional float.
|
int |
getDataMax()
Returns the datamax for searching stars for this mode.
|
int |
getDataMin()
Returns the datamin for searching stars for this mode.
|
double |
getFieldOfView() |
float[] |
getFlat(MImageHDU raw,
String filter)
Returns a flat frame for the specified filter name as a one-dimensional
float.
|
double |
getGaussFwhm()
Returns the applicable Gaussian filtering FWHM in true pixel for this
mode.
|
double |
getGaussTruncation()
Returns the applicable Gaussian filtering FWHM in true pixel 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.
|
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.
|
Dimension |
getReadoutSize()
Returns the guiding frame for this mode.
|
int |
getSearchBox()
Returns the search box size for searching stars for this mode.
|
double |
getSignalToNoise()
Returns the target S/N for this mode.
|
int |
hashCode() |
void |
init()
Initializes this guider mode.
|
private MImageHDU |
readMFits(String resource) |
void |
setName(String modename) |
clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setAppletaugment, 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, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitdefaultBoolean, 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, stringPropertiesprivate static final String UNKNOWN
public static final String KEY_MODENAME
public static final String KEY_GUIDESIZE
public static final String KEY_GUIDEBINNING
public static final String KEY_GUIDESIGNAL
public static final String KEY_GUIDEFIELDOFVIEW
public static final String KEY_GAUSSFWHMGUIDE
public static final String KEY_GAUSSTRUNCATEGUIDE
public static final String KEY_DATAMINGUIDE
public static final String KEY_DATAMAXGUIDE
public static final String KEY_SEARCHBOXGUIDE
public static final String KEY_MAXSHIFTGUIDE
public static final String KEY_MAXSHIFTTARGET
public static final String KEY_MINOFFSETGUIDE
public static final String KEY_MINACQUIRE
public static final String KEY_MAXMISSES
public static final String KEY_MAXSTEPLOST
public static final String KEY_MAXTARGETLOST
public static final String KEY_PIDAZIMUTH
PIDControl class in azimuth.public static final String KEY_PIDALTITUDE
PIDControl class in altitude.public static final String KEY_PIDPERIOD
public static final String KEY_BIASGUIDEFITS
public static final String KEY_DARKGUIDEFITS
public static final String KEY_DARKGUIDETIME
public static final String KEY_FLATGUIDEFITS
private static final double DEFGUIDESIGNAL
private static final double DEFGUIDEFIELDOFVIEW
private static final Dimension DEFGUIDEBINNING
private static final int DEFDATAMINGUIDE
private static final int DEFDATAMAXGUIDE
private static final int DEFSEARCHBOXGUIDE
private static final double DEFMAXSHIFTGUIDE
private static final double DEFMAXSHIFTTARGET
private static final double DEFMINOFFSETGUIDE
private static final double DEFMINACQUIRE
private static final int DEFMAXMISSES
private static final int DEFMAXSTEPLOST
private static final int DEFMAXTARGETLOST
private static final String DEFPIDAZIMUTH
private static final String DEFPIDALTITUDE
private static final long DEFPIDPERIOD
private static final long DEFDARKGUIDETIME
private PIDControl azpid
private PIDControl elpid
private float[] mbias
private float[] mdark
private float[] mflat
private ArrayLayout frame
public void init()
init in interface Initializablepublic void clearPIDs()
public String getModeName()
public Vector2D getPIDCorrection(Vector2D measured)
public Dimension getReadoutSize()
public double getFieldOfView()
public Dimension getBinning()
public float[] getBias(MImageHDU raw) throws BasicFitsException
ImageReducinggetBias in interface ImageReducingraw - The raw image to check geometry.BasicFitsExceptionpublic float[] getDark(MImageHDU raw, double exptime) throws BasicFitsException
ImageReducinggetDark in interface ImageReducingraw - The raw image to check geometry.exptime - The exposure time of the raw image in secondsBasicFitsExceptionpublic float[] getFlat(MImageHDU raw, String filter) throws BasicFitsException
ImageReducinggetFlat in interface ImageReducingraw - The raw image to check geometry.filter - Name of filter or null if only white light or singled-filter
system.BasicFitsExceptionpublic long getPIDPeriod()
public double getSignalToNoise()
public double getGaussFwhm()
public double getGaussTruncation()
public int getDataMin()
public int getDataMax()
public int getSearchBox()
public double getMaxShift()
public double getMaxShiftTarget()
public double getMinOffset()
public double getMinAcquire()
public int getMaxMisses()
public int getMaxStepLost()
public int getMaxTargetLost()
public void setName(String modename)