Package uk.ac.gda.api.camera

Interface CameraControl

All Superinterfaces:

Findable, gda.observable.IObservable

All Known Implementing Classes:

CameraControlForLiveStream, EigerOdinCameraControl, EpicsCameraControl, ExcaliburOdinCameraControl

public interface CameraControl
extends Findable, gda.observable.IObservable

An interface allowing access to basic camera operations

It was originally written to allow clients to control camera functions without having to export large objects such as area detectors over RMI.

Method Summary

Modifier and Type	Method	Description
void	clearRoi()
void	disableProcessingFilter()	Disables the processing filter
void	enableProcessingFilter()	Enables the processing filter
CameraState	getAcquireState()	Get the camera acquire state
double	getAcquireTime()	Get acquire (exposure) time
BinningFormat	getBinningPixels()	Return binning format of the camera e.g 1x1
int[]	getFrameSize()
ImageMode	getImageMode()	Gets the ImageMode of the camera
int	getImageSizeX()	Gets the X dimension of image
int	getImageSizeY()	Gets the Y dimension of image
int	getNumImages()	Gets the number of images
int	getOverlayCentreX()	Gets the X-coordinate of the overlay
int	getOverlayCentreY()	Gets the Y-coordinate of the overlay
int[]	getRoi()
short	getTriggerMode()	Gets the camera trigger mode
void	resetFilter()	Resets the filter
void	setAcquireTime(double acquiretime)	Set acquire (exposure) time
void	setBinningPixels(BinningFormat binningFormat)	The amount of
void	setImageMode(ImageMode imageMode)	Sets the ImageMode of the camera
void	setNumImages(int numImages)	Sets the number of images
void	setProcessingFilterType(int filterType)	Selects the type of recursive filter to be used by the processing plugin
void	setRoi(int left, int top, int width, int height)
void	setTriggerMode(short triggerMode)	Sets the camera trigger mode
void	startAcquiring()	Start acquiring data
void	stopAcquiring()	Stop acquiring data

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Method Details

getAcquireTime

double getAcquireTime()
               throws DeviceException

Get acquire (exposure) time

Returns:

Acquire time in seconds

Throws:

DeviceException

setAcquireTime

void setAcquireTime(double acquiretime)
             throws DeviceException

Set acquire (exposure) time

Parameters:

acquiretime - in seconds

Throws:

DeviceException

startAcquiring

void startAcquiring()
             throws DeviceException

Start acquiring data

Throws:

DeviceException

stopAcquiring

void stopAcquiring()
            throws DeviceException

Stop acquiring data

Throws:

DeviceException

getAcquireState

CameraState getAcquireState()
                     throws DeviceException

Get the camera acquire state

Returns:

acquire state

Throws:

DeviceException

getBinningPixels

BinningFormat getBinningPixels()
                        throws DeviceException

Return binning format of the camera e.g 1x1

Returns:

binning format

Throws:

DeviceException

setBinningPixels

void setBinningPixels(BinningFormat binningFormat)
               throws DeviceException

The amount of

Parameters:

binningFormat -

Throws:

DeviceException

getFrameSize

int[] getFrameSize()
            throws DeviceException

Returns:

frame size

Throws:

DeviceException

getRoi

int[] getRoi()
      throws DeviceException

Returns:

array of left, top, width, height

Throws:

DeviceException

setRoi

void setRoi(int left,
 int top,
 int width,
 int height)
     throws DeviceException

Parameters:

left -

top -

width -

height -

Throws:

DeviceException

clearRoi

void clearRoi()
       throws DeviceException

Throws:

DeviceException

getOverlayCentreX

int getOverlayCentreX()
               throws DeviceException

Gets the X-coordinate of the overlay

Returns:

The X-coordinate of the overlay

Throws:

DeviceException

getOverlayCentreY

int getOverlayCentreY()
               throws DeviceException

Gets the Y-coordinate of the overlay

Returns:

The Y-coordinate of the overlay

Throws:

DeviceException

setImageMode

void setImageMode(ImageMode imageMode)
           throws Exception

Sets the ImageMode of the camera

Parameters:

imageMode -

Throws:

Exception

getImageMode

ImageMode getImageMode()
                throws Exception

Gets the ImageMode of the camera

Throws:

Exception

setTriggerMode

void setTriggerMode(short triggerMode)
             throws Exception

Sets the camera trigger mode

Parameters:

triggerMode - the camera specific trigger mode value

Throws:

Exception

getTriggerMode

short getTriggerMode()
              throws Exception

Gets the camera trigger mode

Throws:

Exception

enableProcessingFilter

void enableProcessingFilter()
                     throws Exception

Enables the processing filter

Throws:

Exception

disableProcessingFilter

void disableProcessingFilter()
                      throws Exception

Disables the processing filter

Throws:

Exception

setProcessingFilterType

void setProcessingFilterType(int filterType)
                      throws Exception

Selects the type of recursive filter to be used by the processing plugin

Throws:

Exception

resetFilter

void resetFilter()
          throws Exception

Resets the filter

Throws:

Exception

getImageSizeX

int getImageSizeX()
           throws DeviceException

Gets the X dimension of image

Throws:

DeviceException

getImageSizeY

int getImageSizeY()
           throws DeviceException

Gets the Y dimension of image

Throws:

DeviceException

setNumImages

void setNumImages(int numImages)
           throws Exception

Sets the number of images

Throws:

Exception

getNumImages

int getNumImages()
          throws Exception

Gets the number of images

Throws:

Exception