stella.acquire

Class AncillaryCameraUnit

java.lang.Object

util.PropertyContainer

util.PropertyResources

stella.util.GenericUnit

stella.acquire.AncillaryCameraUnit

All Implemented Interfaces:

GlobalDepending, Cloneable, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

AbstractFocussingUnit, AcquisitionUnit

public abstract class AncillaryCameraUnit
extends GenericUnit

A generic unit that supplies an ancillary camera for various purposes, most notably for acquisition and guiding.

Author:

wooz

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_FITSDIR Where acquisition-related data should be logged.
static String	KEY_XTENSION If not the first image HDU should be used for guiding.
private boolean	manual If true, we are in manual mode and do not generate status events.

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	AncillaryCameraUnit(Map<String,String> props)

Method Summary

Modifier and Type	Method and Description
protected boolean	binningAndWindow(CcdDriver camera, Rectangle readout, Dimension bin) Convenience method to set a read-out window and binning on a CCD.
private boolean	binningAndWindowResetable(CcdDriver camera, Rectangle readout, Dimension bin, boolean retry)
abstract void	configureUnit()
protected MImageHDU	getAcquisitionExtension(MFits mf) For ancillary cameras that return ambiguous (i.e.
protected File	getFitsDirectory() For storing ancillary images, this method returns a valid directory.
protected MFits	getOneExposure(CcdDriver camera, double texp) This method returns a single exposure of the ancillary camera as an MFits object.
private MFits	getOneExposureResetable(CcdDriver camera, double texp, boolean retry) This method returns a single exposure of the ancillary camera as an MFits object.
boolean	isManual() Returns the manual status, normally inherited from the adapter master.
protected float[]	reducedFloat(MImageHDU raw, float[] bias, float[] scaledark, float[] flat) Convenience method to convert a (16-bit) image from the ancillary camera into a bias/dark/flat-field reduced float image.
protected boolean	save(File write, ArrayLayout geom, float[] reduced) Convenience for saving 16-bit image hdu in fits files.
protected boolean	save(File write, MImageHDU reduced) Convenience for saving image hdu in fits files.
void	setManual(boolean nostatus) Sets manual mode, in which case we should not send status event, but rather use syslog.

Methods inherited from class stella.util.GenericUnit

defaultGuidingStar, getMaster, getUnitType, init, isValid, isValid, registerGlobals, 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 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_XTENSION

public static final String KEY_XTENSION

If not the first image HDU should be used for guiding.

See Also:

Constant Field Values

KEY_FITSDIR

public static final String KEY_FITSDIR

Where acquisition-related data should be logged.

See Also:

Constant Field Values

manual

private boolean manual

If true, we are in manual mode and do not generate status events.

Constructor Detail

AncillaryCameraUnit

protected AncillaryCameraUnit(Map<String,String> props)

Parameters:

props -

Method Detail

configureUnit

public abstract void configureUnit()
                            throws ConfigurationException

Throws:

ConfigurationException

setManual

public void setManual(boolean nostatus)

Sets manual mode, in which case we should not send status event, but rather use syslog.

isManual

public boolean isManual()

Returns the manual status, normally inherited from the adapter master.

getFitsDirectory

protected File getFitsDirectory()

For storing ancillary images, this method returns a valid directory.

Returns:

save

protected boolean save(File write,
                       MImageHDU reduced)

Convenience for saving image hdu in fits files. Does not throw an exception, deemed non-critical.

save

protected boolean save(File write,
                       ArrayLayout geom,
                       float[] reduced)

Convenience for saving 16-bit image hdu in fits files. Does not throw an exception, deemed non-critical.

Throws:

BasicFitsException

binningAndWindow

protected boolean binningAndWindow(CcdDriver camera,
                                   Rectangle readout,
                                   Dimension bin)

Convenience method to set a read-out window and binning on a CCD. Does reset the camera if unsuccessful and the CcdDriver implements Resettable.

Parameters:

camera -

readout -

bin -

Returns:

binningAndWindowResetable

private boolean binningAndWindowResetable(CcdDriver camera,
                                          Rectangle readout,
                                          Dimension bin,
                                          boolean retry)
                                   throws IOException

Throws:

IOException

getAcquisitionExtension

protected MImageHDU getAcquisitionExtension(MFits mf)
                                     throws BasicFitsException

For ancillary cameras that return ambiguous (i.e. more than a single) MImageHDU in the exposure. This method is a convenience method that discards all extension except the one pointed to by KEY_XTENSION, or, if this property is undefined, returns the first image HDU.

Parameters:

mf -

Returns:

Throws:

BasicFitsException

getOneExposure

protected MFits getOneExposure(CcdDriver camera,
                               double texp)
                        throws IOException

This method returns a single exposure of the ancillary camera as an MFits object.

Parameters:

camera -

texp -

retry -

Returns:

Throws:

IOException

getOneExposureResetable

private MFits getOneExposureResetable(CcdDriver camera,
                                      double texp,
                                      boolean retry)
                               throws IOException

This method returns a single exposure of the ancillary camera as an MFits object.

Parameters:

camera -

texp -

retry -

Returns:

Throws:

IOException

reducedFloat

protected float[] reducedFloat(MImageHDU raw,
                               float[] bias,
                               float[] scaledark,
                               float[] flat)
                        throws BasicFitsException

Convenience method to convert a (16-bit) image from the ancillary camera into a bias/dark/flat-field reduced float image.

Parameters:

raw - The raw image data, not necessarily 16 bit

bias - May be null

scaledark - A dark frame scaled to the exposure time or null

flat - May be null

Returns:

Regardless of input type, a float array. Geometry as in raw

Throws:

BasicFitsException