com.bruxton.sidx
Class Camera

java.lang.Object
  com.bruxton.sidx.Camera

public class Camera
extends java.lang.Object

Represent an open camera. Each instance of SIDX can own multiple instances of the class. The user of SIDX should not create the objects of this class. It should be obtained by using openCamera/configureCamera functions of SIDX object.

Method Summary

void	close() Shutdown the communication with the camera.
Acquisition	getAcquisition() Obtain the Acquisition object.
Dialogs	getDialogs() Obtain the Dialogs object.
ExposureTime	getExposureTime() Return the ExposureTime object.
double	getFrameRate() The function returns the frame rate (frames/seconds) of the last completed acquisition.
Gains	getGains() Get a Gains object.
ImageGeometry	getImageGeometry() Obtain the ImageGeometry object.
Modes	getModes() Get a Modes object.
java.lang.String	getName() The function returns the name of the current open camera.
java.lang.String	getService() The function returns the current state of the camera for support use.
double	getServiceInterval() The function returns the current service interval (in seconds) used.
java.lang.String	getSetting(java.lang.String tag) Obtain the setting of a particular parameter specified by "tag".
java.lang.String	getSettings() Obtain the current camera settings.
Shutter	getShutter() Obtain the Shutter object.
Temperature	getTemperature() Obtain the Temperature object.
int	getTimeToGetFirstImage() The function returns the time (in milliseconds) that the camera takes from the start of the acquisition till the first image is retrieved.
int	getTimeToGetReady() The function returns the time (in milliseconds) that the camera takes to prepare for the acquisition.
Trigger	getTrigger() Obtain the Trigger object.
boolean	isVendor(int vendor) The function returns whether the camera object is for controling the cameras from a particular vendor.
void	saveDefaultSettings() Save the current camera settings into a file called "default.sidx" in the file system directory that servies as a common repository for the application-specific data.
void	setServiceInterval(double interval) The function changes the service interval (in seconds) that SIDX requires from the application.
void	setSetting(java.lang.String tag, java.lang.String setting) Set a particular parameter specified by "tag".

Methods inherited from class java.lang.Object

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

Method Detail

getAcquisition

public Acquisition getAcquisition()

Obtain the Acquisition object.

Returns:

the Acquisition object that is associated with the camera object. Each Camera object can only have one Acquisition object.

getDialogs

public Dialogs getDialogs()

Obtain the Dialogs object.

Returns:

the Dialogs object that is associated with the camera object. Each Camera object can only have one Dialogs object.

getImageGeometry

public ImageGeometry getImageGeometry()

Obtain the ImageGeometry object.

Returns:

the ImageGeometry object that is associated with the camera object. Each Camera object can only have one ImageGeometry object.

getTemperature

public Temperature getTemperature()

Obtain the Temperature object.

Returns:

the Temperature object that is associated with the camera object. Each Camera object can only have one Temperature object.

close

public void close()

Shutdown the communication with the camera.

Throws:

Exception

getShutter

public Shutter getShutter()
                   throws Exception

Obtain the Shutter object.

Returns:

the Shutter object that is associated with the camera object. Each Camera object can only have one Shutter object.

Throws:

Exception

getTrigger

public Trigger getTrigger()
                   throws Exception

Obtain the Trigger object.

Returns:

the Trigger object that is associated with the camera object. Each Camera object can only have one Trigger object.

Throws:

Exception

getSettings

public java.lang.String getSettings()
                             throws Exception

Obtain the current camera settings.

Returns:

the current camera settings.

Throws:

Exception

setSetting

public void setSetting(java.lang.String tag,
                       java.lang.String setting)
                throws Exception

Set a particular parameter specified by "tag".

Parameters:

tag - the tag value for the parameter to be changed. The supported parameters that can be set through the call by the camera are:

Andor Technology cameras

Cooke/PCO dot camera cameras

Cooke/PCO Sensicam cameras

DVC cameras

Hamamatsu cameras

Photometrics/Princeton Instruments cameras

QImaging cameras

SciMeasure/RedShirtImaging LLC cameras

Spectral Instruments cameras

setting - the new setting for the parameter.

Throws:

Exception

getSetting

public java.lang.String getSetting(java.lang.String tag)
                            throws Exception

Obtain the setting of a particular parameter specified by "tag".

Parameters:

tag - the tag of the parameter which setting is to be returned. The supported parameters that can be retrieved through the call by camera types are:

Andor Technology cameras

Cooke/PCO dot camera cameras

Cooke/PCO Sensicam cameras

DVC cameras

Hamamatsu cameras

Photometrics/Princeton Instruments cameras

QImaging cameras

SciMeasure/RedShirtImaging LLC cameras

Spectral Instruments cameras

Returns:

the setting of the parameter with "tag".

Throws:

Exception

getExposureTime

public ExposureTime getExposureTime()
                             throws Exception

Return the ExposureTime object.

Returns:

the ExposureTime object that is associated with the camera object. Each Camera object can only have one ExposureTime object.

Throws:

Exception

getGains

public Gains getGains()
               throws Exception

Get a Gains object.

Returns:

a Gains object that is associated with the camera object. Each Camera object can only have one Gains object.

Throws:

Exception

getModes

public Modes getModes()
               throws Exception

Get a Modes object.

Returns:

a Modes object that is associated with the camera object. Each Camera object can only have one Modes object.

Throws:

Exception

saveDefaultSettings

public void saveDefaultSettings()
                         throws Exception

Save the current camera settings into a file called "default.sidx" in the file system directory that servies as a common repository for the application-specific data. A typical path under Windows is c:\\Documents and Settings\\username\\Application Data.

Throws:

Exception

getTimeToGetReady

public int getTimeToGetReady()
                      throws Exception

The function returns the time (in milliseconds) that the camera takes to prepare for the acquisition. The function will generate an error if the call is made while SIDX is trying to gather the timing information.

Returns:

the time in milliseconds that the camera takes to prepare for the acquisition.

Throws:

Exception

getTimeToGetFirstImage

public int getTimeToGetFirstImage()
                           throws Exception

The function returns the time (in milliseconds) that the camera takes from the start of the acquisition till the first image is retrieved. It will generate an error if the call is made while SIDX is trying to gather the timing information.

Returns:

the time (in milliseconds) that the camera takes from the start of the acquisition till the first image is retrieved.

Throws:

Exception

getFrameRate

public double getFrameRate()
                    throws Exception

The function returns the frame rate (frames/seconds) of the last completed acquisition. The function will generate an error if the function is called while SIDX is trying to gather the timing information.

Returns:

the frame rate (frames/second) of the last completed acquisition.

Throws:

Exception

isVendor

public boolean isVendor(int vendor)
                 throws Exception

The function returns whether the camera object is for controling the cameras from a particular vendor.

Parameters:

vendor - specify the vendor ID. The supported vendors are:

Vendor ID	Vendor name
0	Andor Technology
1	Bruxton Corporation Demonstration
2	Cooke/PCO Sensicam
3	DVC Company
4	Hamamatsu
5	QImaging
6	Photometrics
7	SciMeasure
8	Spectral Instruments
9	Cooke/PCO Dot camera
10	Digital camcorder

Returns:

true if the camera object is for controling the specified vendor cameras.

Throws:

Exception

getName

public java.lang.String getName()
                         throws Exception

The function returns the name of the current open camera.

Returns:

the name of the current open camera.

Throws:

Exception

getService

public java.lang.String getService()
                            throws Exception

The function returns the current state of the camera for support use.

Returns:

the current settings of the camera.

Throws:

Exception

setServiceInterval

public void setServiceInterval(double interval)
                        throws Exception

The function changes the service interval (in seconds) that SIDX requires from the application. That is, during the acquisition, the application will have to service SIDX within the service interval. Otherwise there will be missing frames or acquisition buffer overrun.

Parameters:

interval - the service interval in seconds to set.

Throws:

Exception

getServiceInterval

public double getServiceInterval()
                          throws Exception

The function returns the current service interval (in seconds) used. The service interval is the time within which the application will have to service SIDX. Otherwise there may be missing frames or acquisition buffer overrun.

Returns:

the current service interval setting in seconds.

Throws:

Exception