Distortion.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 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 GAZEBO_RENDERING_DISTORTION_HH_
18 #define GAZEBO_RENDERING_DISTORTION_HH_
19 
20 #include <memory>
21 #include <ignition/math/Vector2.hh>
22 
23 #include "gazebo/math/Vector2d.hh"
25 #include "gazebo/util/system.hh"
26 
27 namespace gazebo
28 {
31  namespace rendering
32  {
33  class DistortionPrivate;
34 
37 
40  class GZ_RENDERING_VISIBLE Distortion
41  {
43  public: Distortion();
44 
46  public: virtual ~Distortion();
47 
50  public: virtual void Load(sdf::ElementPtr _sdf);
51 
54  public: void SetCamera(CameraPtr _camera);
55 
60  public: void SetCrop(const bool _crop);
61 
66  public: bool Crop() const;
67 
71  public: double GetK1() const GAZEBO_DEPRECATED(8.0);
72 
75  public: double K1() const;
76 
80  public: double GetK2() const GAZEBO_DEPRECATED(8.0);
81 
84  public: double K2() const;
85 
89  public: double GetK3() const GAZEBO_DEPRECATED(8.0);
90 
93  public: double K3() const;
94 
98  public: double GetP1() const GAZEBO_DEPRECATED(8.0);
99 
102  public: double P1() const;
103 
107  public: double GetP2() const GAZEBO_DEPRECATED(8.0);
108 
111  public: double P2() const;
112 
116  public: math::Vector2d GetCenter() const GAZEBO_DEPRECATED(8.0);
117 
120  public: ignition::math::Vector2d Center() const;
121 
133  public: static math::Vector2d Distort(const math::Vector2d &_in,
134  const math::Vector2d &_center, double _k1, double _k2, double _k3,
135  double _p1, double _p2) GAZEBO_DEPRECATED(8.0);
136 
146  public: static ignition::math::Vector2d Distort(
147  const ignition::math::Vector2d &_in,
148  const ignition::math::Vector2d &_center,
149  double _k1, double _k2, double _k3,
150  double _p1, double _p2);
151 
156  protected: ignition::math::Vector2d
157  DistortionMapValueClamped(const int x, const int y) const;
158 
162  protected: void CalculateAndApplyDistortionScale();
163 
166  private: std::unique_ptr<DistortionPrivate> dataPtr;
167  };
169  }
170 }
171 #endif
Generic double x, y vector.
Definition: Vector2d.hh:36
Camera distortion based on the Brown-Conrady model.
Definition: Distortion.hh:40
#define GAZEBO_DEPRECATED(version)
Definition: system.hh:302
boost::shared_ptr< Camera > CameraPtr
Definition: RenderTypes.hh:89