Camera.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef SDF_CAMERA_HH_
18 #define SDF_CAMERA_HH_
19 
20 #include <string>
21 #include <ignition/math/Pose3.hh>
22 #include <ignition/utils/ImplPtr.hh>
23 
24 #include <sdf/Error.hh>
25 #include <sdf/Element.hh>
26 #include <sdf/Noise.hh>
27 #include <sdf/sdf_config.h>
28 
29 namespace sdf
30 {
31  // Inline bracket to help doxygen filtering.
32  inline namespace SDF_VERSION_NAMESPACE {
36  enum class PixelFormatType
37  {
39  L_INT8,
40  L_INT16,
41  RGB_INT8,
42  RGBA_INT8,
43  BGRA_INT8,
44  RGB_INT16,
45  RGB_INT32,
46  BGR_INT8,
47  BGR_INT16,
48  BGR_INT32,
49  R_FLOAT16,
51  R_FLOAT32,
57  };
58 
61  {
63  public: Camera();
64 
68  public: bool operator==(const Camera &_alt) const;
69 
74  public: bool operator!=(const Camera &_alt) const;
75 
82  public: Errors Load(ElementPtr _sdf);
83 
88  public: sdf::ElementPtr Element() const;
89 
92  public: std::string Name() const;
93 
96  public: void SetName(const std::string &_name);
97 
100  public: bool Triggered() const;
101 
104  public: void SetTriggered(bool _triggered);
105 
108  public: std::string TriggerTopic() const;
109 
112  public: void SetTriggerTopic(const std::string &_triggerTopic);
113 
116  public: ignition::math::Angle HorizontalFov() const;
117 
120  public: void SetHorizontalFov(const ignition::math::Angle &_hfov);
121 
124  public: uint32_t ImageWidth() const;
125 
128  public: void SetImageWidth(uint32_t _width);
129 
132  public: uint32_t ImageHeight() const;
133 
136  public: void SetImageHeight(uint32_t _height);
137 
141  public: PixelFormatType PixelFormat() const;
142 
145  public: void SetPixelFormat(PixelFormatType _format);
146 
149  public: std::string PixelFormatStr() const;
150 
153  public: void SetPixelFormatStr(const std::string &_fmt);
154 
157  public: uint32_t AntiAliasingValue() const;
158 
161  public: void SetAntiAliasingValue(uint32_t _antiAliasingValue);
162 
165  public: double DepthNearClip() const;
166 
169  public: void SetDepthNearClip(double _near);
170 
173  public: double DepthFarClip() const;
174 
177  public: void SetDepthFarClip(double _far);
178 
181  public: double NearClip() const;
182 
185  public: void SetNearClip(double _near);
186 
189  public: void SetHasDepthCamera(bool _camera);
190 
193  public: bool HasDepthCamera() const;
194 
199  public: void SetHasDepthNearClip(bool _near);
200 
203  public: bool HasDepthNearClip() const;
204 
209  public: void SetHasDepthFarClip(bool _far);
210 
213  public: bool HasDepthFarClip() const;
214 
217  public: double FarClip() const;
218 
221  public: void SetFarClip(double _far);
222 
226  public: void SetHasSegmentationType(bool _type);
227 
230  public: bool HasSegmentationType() const;
231 
234  public: const std::string &SegmentationType() const;
235 
238  public: void SetSegmentationType(const std::string &_type);
239 
243  public: void SetHasBoundingBoxType(bool _type);
244 
247  public: bool HasBoundingBoxType() const;
248 
251  public: const std::string &BoundingBoxType() const;
252 
255  public: void SetBoundingBoxType(const std::string &_type);
256 
259  public: bool SaveFrames() const;
260 
263  public: void SetSaveFrames(bool _save);
264 
267  public: const std::string &SaveFramesPath() const;
268 
271  public: void SetSaveFramesPath(const std::string &_path);
272 
275  public: const Noise &ImageNoise() const;
276 
279  public: void SetImageNoise(const Noise &_noise);
280 
283  public: double DistortionK1() const;
284 
287  public: void SetDistortionK1(double _k1);
288 
291  public: double DistortionK2() const;
292 
295  public: void SetDistortionK2(double _k2);
296 
299  public: double DistortionK3() const;
300 
303  public: void SetDistortionK3(double _k3);
304 
307  public: double DistortionP1() const;
308 
311  public: void SetDistortionP1(double _p1);
312 
315  public: double DistortionP2() const;
316 
319  public: void SetDistortionP2(double _p2);
320 
323  public: const ignition::math::Vector2d &DistortionCenter() const;
324 
327  public: void SetDistortionCenter(const ignition::math::Vector2d &_center);
328 
332  public: const ignition::math::Pose3d &RawPose() const;
333 
337  public: void SetRawPose(const ignition::math::Pose3d &_pose);
338 
343  public: const std::string &PoseRelativeTo() const;
344 
349  public: void SetPoseRelativeTo(const std::string &_frame);
350 
358  public: const std::string OpticalFrameId() const;
359 
363  public: void SetOpticalFrameId(const std::string &_frame);
364 
371  public: std::string LensType() const;
372 
376  public: void SetLensType(const std::string &_type);
377 
381  public: bool LensScaleToHfov() const;
382 
386  public: void SetLensScaleToHfov(bool _scale);
387 
390  public: double LensC1() const;
391 
394  public: void SetLensC1(double _c1);
395 
398  public: double LensC2() const;
399 
402  public: void SetLensC2(double _c2);
403 
406  public: double LensC3() const;
407 
410  public: void SetLensC3(double _c3);
411 
414  public: double LensFocalLength() const;
415 
418  public: void SetLensFocalLength(double _f);
419 
423  public: const std::string &LensFunction() const;
424 
428  public: void SetLensFunction(const std::string &_fun);
429 
433  public: ignition::math::Angle LensCutoffAngle() const;
434 
438  public: void SetLensCutoffAngle(const ignition::math::Angle &_angle);
439 
443  public: int LensEnvironmentTextureSize() const;
444 
448  public: void SetLensEnvironmentTextureSize(int _size);
449 
452  public: double LensIntrinsicsFx() const;
453 
456  public: void SetLensIntrinsicsFx(double _fx);
457 
460  public: double LensIntrinsicsFy() const;
461 
464  public: void SetLensIntrinsicsFy(double _fy);
465 
468  public: double LensIntrinsicsCx() const;
469 
472  public: void SetLensIntrinsicsCx(double _cx);
473 
476  public: double LensIntrinsicsCy() const;
477 
480  public: void SetLensIntrinsicsCy(double _cy);
481 
484  public: double LensProjectionFx() const;
485 
488  public: void SetLensProjectionFx(double _fx_p);
489 
492  public: double LensProjectionFy() const;
493 
496  public: void SetLensProjectionFy(double _fy_p);
497 
500  public: double LensProjectionCx() const;
501 
504  public: void SetLensProjectionCx(double _cx_p);
505 
508  public: double LensProjectionCy() const;
509 
512  public: void SetLensProjectionCy(double _cy_p);
513 
516  public: double LensProjectionTx() const;
517 
520  public: void SetLensProjectionTx(double _tx);
521 
524  public: double LensProjectionTy() const;
525 
528  public: void SetLensProjectionTy(double _ty);
529 
532  public: double LensIntrinsicsSkew() const;
533 
536  public: void SetLensIntrinsicsSkew(double _s);
537 
541  public: static PixelFormatType ConvertPixelFormat(
542  const std::string &_format);
543 
547  public: static std::string ConvertPixelFormat(PixelFormatType _type);
548 
551  public: uint32_t VisibilityMask() const;
552 
555  public: void SetVisibilityMask(uint32_t _mask);
556 
559  public: bool HasLensIntrinsics() const;
560 
566  public: sdf::ElementPtr ToElement() const;
567 
569  IGN_UTILS_IMPL_PTR(dataPtr)
570  };
571  }
572 }
573 
574 #endif
sdf::v12::PixelFormatType::RGB_INT8
@ RGB_INT8
sdf::v12::PixelFormatType::BGRA_INT8
@ BGRA_INT8
Error.hh
sdf::v12::PixelFormatType::L_INT16
@ L_INT16
Noise.hh
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:34
sdf::v12::PixelFormatType
PixelFormatType
Definition: Camera.hh:36
sdf::v12::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:106
sdf::v12::PixelFormatType::RGB_INT16
@ RGB_INT16
sdf::v12::PixelFormatType::R_FLOAT32
@ R_FLOAT32
sdf::v12::PixelFormatType::BGR_INT32
@ BGR_INT32
sdf_config.h
sdf::v12::PixelFormatType::RGB_FLOAT16
@ RGB_FLOAT16
sdf::v12::PixelFormatType::RGB_FLOAT32
@ RGB_FLOAT32
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:25
sdf::v12::PixelFormatType::RGBA_INT8
@ RGBA_INT8
sdf::v12::PixelFormatType::BAYER_GBRG8
@ BAYER_GBRG8
sdf::v12::PixelFormatType::BAYER_BGGR8
@ BAYER_BGGR8
sdf::v12::Element
class IGNITION_SDFORMAT_VISIBLE Element
Definition: Element.hh:50
sdf::v12::Camera
Information about a monocular camera sensor.
Definition: Camera.hh:60
sdf::v12::PixelFormatType::R_FLOAT16
@ R_FLOAT16
sdf::v12::PixelFormatType::UNKNOWN_PIXEL_FORMAT
@ UNKNOWN_PIXEL_FORMAT
sdf::v12::PixelFormatType::BGR_INT8
@ BGR_INT8
sdf::v12::PixelFormatType::L_INT8
@ L_INT8
sdf::v12::PixelFormatType::RGB_INT32
@ RGB_INT32
sdf::v12::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:54
sdf::v12::PixelFormatType::BAYER_GRBG8
@ BAYER_GRBG8
sdf::v12::PixelFormatType::BAYER_RGGB8
@ BAYER_RGGB8
Element.hh
sdf::v12::PixelFormatType::BGR_INT16
@ BGR_INT16
sdf::v12::Noise
The Noise class contains information about a noise model, such as a Gaussian distribution.
Definition: Noise.hh:47