OceanDirectLighthouse  3.1.1
OceanDirect Lighthouse C++/C API
LHAutoNullingAPI.h
1 /*****************************************************
2  * @file LHAutoNullingAPI.h
3  * @date December 2023
4  * @author Ocean Insight, Inc.
5  *
6  * This is an interface to OceanDirect that allows the user to read and write autonulling
7  * information (basleine, saturation level, maximum ADC count) from/to the device.
8  * This is intended as a usable and extensible API.
9  */
10  /************************************************************************
11  *
12  * OCEAN INSIGHT CONFIDENTIAL
13  * __________________
14  *
15  * [2018] - [2023] Ocean Insight Incorporated
16  * All Rights Reserved.
17  *
18  * NOTICE: All information contained herein is, and remains
19  * the property of Ocean Insight Incorporated and its suppliers,
20  * if any. The intellectual and technical concepts contained
21  * herein are proprietary to Ocean Insight Incorporated
22  * and its suppliers and may be covered by U.S. and Foreign Patents,
23  * patents in process, and are protected by trade secret or copyright law.
24  * Dissemination of this information or reproduction of this material
25  * is strictly forbidden unless prior written permission is obtained
26  * from Ocean Insight Incorporated.
27  *
28  **************************************************************************/
29 
30 #ifndef LH_AUTONULLING_API_H
31 #define LH_AUTONULLING_API_H
32 
33 #include "lighthouse/api/LighthouseDllDecl.h"
34 #include "lighthouse/api/lhdefs.h"
38 namespace oceandirect {
39  namespace api {
40 
41  class LIGHTHOUSE_DLL_DECL LHAutoNullingAPI {
42  public:
43  virtual ~LHAutoNullingAPI() = default;
44 
52  virtual lh_pixel_intensity_t getMaximumADCCount(lh_device_id_t deviceID, lh_error_code_t* errorCode);
53 
60  virtual lh_autonull_saturation_t getSaturationLevel(lh_device_id_t deviceID, lh_error_code_t* errorCode);
61 
68  virtual lh_autonull_baseline_t getBaselineLevel(lh_device_id_t deviceID, lh_error_code_t* errorCode);
69 
76  virtual lh_autonull_fpga_digital_t getFPGADigitalGain(lh_device_id_t deviceID, lh_error_code_t* errorCode);
77 
84  virtual lh_autonull_fpga_digital_t getFPGADigitalOffset(lh_device_id_t deviceID, lh_error_code_t* errorCode);
85  };
86  }
87 }
88 #endif /* LH_AUTONULLING_API_H */
Definition: LHAutoNullingAPI.h:41
virtual lh_autonull_fpga_digital_t getFPGADigitalGain(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual lh_autonull_saturation_t getSaturationLevel(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual lh_pixel_intensity_t getMaximumADCCount(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual lh_autonull_baseline_t getBaselineLevel(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual lh_autonull_fpga_digital_t getFPGADigitalOffset(lh_device_id_t deviceID, lh_error_code_t *errorCode)
This is the API for controlling the autonulling functionality of a device.
Definition: LighthouseAPI.h:54