1 /*
2  * Copyright (c) 2014, The University of Oxford
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * 1. Redistributions of source code must retain the above copyright notice,
8  *    this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  *    this list of conditions and the following disclaimer in the documentation
11  *    and/or other materials provided with the distribution.
12  * 3. Neither the name of the University of Oxford nor the names of its
13  *    contributors may be used to endorse or promote products derived from this
14  *    software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef OSKAR_ELLIPSE_RADIUS_H_
30 #define OSKAR_ELLIPSE_RADIUS_H_
31 
32 /**
33  * @file oskar_ellipse_radius.h
34  */
35 
36 #include <oskar_global.h>
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /**
43  * @details
44  * Return the radius at a specified point on an ellipse.
45  *
46  * @param[in] maj_axis         Major axis of ellipse.
47  * @param[in] min_axis         Minor axis of ellipse.
48  * @param[in] pa_ellipse_rad   Position angle of ellipse, in radians.
49  * @param[in] pa_point_rad     Position angle of point, in radians.
50  *
51  * @return The radius of the ellipse at the given point.
52  */
53 OSKAR_EXPORT
54 double oskar_ellipse_radius(double maj_axis, double min_axis,
55         double pa_ellipse_rad, double pa_point_rad);
56 
57 #ifdef __cplusplus
58 }
59 #endif
60 
61 #endif /* OSKAR_ELLIPSE_RADIUS_H_ */
62