OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
PixelAPI.h
Go to the documentation of this file.
1/*****************************************************
2 * @file PixelAPI.h
3 * @date March 2021
4 * @author Ocean Optics, Inc.
5 *
6 * This is an interface to OceanDirect that allows
7 * the user to connect to devices over USB and other buses.
8 * This is intended as a usable and extensible API.
9 */
10 /************************************************************************
11 *
12 * OCEAN INSIGHT CONFIDENTIAL
13 * __________________
14 *
15 * [2018] - [2021] 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 PIXEL_API_H
31#define PIXEL_API_H
32
33#include "api/DllDecl.h"
34
41namespace oceandirect {
42 namespace api {
43
44 class DLL_DECL PixelAPI {
45 public:
47 virtual ~PixelAPI();
49
50 static void shutdown();
51
63 virtual int getPixelCount(long deviceID, int *error_code);
64
65 virtual int getActivePixelCount(long deviceID, int* error_code);
66
80 virtual int getActivePixelRange(long deviceID, int *error_code, int *range, int rangeSize);
81
82 virtual int getOpticalDarkPixelCount(long deviceID, int* error_code);
83
97 virtual int getOpticalDarkPixelRange(long deviceID, int *error_code, int *range, int rangeSize);
98
99 virtual int getTransitionPixelCount(long deviceID, int* error_code);
100
114 virtual int getTransitionPixelRange(long deviceID, int *error_code, int *range, int rangeSize);
115
129 virtual int getBadPixelIndices(long deviceID, int *error_code, int *badPixelIndices, int badPixelSize);
130
143 virtual void setBadPixelIndices(long deviceID, int* error_code, int* badPixelIndices, int badPixelSize);
144
145 protected:
147
148 };
149 }
150}
151#endif /* PIXEL_API_H */
Definition PixelAPI.h:44
virtual int getTransitionPixelCount(long deviceID, int *error_code)
virtual int getOpticalDarkPixelRange(long deviceID, int *error_code, int *range, int rangeSize)
virtual void setBadPixelIndices(long deviceID, int *error_code, int *badPixelIndices, int badPixelSize)
virtual int getPixelCount(long deviceID, int *error_code)
virtual int getActivePixelRange(long deviceID, int *error_code, int *range, int rangeSize)
static PixelAPI * instance
Definition PixelAPI.h:146
static PixelAPI * getInstance()
virtual int getBadPixelIndices(long deviceID, int *error_code, int *badPixelIndices, int badPixelSize)
virtual int getActivePixelCount(long deviceID, int *error_code)
virtual int getTransitionPixelRange(long deviceID, int *error_code, int *range, int rangeSize)
virtual int getOpticalDarkPixelCount(long deviceID, int *error_code)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition OceanDirectAPI.h:147