sensor_definitions.h
Go to the documentation of this file.
1 /*
2  * BSD 3-Clause License
3  *
4  * Copyright (c) 2019, Analog Devices, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 #ifndef SENSOR_DEFINITIONS_H
33 #define SENSOR_DEFINITIONS_H
34 
35 #include "aditof/connections.h"
36 
37 #include <iostream>
38 #include <string>
39 #include <vector>
40 
44 namespace aditof {
45 
50 struct SensorDetails {
56 
61 };
62 
84 
89 
94 
99 
104 
109 
114 };
115 
121 
125  uint8_t modeNumber;
126 
130  std::vector<std::string> frameContent;
131 
135  uint8_t numberOfPhases;
136 
141 
146 
151 
156 
161 
166 
170  int isPCM;
171 
176 };
177 
181 inline std::ostream &operator<<(std::ostream &o,
182  const DepthSensorModeDetails &a) {
183  o << "DepthSensorModeDetails: \tN: " << a.modeNumber
184  << "\tW: " << a.baseResolutionWidth << "\tH: " << a.baseResolutionHeight
185  << " contains:\n";
186  for (auto &content : a.frameContent) {
187  o << "\t" << content;
188  }
189  return o;
190 }
191 } // namespace aditof
192 
193 #endif // SENSOR_DEFINITIONS_H
aditof::DepthSensorModeDetails::isPCM
int isPCM
set to true if the mode is PCM
Definition: sensor_definitions.h:170
aditof::DepthSensorModeDetails::frameContent
std::vector< std::string > frameContent
Stores the content of each frame.
Definition: sensor_definitions.h:130
aditof::DepthSensorModeDetails::modeNumber
uint8_t modeNumber
Number associated with the mode.
Definition: sensor_definitions.h:125
aditof::DepthSensorModeDetails::frameHeightInBytes
int frameHeightInBytes
Driver height, can be used for both chipRaw and imagerRaw.
Definition: sensor_definitions.h:150
aditof::DepthSensorModeDetails::baseResolutionHeight
int baseResolutionHeight
Processed data height.
Definition: sensor_definitions.h:160
aditof::SensorDetails
Provides details about the device.
Definition: sensor_definitions.h:50
aditof::operator<<
std::ostream & operator<<(std::ostream &o, const struct Metadata &meta)
prints human readable metadata structure
Definition: frame_definitions.h:262
aditof::DriverConfiguration::depthBits
std::string depthBits
Stores depth data.
Definition: sensor_definitions.h:83
connections.h
string
GLsizei const GLchar *const * string
Definition: glcorearb.h:3083
aditof::DepthSensorModeDetails::metadataSize
int metadataSize
Stores the size of metadata.
Definition: sensor_definitions.h:165
aditof::SensorDetails::id
std::string id
The sensor identification data to be used to differentiate between sensors. When on target,...
Definition: sensor_definitions.h:55
aditof
Namespace aditof.
Definition: adsd_errs.h:40
aditof::DriverConfiguration::driverHeigth
int driverHeigth
Stores driver height.
Definition: sensor_definitions.h:108
aditof::DepthSensorModeDetails::pixelFormatIndex
int pixelFormatIndex
Index of two possbile values sensor values (8bit, 12/16bit)
Definition: sensor_definitions.h:140
aditof::DriverConfiguration::confBits
std::string confBits
Stores conf data.
Definition: sensor_definitions.h:93
aditof::DriverConfiguration::abBits
std::string abBits
Stores ab data.
Definition: sensor_definitions.h:88
aditof::ConnectionType
ConnectionType
Types of connections.
Definition: connections.h:44
aditof::DepthSensorModeDetails::baseResolutionWidth
int baseResolutionWidth
Processed data witdh.
Definition: sensor_definitions.h:155
aditof::DriverConfiguration::baseHeigth
std::string baseHeigth
Base heigth value of the frame.
Definition: sensor_definitions.h:75
aditof::DepthSensorModeDetails::driverConfiguration
DriverConfiguration driverConfiguration
Stores the content of a frame.
Definition: sensor_definitions.h:175
aditof::DriverConfiguration::noOfPhases
std::string noOfPhases
Number of phases.
Definition: sensor_definitions.h:79
aditof::DriverConfiguration
Describes the configuration of the used driver.
Definition: sensor_definitions.h:67
aditof::DepthSensorModeDetails
Describes the type of entire frame that a depth sensor can capture and transmit.
Definition: sensor_definitions.h:120
aditof::DriverConfiguration::pixelFormat
std::string pixelFormat
Stores value from driver.
Definition: sensor_definitions.h:98
aditof::DriverConfiguration::driverWidth
int driverWidth
Stores driver width.
Definition: sensor_definitions.h:103
aditof::DepthSensorModeDetails::frameWidthInBytes
int frameWidthInBytes
Driver width, can be used for both chipRaw and imagerRaw.
Definition: sensor_definitions.h:145
aditof::DriverConfiguration::baseWidth
std::string baseWidth
Base width value of the frame.
Definition: sensor_definitions.h:71
aditof::DepthSensorModeDetails::numberOfPhases
uint8_t numberOfPhases
Number of phases.
Definition: sensor_definitions.h:135
aditof::SensorDetails::connectionType
ConnectionType connectionType
The type of connection with the sensor.
Definition: sensor_definitions.h:60
a
GLboolean GLboolean GLboolean GLboolean a
Definition: glcorearb.h:3228
aditof::DriverConfiguration::pixelFormatIndex
int pixelFormatIndex
Index of two possbile values sensor values (8bit, 12/16bit)
Definition: sensor_definitions.h:113


libaditof
Author(s):
autogenerated on Wed May 21 2025 02:06:58