Gazebo Rendering

API Reference

3.7.2
gz/rendering/ThermalCamera.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 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 GZ_RENDERING_THERMALCAMERA_HH_
18 #define GZ_RENDERING_THERMALCAMERA_HH_
19 
20 #include <string>
21 #include "gz/rendering/Camera.hh"
22 
23 namespace ignition
24 {
25  namespace rendering
26  {
27  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
28  /* \class ThermalCamera ThermalCamera.hh \
29  * ignition/rendering/ThermalCamera.hh
30  */
40  class IGNITION_RENDERING_VISIBLE ThermalCamera :
41  public virtual Camera
42  {
44  public: virtual ~ThermalCamera() { }
45 
49  public: virtual void SetAmbientTemperature(float _ambient) = 0;
50 
54  public: virtual float AmbientTemperature() const = 0;
55 
60  public: virtual void SetAmbientTemperatureRange(float _range) = 0;
61 
66  public: virtual float AmbientTemperatureRange() const = 0;
67 
71  public: virtual void SetMinTemperature(float _min) = 0;
72 
76  public: virtual float MinTemperature() const = 0;
77 
81  public: virtual void SetMaxTemperature(float _max) = 0;
82 
86  public: virtual float MaxTemperature() const = 0;
87 
94  public: virtual void SetLinearResolution(float _resolution) = 0;
95 
99  public: virtual float LinearResolution() const = 0;
100 
104  public: virtual float HeatSourceTemperatureRange() const = 0;
105 
112  public: virtual void SetHeatSourceTemperatureRange(float _range) = 0;
113 
118  public: virtual gz::common::ConnectionPtr ConnectNewThermalFrame(
119  std::function<void(const uint16_t *, unsigned int, unsigned int,
120  unsigned int, const std::string &)> _subscriber) = 0;
121  };
122  }
123  }
124 }
125 #endif
STL class.
virtual float AmbientTemperatureRange() const =0
Get the range of ambient temperature.
virtual float HeatSourceTemperatureRange() const =0
Get the range of temperature variation for all heat sources.
Posable camera used for rendering the scene graph.
Definition: gz/rendering/Camera.hh:40
virtual void SetHeatSourceTemperatureRange(float _range)=0
Set the range of temperature variation for all heat sources. If set, the temperature reading of heat ...
virtual void SetAmbientTemperature(float _ambient)=0
Set the ambient temperature of the environment.
virtual float LinearResolution() const =0
Get the temperature linear resolution.
virtual void SetLinearResolution(float _resolution)=0
Set the temperature linear resolution. The thermal image data returned will be temperature in kelvin ...
virtual float AmbientTemperature() const =0
Get the ambient temperature of the environment.
virtual float MaxTemperature() const =0
Get the maximum temperature the sensor can detect.
virtual void SetMaxTemperature(float _max)=0
Set the maximum temperature the sensor can detect.
virtual void SetMinTemperature(float _min)=0
Set the minimum temperature the sensor can detect.
Thermal camera that produces temperature data. An object's temperature can be set through the Visual ...
Definition: gz/rendering/ThermalCamera.hh:40
virtual float MinTemperature() const =0
Get the minimum temperature the sensor can detect.
virtual gz::common::ConnectionPtr ConnectNewThermalFrame(std::function< void(const uint16_t *, unsigned int, unsigned int, unsigned int, const std::string &)> _subscriber)=0
Connect to the new thermal image event.
virtual ~ThermalCamera()
Destructor.
Definition: gz/rendering/ThermalCamera.hh:44
virtual void SetAmbientTemperatureRange(float _range)=0
Set the range of ambient temperature.