stella.rmi
Interface CcdControlling

All Superinterfaces:

ListenerControlling, Remote

All Known Subinterfaces:

AutoClearControlling, ReadoutModeControlling, SesControlling, WifsipControlling

All Known Implementing Classes:

SesMaster, WifsipMaster

public interface CcdControlling
extends ListenerControlling

An interface specifying the necessary camera commands to allow remote access. Additionally extends the ListenerControlling interface to allow control-transfer from the outside.

Method Summary

boolean	abortExposure(String abortfits) Abort the exposure currently underway.
boolean	addFitsKey(String key, String parametername, String comment) Adds a parameter to the fits header section writtn for each exposure.
boolean	getBiasExposure(String biasfits) Takes a bias exposure and stores the image in a fits file described by the argument.
boolean	getDarkExposure(String darkfits, double expose) Takes a dark exposure and stores the image in a fits file described by the argument.
boolean	getScienceExposure(String darkfits, double expose) Takes a scientific exposure and stores the image in a fits file described by the argument.
boolean	removeAllFitsKeys() Removes all except the default fits header keys.
boolean	removeFitsKey(String key) Removes a fits header key.
boolean	setFullFrame() Resets any windowing on the ccd.
boolean	setImageGeometry(int xoff, int yoff, int xsize, int ysize, int xbin, int ybin) Sets the CCD-subframe that should be read out.

Methods inherited from interface stella.rmi.ListenerControlling

automatic, external, getStatus, initialize, manual, park, quit, reset, setPassive

Method Detail

getBiasExposure

boolean getBiasExposure(String biasfits)
                        throws RemoteException

Takes a bias exposure and stores the image in a fits file described by the argument. If the argument is null, the data is thrown away, but a bias-exposure is nevertheless taken.
Only allowed in manual mode.

Returns:

True on success.

Throws:

RemoteException

getDarkExposure

boolean getDarkExposure(String darkfits,
                        double expose)
                        throws RemoteException

Takes a dark exposure and stores the image in a fits file described by the argument. If the argument is null, the data is thrown away, but a dark-exposure is nevertheless taken.
Only allowed in manual mode.

Parameters:

darkfits - The file where the fits data is writtn to.

expose - The exposure time in seconds.

Returns:

True on success.

Throws:

RemoteException

getScienceExposure

boolean getScienceExposure(String darkfits,
                           double expose)
                           throws RemoteException

Takes a scientific exposure and stores the image in a fits file described by the argument. If the argument is null, the data is thrown away, but an exposure is nevertheless taken.
Only allowed in manual mode.

Parameters:

fits - The file where the fits data is writtn to.

expose - The exposure time in seconds.

Returns:

True on success.

Throws:

RemoteException

setImageGeometry

boolean setImageGeometry(int xoff,
                         int yoff,
                         int xsize,
                         int ysize,
                         int xbin,
                         int ybin)
                         throws RemoteException

Sets the CCD-subframe that should be read out. The window is valid until either a new window is defined or the window is cleard, see setFullFrame().
Only allowed in manual mode.

Parameters:

xoff - The offset on the CCD in x-direction, in pixel.

yoff - The offset on the CCD in y-direction, in pixel.

xsize - The size of the subframe in x-direction, in pixel.

ysize - The size of the subframe in y-direction, in pixel.

xbin - The binning factor in x-direction.

ybin - The binning factor in y-direction.

Returns:

True on success.

Throws:

RemoteException

setFullFrame

boolean setFullFrame()
                     throws RemoteException

Resets any windowing on the ccd. The next image read otu will be full frame.
Only allowed in manual mode.

Returns:

True on success.

Throws:

RemoteException

abortExposure

boolean abortExposure(String abortfits)
                      throws RemoteException

Abort the exposure currently underway. If a file is given, the data collected until the abortion is stored, otherwise thrown away.
Only allowed in manual mode.

Throws:

RemoteException

addFitsKey

boolean addFitsKey(String key,
                   String parametername,
                   String comment)
                   throws RemoteException

Adds a parameter to the fits header section writtn for each exposure. The setting stays valid until cleared (see removeFitsKey(java.lang.String), removeAllFitsKeys()).
Only allowed in manual mode.

Parameters:

key - The fitskey.

parametername - Name of the parameter whose value should be added.

comment - A comment or the mepty string for no comment.

Throws:

RemoteException

removeFitsKey

boolean removeFitsKey(String key)
                      throws RemoteException

Removes a fits header key. If the key is not found, false is returned.
Only allowed in manual mode.

Throws:

RemoteException

removeAllFitsKeys

boolean removeAllFitsKeys()
                          throws RemoteException

Removes all except the default fits header keys.
Only allowed in manual mode.

Throws:

RemoteException