Point Cloud Library (PCL)  1.8.1
angles.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Point Cloud Library (PCL) - www.pointclouds.org
5  * Copyright (c) 2010-2012, Willow Garage, Inc.
6  * Copyright (c) 2012-, Open Perception, Inc.
7  *
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * * Redistributions of source code must retain the above copyright
15  * notice, this list of conditions and the following disclaimer.
16  * * Redistributions in binary form must reproduce the above
17  * copyright notice, this list of conditions and the following
18  * disclaimer in the documentation and/or other materials provided
19  * with the distribution.
20  * * Neither the name of the copyright holder(s) nor the names of its
21  * contributors may be used to endorse or promote products derived
22  * from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  *
37  */
38 
39 #ifndef PCL_COMMON_ANGLES_H_
40 #define PCL_COMMON_ANGLES_H_
41 
42 /**
43  * \file pcl/common/angles.h
44  * Define standard C methods to do angle calculations
45  * \ingroup common
46  */
47 
48 /*@{*/
49 namespace pcl
50 {
51  /** \brief Convert an angle from radians to degrees
52  * \param alpha the input angle (in radians)
53  * \ingroup common
54  */
55  inline float
56  rad2deg (float alpha);
57 
58  /** \brief Convert an angle from degrees to radians
59  * \param alpha the input angle (in degrees)
60  * \ingroup common
61  */
62  inline float
63  deg2rad (float alpha);
64 
65  /** \brief Convert an angle from radians to degrees
66  * \param alpha the input angle (in radians)
67  * \ingroup common
68  */
69  inline double
70  rad2deg (double alpha);
71 
72  /** \brief Convert an angle from degrees to radians
73  * \param alpha the input angle (in degrees)
74  * \ingroup common
75  */
76  inline double
77  deg2rad (double alpha);
78 
79  /** \brief Normalize an angle to (-PI, PI]
80  * \param alpha the input angle (in radians)
81  * \ingroup common
82  */
83  inline float
84  normAngle (float alpha);
85 }
86 /*@}*/
87 #include <pcl/common/impl/angles.hpp>
88 
89 #endif // PCL_COMMON_ANGLES_H_
float deg2rad(float alpha)
Convert an angle from degrees to radians.
Definition: angles.hpp:67
float rad2deg(float alpha)
Convert an angle from radians to degrees.
Definition: angles.hpp:61
float normAngle(float alpha)
Normalize an angle to (-PI, PI].
Definition: angles.hpp:48