Files
paparazzi/sw/lib/ocaml/latlong.mli
T
2007-04-26 22:08:04 +00:00

141 lines
4.3 KiB
OCaml

(*
* $Id$
*
* Geographic conversion utilities
*
* Copyright (C) 2004 CENA/ENAC, Pascal Brisset
*
* This file is part of paparazzi.
*
* paparazzi is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* paparazzi is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with paparazzi; see the file COPYING. If not, write to
* the Free Software Foundation, 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*)
(** Representing and converting geographic positions *)
(** {b Angles} *)
val pi : float
type degree = float
and radian = float
and semi = float
and dms = int * int * float
(** Angle units. In [semi], -pi is coded by -2^31 and pi by 2^31 (used in
Garmin GPS protocol). *)
val deg_string_of_rad : radian -> string
type angle_unit = Semi | Rad | Deg | Grd
val ( >> ) : angle_unit -> angle_unit -> float -> float
(** [(Unit1>>Unit2) a] converts angle [a] expressed in [Unit1] in [Unit2] *)
val decimal : int -> int -> float -> float
val dms : float -> dms
(** Conversions between decimal degrees and degree, minutes and seconds *)
(** {b Geodesic datum} *)
type geodesic = NTF | ED50 | WGS84 | NAD27
(** Geodesic referential *)
type lambert_zone
val lambertI : lambert_zone
val lambertII : lambert_zone
val lambertIIe : lambert_zone
val lambertIII : lambert_zone
val lambertIV : lambert_zone
(** French lambert zones *)
(** {b Positions} *)
type semicircle = { lat : semi; long : semi; }
type geographic = { posn_lat : radian; posn_long : radian; }
type cartesian = { x : float; y : float; z : float; }
type meter = int
type fmeter = float
type lambert = { lbt_x : meter; lbt_y : meter; }
type utm = { utm_x : fmeter; utm_y : fmeter; utm_zone : int; }
(** Position units. Coordinates are in meters in the [cartesian] type. *)
val string_degrees_of_geographic : geographic -> string
(** Pretty printing *)
(** {b Conversions} *)
val ( << ) : geodesic -> geodesic -> geographic -> geographic
(** [(Geo1<<Geo2) g] converts [g] expressed in [Geo2] referential to [Geo1]
referential *)
val of_semicircle : semicircle -> geographic
val semicircle_of : geographic -> semicircle
type ntf = geographic
(** Type alias for documentation purpose *)
val of_lambert : lambert_zone -> lambert -> ntf
val lambert_of : lambert_zone -> ntf -> lambert
(** Conversions between geographic (in NTF) and lambert *)
val utm_of' : geodesic -> geographic -> utm
val utm_of : geodesic -> geographic -> utm
val of_utm : geodesic -> utm -> geographic
(** Conversions between geographic and UTM. May raise Invalid_argument. *)
val cartesian_of : geodesic -> geographic -> float -> cartesian
(** [cartesian_of geode geo alt] converts position [geo] at altitude [alt]
expressed in [geode] into cartesian coordinates *)
val of_cartesian : geodesic -> cartesian -> geographic * float
(** [of_cartesian geode xyz] converts cartesian coordinates [xyz] into
geographic coordinates and altitude expressed in geodesic referential
[geode] *)
val utm_distance : utm -> utm -> fmeter
val utm_add : utm -> (fmeter * fmeter) -> utm
(** [add_utm utm (east,north)] *)
val utm_sub : utm -> utm -> (fmeter * fmeter)
(** [utm_sub u1 u2] Raises Invalid_arg if [u1] and [u2] are not in the same
UTM zone *)
val of_lambertIIe : lambert -> geographic
val lambertIIe_of : geographic -> lambert
val lbt_add : lambert -> (fmeter * fmeter) -> lambert
(** [add_lbt utm (east,north)] *)
val lbt_sub : lambert -> lambert -> (fmeter * fmeter)
(** Returns (east,north) *)
val of_string : string -> geographic
(** [of_string pos] Parses [pos] as "WGS84 45.678 1.2345", "UTM 500123 4500300 31" or "LBT2e 544945 1755355" *)
val string_of : geographic -> string
(** Returns a "WGS84" annotated string *)
val mercator_lat : float -> float
(** wgs84 -> [-pi; pi] *)
val inv_mercator_lat : float -> float
(** [-pi; pi] -> wgs84 *)
val bearing : geographic -> geographic -> float * float
(** [bearing from to] returns (degrees CW/north, m) *)