js.dev.cam.sbig
Class JSbigCam

java.lang.Object
  extended by js.dev.cam.sbig.JSbigCam
All Implemented Interfaces:
JCam

public class JSbigCam
extends java.lang.Object
implements JCam

The JSbigCam class implements all methods defined inside the SBIG Universal Driver Library.

Author:
soldan

Constructor Summary
JSbigCam()
          The JSbigCam constructor which calls the init() method.
 
Method Summary
 ActivateRelayResults activateRelay(ActivateRelayParams arp)
          The activateRelay public method is used to activate one or more of the telescope control outputs or to cancel an activation in progress.
 AoDelayResults aoDelay(AoDelayParams aodp)
          The aoDelay public method is used to generate millisecond type delays for exposing the Tracking CCD.
 AoTipTiltResults aoTipTilt(AoTipTiltParams aottp)
          The aoTipTilt public method is used to position an AO-7 unit attached to the telescope port of an ST-7/8/etc.
 BitIoResults bitIo(BitIoParams biop)
          The bitIo public method is used read or write control bits in the USB cameras.
 CAMERA_TYPE cameraType()
          The cameraType public method returns the camera type field.
 CfwResults cfw(CfwParams cfwp)
          The CFW public method is a high-level API for controlling the SBIG color filter wheels.
 CfwCloseDeviceResults cfwCloseDevice(CfwCloseDeviceParams cfwcdp)
          The cfwCloseDevice method is used to close any OS based communications port associated with this CFW.
 CfwGetFirmwareVersionResults cfwGetFirmwareVersion(CfwGetFirmwareVersionParams cfwgfvp)
          The cfwGetFirmwareVersion returns the version of the CFW firmware.
 CfwGotoResults cfwGoto(CfwGotoParams cfwgp)
          The cfwGoto method is used to start moving the CFW towards a given position.
 CfwInitResults cfwInit(CfwInitParams cfwip)
          The cfwInit method is used to initialize and self-calibrate the CFW.
 CfwOpenDeviceResults cfwOpenDevice(CfwOpenDeviceParams cfwodp)
          The cfwOpenDevice method is used to open any OS based communications port associated with the CFW and should be the first command sent to the CFW.
 CfwQueryResults cfwQuery(CfwQueryParams cfwqp)
          The cfwQuery method is used to monitor the progress of the Goto command.
 CloseResults close(CloseParams cp)
          The close public method is used to close both, the device and driver and should be the last call to the driver.
 CloseDeviceResults closeDevice()
          The closeDevice public method is used to close the low-level driver.
 CloseDriverResults closeDriver()
          The closeDriver public method is used to close the driver and should be the last call to the driver.
 DumpLinesResults dumpLines(DumpLinesParams dlp)
          The dumpLines public method is used to discard all of the active pixels in a row on the CCD.
 EndExposureResults endExposure(EndExposureParams eep)
          The endExposure public method is used after the integration is complete to prepare the CCD for readout or to terminate an exposure prematurely.
 EndReadoutResults endReadout(EndReadoutParams erp)
          The endReadout public method is used after readout of the CCD is complete to prepare the CCD for the idle state.
 EstablishLinkResults establishLink(EstablishLinkParams elp)
          The establishLink public method is used by the application to establish a communication link with the camera.
 GetCcdInfoResults0 getCcdInfo0()
          The getCcdInfo0 public method is used by the application to determine the model of camera being controlled and its capabilities.
 GetCcdInfoResults0 getCcdInfo1()
          The getCcdInfo1 public method is used by the application to determine the model of camera being controlled and its capabilities.
 GetCcdInfoResults2 getCcdInfo2()
          The getCcdInfo2 public method is used by the application to determine the model of camera being controlled and its capabilities.
 GetCcdInfoResults3 getCcdInfo3()
          The getCcdInfo3 public method is used by the application to determine the model of camera being controlled and its capabilities.
 GetCcdInfoResults4 getCcdInfo4()
          The getCcdInfo4 public method is used by the application to determine the model of camera being controlled and its capabilities.
 GetCcdInfoResults4 getCcdInfo5()
          The getCcdInfo5 public method is used by the application to determine the model of camera being controlled and its capabilities.
 GetDriverControlResults getDriverControl(GetDriverControlParams gdcp)
          The getDriverControl public method is used to query the setting of one of the driver control parameters.
 GetDriverInfoResults0 getDriverInfo(GetDriverInfoParams gdip)
          The getDriverInfo public method is used to determine the version and capabilities of the driver/library.
 GetErrorStringResults getErrorString(GetErrorStringParams gesp)
          The getErrorString public method returns the String corresponding to the passed getError number.
 ExposureStartTimeResults getExposureStartTime()
          The getExposureStartTime public method returns the Calendar field.
 GetLinkStatusResults getLinkStatus()
          The getLinkStatus public method returns the status of the communications link established with the camera.
 InitResults init(InitParams ip)
          The init public method initialize the device.
 IsCfwIdleResults isCfwIdle(IsCfwIdleParams cfwip)
          The isCfwIdle public method CfwIdleResults.
 boolean isDeviceOpen()
          The isDeviceOpen public method indicates if the device is open or not.
 IsExposureCompleteResults isExposureComplete(IsExposureCompleteParams iecp)
          The isExposueComplete public methods is used to query the camera to see if the exposure in progress is complete.
 MiscellaneousControlResults miscellaneousControl(MiscellaneousControlParams mcp)
          The miscellaneousControl public method is used to control the Fan, LED, and shutter.
 MfResults motorFocus(MfParams mfp)
          The motorFocus method is a high-level API for controlling the SBIG Motor Focus accessories.
 OpenResults open(OpenParams op)
          The open public method is used to initialize both, the driver and device and should be the first call to the driver.
 OpenDeviceResults openDevice(OpenDeviceParams odep)
          The openDevice public method is used to load and initialize the low-level driver.
 OpenDriverResults openDriver()
          The openDriver public method is used to initialize the driver and should be the first call to the driver.
 QueryActivateRelayStatusResults queryActivateRelayStatus()
          The queryActivateRelayStatus public method is used to monitor the status of the activateRelay command.
 QueryCommandStatusResults queryCommandStatus(QueryCommandStatusParams qcsp)
          The queryCommandStatus public method is used to monitor the progress of a previously requested command.
 QueryMiscellaneousControlResults queryMiscellaneousControl()
          The queryMiscellaneousControl public method is used to get the status of the miscellaneous control command.
 QueryTemperatureStatusResults queryTemperatureStatus()
          The queryTemperatureStatus public method is used to monitor the CCD's temperature regulation.
 QueryUsbResults queryUsb()
          The queryUsb public method is used to query the USB bus and detect up to four cameras.
 ReadOffsetResults readOffset(ReadOffsetParams rop)
          The readOffset public method is used to measure the CCD's offset.
 ReadoutLineResults readoutLine(ReadoutLineParams rlp)
          The readoutLine public method is used to digitize some or all of the active pixels in a row.
 SetDriverControlResults setDriverControl(SetDriverControlParams sdcp)
          The setDriverControl public method is used to modify the behavior of the driver by changing the settings of one of the driver control parameters.
 SetTemperatureRegulationResults setTemperatureRegulation(SetTemperatureRegulationParams strp)
          The setTemperatureRegulation public method is used to enable or disable the CCD's temperature regulation.
 StartExposureResults startExposure(StartExposureParams sep)
          The startExposure public method is used to initialize an exposure.
 StartReadoutResults startReadout(StartReadoutParams srp)
          The startReadout public method is used to inform the driver about the area you intend to readout in subsequent calls to the ReadoutLine method.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JSbigCam

public JSbigCam()
The JSbigCam constructor which calls the init() method.

Method Detail

openDriver

public final OpenDriverResults openDriver()
The openDriver public method is used to initialize the driver and should be the first call to the driver. This method sets driver handle internally by JNI callback's function.

Returns:
odrr OpenDriverResults

closeDriver

public final CloseDriverResults closeDriver()
The closeDriver public method is used to close the driver and should be the last call to the driver. There must be one call to closeDriver for each call to openDriver method.

Returns:
cdrr CloseDriverResults

openDevice

public final OpenDeviceResults openDevice(OpenDeviceParams odep)
The openDevice public method is used to load and initialize the low-level driver. User will typically call this second after openDriver method.

Parameters:
odep - OpenDeviceParams
Returns:
oder OpenDeviceResults

closeDevice

public final CloseDeviceResults closeDevice()
The closeDevice public method is used to close the low-level driver. User will typically call this second to last right before closeDriver method.There must be one call for closeDevice for every call to openDevice method. return cder CloseDeviceResults


getDriverInfo

public final GetDriverInfoResults0 getDriverInfo(GetDriverInfoParams gdip)
The getDriverInfo public method is used to determine the version and capabilities of the driver/library.

Parameters:
gdip - GetDriverInfoParams
Returns:
gdir0 GetDriverInfoResults0

startExposure

public final StartExposureResults startExposure(StartExposureParams sep)
The startExposure public method is used to initialize an exposure. The application specifies the exposure time, etc. and then monitors the exposure's progress with the QueryCommandStatus method. This command stores the start exposure time too. User may use startExposure public methods to retrieve this value.

Parameters:
sep - StartExposureParams.
Returns:
ser StartExposureResults

isExposureComplete

public final IsExposureCompleteResults isExposureComplete(IsExposureCompleteParams iecp)
The isExposueComplete public methods is used to query the camera to see if the exposure in progress is complete. This returns boolean true if the CCD is idle (an exposure was never started) or if the CCD exposure is complete.

Parameters:
iecp - IsExposureCompleteParams
Returns:
iecr IsExposureCompleteResults

endExposure

public final EndExposureResults endExposure(EndExposureParams eep)
The endExposure public method is used after the integration is complete to prepare the CCD for readout or to terminate an exposure prematurely.

Parameters:
eep - EndExposureParams
Returns:
eer EndExposureResults

startReadout

public final StartReadoutResults startReadout(StartReadoutParams srp)
The startReadout public method is used to inform the driver about the area you intend to readout in subsequent calls to the ReadoutLine method. Calling this is optional but suggested and optimizes the readout throughput for small areas on USB and Ethernet based cameras.

Parameters:
srp - StartReadoutParams
Returns:
srr StartReadoutResults

endReadout

public final EndReadoutResults endReadout(EndReadoutParams erp)
The endReadout public method is used after readout of the CCD is complete to prepare the CCD for the idle state.

Parameters:
erp - EndReadoutParams
Returns:
err EndReadoutResults

readoutLine

public final ReadoutLineResults readoutLine(ReadoutLineParams rlp)
The readoutLine public method is used to digitize some or all of the active pixels in a row.

Parameters:
rlp - ReadoutLineParams
Returns:
rlr ReadoutLineResults

dumpLines

public final DumpLinesResults dumpLines(DumpLinesParams dlp)
The dumpLines public method is used to discard all of the active pixels in a row on the CCD.

Parameters:
dlp - DumpLinesParams
Returns:
dlr DumpLineResutls

setTemperatureRegulation

public final SetTemperatureRegulationResults setTemperatureRegulation(SetTemperatureRegulationParams strp)
The setTemperatureRegulation public method is used to enable or disable the CCD's temperature regulation.

Parameters:
strp - SetTemperatureRegulationParams
Returns:
strr SetTemperatureRegulationResults

queryTemperatureStatus

public final QueryTemperatureStatusResults queryTemperatureStatus()
The queryTemperatureStatus public method is used to monitor the CCD's temperature regulation.

Returns:
qtsr QueryTemperatureStatusResults

activateRelay

public final ActivateRelayResults activateRelay(ActivateRelayParams arp)
The activateRelay public method is used to activate one or more of the telescope control outputs or to cancel an activation in progress.

Parameters:
arp - ActivateRelayParams
Returns:
arr ActivateRelayResults

queryActivateRelayStatus

public final QueryActivateRelayStatusResults queryActivateRelayStatus()
The queryActivateRelayStatus public method is used to monitor the status of the activateRelay command.

Returns:
qarsr QueryActivateRelayStatusResults

aoTipTilt

public final AoTipTiltResults aoTipTilt(AoTipTiltParams aottp)
The aoTipTilt public method is used to position an AO-7 unit attached to the telescope port of an ST-7/8/etc.

Parameters:
aottp - AoTipTiltParams
Returns:
aottr AoTipTiltResults

aoDelay

public final AoDelayResults aoDelay(AoDelayParams aodp)
The aoDelay public method is used to generate millisecond type delays for exposing the Tracking CCD.

Parameters:
aodp - AoDelayParams
Returns:
aodr AoDelayResults

establishLink

public final EstablishLinkResults establishLink(EstablishLinkParams elp)
The establishLink public method is used by the application to establish a communication link with the camera. It should be used before any other commands are issued to the camera except the getDriverInfo methods.

Parameters:
elp - EstablishLinkParams
Returns:
elr EstablishLinkResults

getCcdInfo0

public final GetCcdInfoResults0 getCcdInfo0()
The getCcdInfo0 public method is used by the application to determine the model of camera being controlled and its capabilities.

Returns:
gccdir0 GetCcdInfoResults0

getCcdInfo1

public final GetCcdInfoResults0 getCcdInfo1()
The getCcdInfo1 public method is used by the application to determine the model of camera being controlled and its capabilities.

Returns:
gccdir0 GetCcdInfoResults0

getCcdInfo2

public final GetCcdInfoResults2 getCcdInfo2()
The getCcdInfo2 public method is used by the application to determine the model of camera being controlled and its capabilities.

Returns:
gccdir2 GetCcdInfoResults2

getCcdInfo3

public final GetCcdInfoResults3 getCcdInfo3()
The getCcdInfo3 public method is used by the application to determine the model of camera being controlled and its capabilities.

Returns:
gccdir3 GetCcdInfoResults3

getCcdInfo4

public final GetCcdInfoResults4 getCcdInfo4()
The getCcdInfo4 public method is used by the application to determine the model of camera being controlled and its capabilities.

Returns:
gccdir4 GetCcdInfoResults4

getCcdInfo5

public final GetCcdInfoResults4 getCcdInfo5()
The getCcdInfo5 public method is used by the application to determine the model of camera being controlled and its capabilities.

Returns:
gccdir4 GetCcdInfoResults4

queryCommandStatus

public final QueryCommandStatusResults queryCommandStatus(QueryCommandStatusParams qcsp)
The queryCommandStatus public method is used to monitor the progress of a previously requested command.

Parameters:
qcsp - QueryCommandStatusParams
Returns:
qcsr QueryCommandStatusResults

miscellaneousControl

public final MiscellaneousControlResults miscellaneousControl(MiscellaneousControlParams mcp)
The miscellaneousControl public method is used to control the Fan, LED, and shutter. The camera powers up with the Fan on, the LED on solid, and the shutter closed. The driver flashes the LED at the low rate while the Imaging CCD is integrating, flashes the LED at the high rate while the Tracking CCD is integrating and sets it on solid during the readout.

Parameters:
mcp - MiscellaneousControlParams
Returns:
mcr MiscellaneousControlResults

queryMiscellaneousControl

public final QueryMiscellaneousControlResults queryMiscellaneousControl()
The queryMiscellaneousControl public method is used to get the status of the miscellaneous control command.

Returns:
qmcr QueryMiscellaneousControlResults

readOffset

public final ReadOffsetResults readOffset(ReadOffsetParams rop)
The readOffset public method is used to measure the CCD's offset. In the SBIG CCD cameras the offset is adjusted at the factory and this command is for testing or informational purposes only.

Parameters:
rop - ReadOffsetParams
Returns:
ror ReadOffsetResults

getLinkStatus

public final GetLinkStatusResults getLinkStatus()
The getLinkStatus public method returns the status of the communications link established with the camera.

Returns:
glsr GetLinkStatusResults

getErrorString

public final GetErrorStringResults getErrorString(GetErrorStringParams gesp)
The getErrorString public method returns the String corresponding to the passed getError number.

Parameters:
gesp - GetErrorStringParams
Returns:
gesr GetErrorStringResults

queryUsb

public final QueryUsbResults queryUsb()
The queryUsb public method is used to query the USB bus and detect up to four cameras. This allows the user to have multiple USB cameras and for the programmer to connect with specific cameras. To establish a link to a specific camera specify DEV_USB1, 2, 3 or 4 in the device field of he OpenDevice command. If you specify USB_DEV, it opens the next available device. User should call this method after calling OpenDriver but before calling OpenDevice methods.

Returns:
qusbr QueryUsbResults

bitIo

public final BitIoResults bitIo(BitIoParams biop)
The bitIo public method is used read or write control bits in the USB cameras.

Parameters:
biop - BitIoParams
Returns:
bior BitIoResults

setDriverControl

public final SetDriverControlResults setDriverControl(SetDriverControlParams sdcp)
The setDriverControl public method is used to modify the behavior of the driver by changing the settings of one of the driver control parameters. Driver options can be enabled or disabled with this command.

Parameters:
sdcp - SetDriverControlParams
Returns:
sdcr SetDriverControlResults

getDriverControl

public final GetDriverControlResults getDriverControl(GetDriverControlParams gdcp)
The getDriverControl public method is used to query the setting of one of the driver control parameters.

Parameters:
gdcp - GetDriverControlParams
Returns:
gdcr GetDriverControlResults

cfw

public final CfwResults cfw(CfwParams cfwp)
The CFW public method is a high-level API for controlling the SBIG color filter wheels. It supports the CFW-2 ( the position shutter wheel in the ST-5C/237), the CFW-5 (internal color filter wheel for the ST-5/237), the CFW-8, the internal filter wheel (CFW-L) in the ST-L Large Format Camera, the internal filter wheel (CFW-402) in the ST-402 camera, the old 6-position CFW-6A and the new 10-position CFW-10 in both I2C and RS-232 interface modes.

Parameters:
cfwp - CfwParams
Returns:
cfwr CfwResults

cfwOpenDevice

public final CfwOpenDeviceResults cfwOpenDevice(CfwOpenDeviceParams cfwodp)
The cfwOpenDevice method is used to open any OS based communications port associated with the CFW and should be the first command sent to the CFW.

Parameters:
cfwodp - CfwOpenDeviceParams
Returns:
cfwodr CfwOpenDeviceResults

cfwCloseDevice

public final CfwCloseDeviceResults cfwCloseDevice(CfwCloseDeviceParams cfwcdp)
The cfwCloseDevice method is used to close any OS based communications port associated with this CFW.

Parameters:
cfwcdp - CfwCloseDeviceParams
Returns:
cfwcdr CfwCloseDeviceResults

cfwInit

public final CfwInitResults cfwInit(CfwInitParams cfwip)
The cfwInit method is used to initialize and self-calibrate the CFW.

Parameters:
cfwip - CfwInitParams
Returns:
cfwir CfwInitResults

cfwGetFirmwareVersion

public final CfwGetFirmwareVersionResults cfwGetFirmwareVersion(CfwGetFirmwareVersionParams cfwgfvp)
The cfwGetFirmwareVersion returns the version of the CFW firmware.

Parameters:
cfwgfvp - CfwGetFirmwareVersionParams
Returns:
cfwgfvr CfwGetFirmwareVersionResults

cfwGoto

public final CfwGotoResults cfwGoto(CfwGotoParams cfwgp)
The cfwGoto method is used to start moving the CFW towards a given position.

Parameters:
cfwgp - CfwGotoParams
Returns:
cfwgr CfwGotoResults

cfwQuery

public final CfwQueryResults cfwQuery(CfwQueryParams cfwqp)
The cfwQuery method is used to monitor the progress of the Goto command.

Parameters:
cfwqp - CfwQueryParams
Returns:
cfwqr CfwQueryResults

isCfwIdle

public final IsCfwIdleResults isCfwIdle(IsCfwIdleParams cfwip)
The isCfwIdle public method CfwIdleResults.

Parameters:
cfwip - IsCfwIdleParams
Returns:
cfwir IsCfwIdleResults

motorFocus

public final MfResults motorFocus(MfParams mfp)
The motorFocus method is a high-level API for controlling the SBIG Motor Focus accessories. It supports the new ST Motor Focus unit and will be expanded as required to support new models in the future.

Parameters:
mfp - the MfParams to set.
Returns:
MfResults.

isDeviceOpen

public final boolean isDeviceOpen()
The isDeviceOpen public method indicates if the device is open or not.

Returns:
deviceOpenStatus true/false

cameraType

public final CAMERA_TYPE cameraType()
The cameraType public method returns the camera type field.

Returns:
cameraType CAMERA_TYPE

open

public final OpenResults open(OpenParams op)
The open public method is used to initialize both, the driver and device and should be the first call to the driver.

Specified by:
open in interface JCam
Parameters:
op - OpenParams
Returns:
or OpenResults

close

public final CloseResults close(CloseParams cp)
The close public method is used to close both, the device and driver and should be the last call to the driver.

Specified by:
close in interface JCam
Parameters:
cp - CloseParams
Returns:
cr CloseResults

init

public final InitResults init(InitParams ip)
The init public method initialize the device.

Specified by:
init in interface JCam
Parameters:
ip - InitParams object.
Returns:
InitResults object.

getExposureStartTime

public final ExposureStartTimeResults getExposureStartTime()
The getExposureStartTime public method returns the Calendar field.

Specified by:
getExposureStartTime in interface JCam
Returns:
exposureStartTime ExposureStartTimeResults