Package gda.images.camera

Interface Camera

All Superinterfaces:

Configurable, Device, Findable, ImageScaleProvider, gda.observable.IObservable

All Known Implementing Classes:

CameraBase, DummyOpticalCamera, MxOpticalCamera, MxOpticalCameraBase, MxOpticalCameraNoZoom, MxOpticalCameraZoomPositioner

public interface Camera
extends Device, ImageScaleProvider

Interface for sample viewing camera objects. These control the focus and zoom settings of a camera's optics and capture individual images.

They also contain scaling factors to convert between pixels and microns for calculations relating to sample control. The gda.images package assumes that the camera is on-axis looking at the sample which is held on an XYZ stage.

These objects are not for creating/displaying a stream of images

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FOCUS_SET	Message sent when focus changed in camera
static final String	IMAGE_UPDATED	Message sent when image updated from camera
static final String	ZOOM_SET	Message sent when zoom changed in camera

Method Summary

Modifier and Type	Method	Description
void	captureImage(String filename)	Writes the current image to disk.
String	getCameraName()
double	getFocus()
double[]	getFocusLevels()
BufferedImage	getImage()	Captures and returns an image.
String	getImageFileName()	get the name of the file that image is written to
double	getZoom()
int	getZoomIndex()
double[]	getZoomLevels()
void	selectZoomAt(int targetIndex)	Sets the zoom level via an index, based on array values (see getZoomLevels()):
void	setFocus(double focus)	Sets the focus level.
void	setZoom(double zoom)	Sets the zoom level.

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.images.camera.ImageScaleProvider

getMicronsPerXPixel, getMicronsPerYPixel

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Field Details

IMAGE_UPDATED

static final String IMAGE_UPDATED

Message sent when image updated from camera

See Also:

• Constant Field Values

ZOOM_SET

static final String ZOOM_SET

Message sent when zoom changed in camera

See Also:

• Constant Field Values

FOCUS_SET

static final String FOCUS_SET

Message sent when focus changed in camera

See Also:

• Constant Field Values

Method Details

getImageFileName

String getImageFileName()
                 throws DeviceException

get the name of the file that image is written to

Returns:

string - filename

Throws:

DeviceException

getCameraName

String getCameraName()
              throws DeviceException

Returns:

string - name of the camera

Throws:

DeviceException

getFocus

double getFocus()
         throws DeviceException

Returns:

double - current focus level

Throws:

DeviceException

getZoom

double getZoom()
        throws DeviceException

Returns:

double - current zoom level

Throws:

DeviceException

setZoom

void setZoom(double zoom)
      throws DeviceException

Sets the zoom level. Number must be a member of the list returned by getZoomLevels().

Parameters:

zoom -

Throws:

DeviceException

selectZoomAt

void selectZoomAt(int targetIndex)
           throws DeviceException

Sets the zoom level via an index, based on array values (see getZoomLevels()):

Parameters:

targetIndex - array index of new zoom level, ignored if out of range

Throws:

DeviceException

getZoomIndex

int getZoomIndex()

Returns:

the zoom index of the present zoom setting, else -1 if no zoom level is set, or no levels are present

setFocus

void setFocus(double focus)
       throws DeviceException

Sets the focus level. Number must be a member of the list returned by getFcouslevels.

Parameters:

focus -

Throws:

DeviceException

captureImage

void captureImage(String filename)
           throws DeviceException

Writes the current image to disk.

Filename should be the full path of the file to create. If it is null then the file listed in the configuration file will be overwritten.

Parameters:

filename -

Throws:

DeviceException

getImage

BufferedImage getImage()
                throws DeviceException

Captures and returns an image.

Throws:

DeviceException

getZoomLevels

double[] getZoomLevels()
                throws DeviceException

Returns:

double[] - the possible zoom levels

Throws:

DeviceException

getFocusLevels

double[] getFocusLevels()
                 throws DeviceException

Returns:

double[] - the possible focus levels

Throws:

DeviceException