|
HermesReturn | HermesGetDeadTime (Hermes_H Hermes, UInt16 Val, UInt16 *ReturnVal) |
|
HermesReturn | HermesGetGateWidth (Hermes_H Hermes, UInt16 counter, Int16 Val, double *ReturnVal) |
|
HermesReturn | HermesGetGateShift (Hermes_H Hermes, UInt16 counter, Int16 Val, Int16 *ReturnVal) |
|
HermesReturn | HermesIs16Bit (Hermes_H Hermes, short *is16bit) |
|
HermesReturn | HermesIsTriggered (Hermes_H Hermes, short *isTriggered) |
|
HermesReturn | HermesGetVersion (Hermes_H Hermes, double *Firmware_Version, double *Software_Version, char *Custom_version) |
|
HermesReturn | HermesGetSerial (Hermes_H Hermes, char *Camera_ID, char *Camera_serial) |
|
HermesReturn | HermesDeviceInfo (char *Device_ID, char *Camera_serial, double *Firmware_Version, double *Software_Version, char *Firmware_Custom_Version, char *Software_Custom_Version) |
|
Functions to get status or settings from Hermes camera.
◆ HermesDeviceInfo()
HermesReturn HermesDeviceInfo |
( |
char * |
Device_ID, |
|
|
char * |
Camera_serial, |
|
|
double * |
Firmware_Version, |
|
|
double * |
Software_Version, |
|
|
char * |
Firmware_Custom_Version, |
|
|
char * |
Software_Custom_Version |
|
) |
| |
Get device info.
It gets device serial number, Unique ID, version and SDK version, without constructing an Hermes object. Useful when constructor fails due to incompatible firmware and SDK versions or for powering issues.
- Parameters
-
Device_ID | Hermes camera Unique ID. A string of at least 11 character is required as parameter. If multiple devices are connected to the computer, a unique camera ID should be provided to correctly identify the camera. The camera ID can be found in the camera documentation. An empty string is accepted too. In this case, the first available device will be connected and the function with write in this variable the camera ID. This parameter is referenced. |
Camera_serial | Hermes camera serial number. A string of at least 33 character is required as parameter. This parameter is referenced. |
Firmware_Version | Version of the camera firmare in the format x.xx. This parameter is referenced. |
Software_Version | Version of the SDK in the format x.xx. This parameter is referenced. |
Firmware_Custom_Version | Customization version of the firmware. For standard model "A" is returned. This parameter is referenced. |
Software_Custom_Version | Customization version of the software. For standard model "A" is returned. This parameter is referenced. |
- Returns
- OK
◆ HermesGetDeadTime()
Get the calibrated dead-time value.
This function provides the closest calibrated dead-time value to Val.
- Parameters
-
Hermes | Hermes handle |
Val | Desired dead-time value in ns. No error is generated when the value is above MAX_DEAD_TIME. |
ReturnVal | Closest dead-time value possible. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided Hermes_H or ReturnVal point to an empty memory location
- See also
- HermesSetDeadTime()
- Examples
- SDK_Example.c.
◆ HermesGetGateShift()
Get the calibrated gate shift value.
This function provides the closest calibrated gate shift value to Val.
- Parameters
-
Hermes | Hermes handle |
counter | Counter for which the gate shift is requested. Accepted values: 1..3 |
Val | Desired gate shift value in thousandths of 20ns. No error is generated when the value out of range, instead the real boundaries are forced on ReturnVal. |
ReturnVal | Closest gate-shift value possible. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided Hermes_H or ReturnVal point to an empty memory location
◆ HermesGetGateWidth()
Get the calibrated gate width value.
This function provides the closest calibrated gate-width value to Val.
- Parameters
-
Hermes | Hermes handle |
counter | Counter for which the gate width is requested. Accepted values: 1..3 |
Val | Desired gate-width value in percentage of 20ns. No error is generated when the value is out of range, instead the real boundaries are forced on ReturnVal. |
ReturnVal | Closest gate-width value possible. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided Hermes_H or ReturnVal point to an empty memory location
◆ HermesGetSerial()
Get the camera serial number and ID.
- Parameters
-
Hermes | Hermes handle |
Camera_ID | Unique camera ID. A string of at least 11 character is required as parameter. This parameter is referenced. |
Camera_serial | Hermes camera serial number. A string of at least 33 character is required as parameter. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided provided handle or pointers point to an empty memory location.
◆ HermesGetVersion()
HermesReturn HermesGetVersion |
( |
Hermes_H |
Hermes, |
|
|
double * |
Firmware_Version, |
|
|
double * |
Software_Version, |
|
|
char * |
Custom_version |
|
) |
| |
Get the SDK and camera firmware version.
- Parameters
-
Hermes | Hermes handle |
Firmware_Version | Version of the camera firmare in the format x.xx. This parameter is referenced. |
Software_Version | Version of the SDK in the format x.xx. This parameter is referenced. |
Custom_version | Customization version of the firmware and SDK. For standard model "A" is returned. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided handle or pointers point to an empty memory location
◆ HermesIs16Bit()
Get the actual bit depth of acquired data.
Data from the camera will be 16-bit per pixel, if NFramesInteg > 1, or DTC is enabled, or background subtraction is enabled, or 8-bit per pixel otherwise. This function provides actual bit depth with the current settings.
- Parameters
-
Hermes | Hermes handle |
is16bit | Actual status. The value is 0 if bit depth is 8-bit and 1 if bit depth is 16-bit. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided Hermes_H or is16bit pointers point to an empty memory location
◆ HermesIsTriggered()
Poll the camera for external trigger status.
Poll the camera in order to know if an external sync pulse was detected. The result is meaningful only if the camera was previously set to wait for an external sync.
- Parameters
-
Hermes | Hermes handle |
isTriggered | Actual status. The value is 0 if no sync pulse was detected so far, 1 otherwise. This parameter is referenced. |
- Returns
- OK
-
NULL_POINTER The provided Hermes_H or is Triggered pointers point to an empty memory location
- Examples
- SDK_Example.c.