|
FireSync API
|
Class cal for the kLdCal class.
Public Member Functions | |
| kStatus | kLdCal_BackupFileName (kSize index, kChar *fileName, kSize capacity) |
| Generates the backup calibration file name based on the index of the laser driver. More... | |
| kStatus | kLdCal_Construct (kLdCal *cal, kAlloc alloc) |
| Constructs a kLdCal cal. More... | |
| kLightDiodeModel | kLdCal_DiodeModel (kLdCal cal) |
| Queries diode model. More... | |
| kSize | kLdCal_DriverId (kLdCal cal) |
| Gets the driver serial number. More... | |
| const kChar * | kLdCal_DriverIdLabel (kLdCal cal) |
| Gets the formatted driver serial number. More... | |
| kSize | kLdCal_DriverIndex (kLdCal cal) |
| Gets the light driver index. More... | |
| kLightModel | kLdCal_DriverModel (kLdCal cal) |
| Queries driver model. More... | |
| k64f | kLdCal_DriverTemperature (kLdCal cal) |
| Gets the driver temperature. More... | |
| kVersion | kLdCal_DriverVersion (kLdCal cal) |
| Gets the driver version. More... | |
| kStatus | kLdCal_FileName (kSize index, kChar *fileName, kSize capacity) |
| Generates the default calibration file name based on the index of the laser driver. More... | |
| kSize | kLdCal_LimitInputDefault (kLdCal cal) |
| Gets the current limit input (in device units) to be used at device startup. More... | |
| kSize | kLdCal_LimitInputDevice (kLdCal cal) |
| Gets the current limit input (in device units) programmed to the laser driver. More... | |
| kStatus | kLdCal_LimitInputInfo (kLdCal cal, kSize *begin, kSize *step) |
| Queries the range of the input values for the current limit to the optical power map specified via kLdCal_SetLimitOutput. More... | |
| kArray1 | kLdCal_LimitOutput (kLdCal cal) |
| Gets the calibration mapping for driver set point. More... | |
| kStatus | kLdCal_Load (kLdCal *cal, const kChar *path, kAlloc alloc) |
| Loads the calibration record from local storage. More... | |
| kStatus | kLdCal_LoadStream (kLdCal *cal, kStream stream, kAlloc alloc) |
| Loads the calibration record from a stream. More... | |
| kSize | kLdCal_PowerInputDefault (kLdCal cal) |
| Gets the power set point input (in device units) to be used at device startup. More... | |
| kSize | kLdCal_PowerInputDevice (kLdCal cal) |
| Gets the power set point input (in device units) programmed to the laser driver. More... | |
| kStatus | kLdCal_PowerInputInfo (kLdCal cal, kSize *begin, kSize *step) |
| Queries the range of the input values for the set point to the optical power map specified via kLdCal_SetPowerOutput. More... | |
| kArray1 | kLdCal_PowerOutput (kLdCal cal) |
| Gets the calibration mapping for driver set point. More... | |
| kStatus | kLdCal_Save (kLdCal cal, const kChar *path) |
| Saves the calibration record to local storage under the specified path. More... | |
| kStatus | kLdCal_SaveStream (kLdCal cal, kStream stream) |
| Saves the calibration record to a stream. More... | |
| kSize | kLdCal_SensorId (kLdCal cal) |
| Gets the serial number. More... | |
| kStatus | kLdCal_SetDiodeModel (kLdCal cal, kLightDiodeModel model) |
| Sets the diode model. More... | |
| kStatus | kLdCal_SetDriverId (kLdCal cal, kSize driverId) |
| Sets the driver serial number. More... | |
| kStatus | kLdCal_SetDriverIdLabel (kLdCal cal, const kChar *label) |
| Sets the formatted laser driver id. More... | |
| kStatus | kLdCal_SetDriverIndex (kLdCal cal, kSize index) |
| Sets the light driver index. More... | |
| kStatus | kLdCal_SetDriverModel (kLdCal cal, kLightModel model) |
| Sets the driver model. More... | |
| kStatus | kLdCal_SetDriverTemperature (kLdCal cal, k64f temperature) |
| Sets the driver temperature (degrees Celsius). More... | |
| kStatus | kLdCal_SetDriverVersion (kLdCal cal, kVersion version) |
| Sets the driver version. More... | |
| kStatus | kLdCal_SetLimitInputDefault (kLdCal cal, kSize input) |
| Sets the current limit input (in device units) to be used at device startup. More... | |
| kStatus | kLdCal_SetLimitInputDevice (kLdCal cal, kSize input) |
| Sets the current limit input (in device units) programmed to the laser driver. More... | |
| kStatus | kLdCal_SetLimitInputInfo (kLdCal cal, kSize begin, kSize step) |
| Defines the range of the input values for the current limit to optical power map specified via kLdCal_SetLimitOutput. More... | |
| kStatus | kLdCal_SetLimitOutput (kLdCal cal, kArray1 limitMap) |
| Sets the calibration mapping for the driver current limit. More... | |
| kStatus | kLdCal_SetPowerInputDefault (kLdCal cal, kSize input) |
| Sets the power set point input (in device units) to be used at device startup. More... | |
| kStatus | kLdCal_SetPowerInputDevice (kLdCal cal, kSize input) |
| Sets the power set point input (in device units) programmed to the laser driver. More... | |
| kStatus | kLdCal_SetPowerInputInfo (kLdCal cal, kSize begin, kSize step) |
| Defines the range of the input values for the set point to optical power map specified via kLdCal_SetPowerOutput. More... | |
| kStatus | kLdCal_SetPowerOutput (kLdCal cal, kArray1 powerMap) |
| Sets the calibration mapping for the driver power set point. More... | |
| kStatus | kLdCal_SetSensorId (kLdCal cal, kSize sensorId) |
| Sets the sensor serial number. More... | |
| kStatus | kLdCal_SetStationId (kLdCal cal, const kChar *stationId) |
| Sets the calibration station Id (e.g. More... | |
| kStatus | kLdCal_SetTimestamp (kLdCal cal, const kChar *timestamp) |
| Sets the calibration timestamp. More... | |
| const kChar * | kLdCal_StationId (kLdCal cal) |
| Gets the calibration station Id. More... | |
| const kChar * | kLdCal_Timestamp (kLdCal cal) |
| Gets the calibration timestamp. More... | |
| kLightModel | kLdModel_LightModel (kLdModel model) |
| Returns the light model enumerator corresponding to this object. More... | |
| kBool | kLdModel_LimitCompensated (kLdModel model) |
| Specifies whether power current limit requires active temperature compensation. More... | |
| kStatus | kLdModel_LimitCompensationCoeff (kLdModel model, k64f *coeff) |
| Returns the temperature compensation coefficient needed for accurate power current limit compensation at runtime. More... | |
| kBool | kLdModel_LimitEnabled (kLdModel model) |
| Specifies if power current limit is configurable for the queried laser driver model. More... | |
| kStatus | kLdModel_Load (kLdModel *model, const kChar *path, kAlloc alloc) |
| Loads the model object from local storage at the specified path. More... | |
| kStatus | kLdModel_LoadStream (kLdModel *model, kStream stream, kAlloc alloc) |
| Loads the model object from a stream. More... | |
| kStatus | kLdModel_OutputRange (kLdModel model, k64f *outputMin, k64f *outputMax) |
| Specifies maximum optical power range (in mW), which is safely configurable for this laser driver. More... | |
| kBool | kLdModel_PowerCompensated (kLdModel model) |
| Specifies whether power set point requires active temperature compensation. More... | |
| kStatus | kLdModel_PowerCompensationCoeff (kLdModel model, k64f *coeff) |
| Returns the temperature compensation coefficient needed for accurate power set point compensation at runtime. More... | |
| kBool | kLdModel_PowerEnabled (kLdModel model) |
| Specifies whether power set point is configurable for the queried laser driver model. More... | |
| k32u | kLdModel_PrimeCount (kLdModel model) |
| Reports the number of priming exposures that should be run at acquisition startup. More... | |
| k64u | kLdModel_PrimeExposure (kLdModel model) |
| Reports the amount of time required for one light priming exposure. More... | |
| kStatus | kLdModel_TempRange (kLdModel model, k64f *tempMin, k64f *tempMax) |
| Specifies maximum operating temperature range of the driver, in degrees C. More... | |
| kLdModelTempReference | kLdModel_TempReference (kLdModel model) |
| Specifies the temperature reference probe, which (if available) must be used to determine if the laser driver temperature probe is functioning correctly. More... | |
| k64f | kLdModel_TempReferenceTolerance (kLdModel model) |
| Specifies the maximum allowable deviation, in degrees C, between the driver temperature and the reference probe (queried via kLdModel_TempReference) Should the limit be exeeded, the light probe should be considered damaged. More... | |
