Package gda.images.camera

Class CameraBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.images.camera.CameraBase

All Implemented Interfaces:

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

Direct Known Subclasses:

DummyOpticalCamera, MxOpticalCameraBase

public abstract class CameraBase
extends DeviceBase
implements Camera

Base class for object implementing the Camera interface

Field Summary

Fields

Modifier and Type	Field	Description
protected String	cameraName
protected int	cameraZoomIndexStatus
protected String	imageFile
static final int	UNSET_ARRAY_INDEX

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.images.camera.Camera

FOCUS_SET, IMAGE_UPDATED, ZOOM_SET

Constructor Summary

Constructors

Constructor	Description
CameraBase()

Method Summary

Modifier and Type	Method	Description
protected static boolean	areSimilar(double x, double reference, double tol)	Checks a value against a reference value, indicating if they are similar to within a plus/minus tolerance
String	getCameraName()
String	getImageFileName()	get the name of the file that image is written to
final int	getZoomIndex()
protected abstract double	getZoomSimilarityTolerance()
void	selectZoomAt(int targetIndex)	Sets the zoom level via an index, based on array values (see Camera.getZoomLevels()):
void	setImageFile(String imageFile)
final void	setZoom(double zoom)	Sets the zoom level.
protected final void	setZoomIndex(int index)
protected abstract void	updateCameraToIndexedSettings(int verifiedIndex)	Invoked (indirectly) by setZoom(double) for indexed zoom levels,

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.images.camera.Camera

captureImage, getFocus, getFocusLevels, getImage, getZoom, getZoomLevels, setFocus

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

UNSET_ARRAY_INDEX

public static final int UNSET_ARRAY_INDEX

See Also:

• Constant Field Values

cameraZoomIndexStatus

protected int cameraZoomIndexStatus

cameraName

protected String cameraName

imageFile

protected String imageFile

Constructor Details

CameraBase

public CameraBase()

Method Details

updateCameraToIndexedSettings

protected abstract void updateCameraToIndexedSettings(int verifiedIndex)
                                               throws DeviceException

Invoked (indirectly) by setZoom(double) for indexed zoom levels,

Parameters:

verifiedIndex - settings index; already verified to lie within range

Throws:

DeviceException

getImageFileName

public String getImageFileName()
                        throws DeviceException

Description copied from interface: Camera

get the name of the file that image is written to

Specified by:

getImageFileName in interface Camera

Returns:

string - filename

Throws:

DeviceException

setImageFile

public void setImageFile(String imageFile)

getCameraName

public String getCameraName()
                     throws DeviceException

Specified by:

getCameraName in interface Camera

Returns:

string - name of the camera

Throws:

DeviceException

selectZoomAt

public void selectZoomAt(int targetIndex)
                  throws DeviceException

Description copied from interface: Camera

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

Specified by:

selectZoomAt in interface Camera

Parameters:

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

Throws:

DeviceException

getZoomIndex

public final int getZoomIndex()

Specified by:

getZoomIndex in interface Camera

Returns:

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

setZoomIndex

protected final void setZoomIndex(int index)

getZoomSimilarityTolerance

protected abstract double getZoomSimilarityTolerance()

setZoom

public final void setZoom(double zoom)
                   throws DeviceException

Description copied from interface: Camera

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

Specified by:

setZoom in interface Camera

Parameters:

zoom -

Throws:

DeviceException

areSimilar

protected static boolean areSimilar(double x,
 double reference,
 double tol)

Checks a value against a reference value, indicating if they are similar to within a plus/minus tolerance

Parameters:

x - a value to check for similarity

reference - the expected value

tol - the tolerance

Returns:

true iff |x - ref| invalid input: '<' |tol|