WSL/SLF GitLab Repository

Commit c01e416b authored by Mathias Bavay's avatar Mathias Bavay
Browse files

Added the documentation for the available coordinate conversions types.

parent 172bb635
......@@ -72,7 +72,7 @@
* @section proj_sec Geographic projections
* The class MapProj is dedicated to geographic projections. It can use both internal algorithms and projections provided by <a href="http://trac.osgeo.org/proj/">libproj4</a>.
* @subsection coord_conv Coordinate conversion
* The class MapProj takes one or two arguments describing the coordinate system of the input data and then converts back and forth with lat/long WGS84. It can be used to construct a local coordinate system, that is to say a metric grid whose origin is chosen by the user (through the lat/long parameters provided to the constructor). This is useful when working with multiple gridded coordinate system in order to get a common system that would still allow easy distances calculations.
* The class MapProj takes one or two arguments describing the coordinate system of the input data and then converts back and forth with lat/long WGS84. It can be used to construct a local coordinate system, that is to say a metric grid whose origin is chosen by the user (through the lat/long parameters provided to the constructor). This is useful when working with multiple gridded coordinate system in order to get a common system that would still allow easy distances calculations. See the supported \ref mapproj_types "projections".
* @subsection dist_sec Distances
* A few method used internally to work with custom, local grids are exposed to the user in order to easily compute distances beetwen points (using their lat/long). The algorithms can optionnaly be chosen (otherwise a default choice is used).
*
......
......@@ -34,7 +34,7 @@ const struct MapProj::ELLIPSOID MapProj::ellipsoids[] = {
};
void MapProj::initializeMaps()
{
{ //Please don't forget to mirror the keywords here in the documentation in MapProj.h!!
to_wgs84["CH1903"] = &MapProj::CH1903_to_WGS84;
from_wgs84["CH1903"] = &MapProj::WGS84_to_CH1903;
to_wgs84["PROJ4"] = &MapProj::PROJ4_to_WGS84;
......
......@@ -52,9 +52,15 @@ class MapProj {
MapProj();
/**
* \anchor mapproj_types
* @brief Regular constructor: usually, this is the constructor to use
* @param[in] coordinatesystem string identifying the coordinate system to use
* @param[in] parameters string giving some additional parameters for the projection (optional)
*
* The coordinate system can be any of the following:
* - CH1903 for coordinates in the Swiss Grid
* - PROJ4 for coordinate conversion relying on the Proj4 library
* - LOCAL for local coordinate system (from reference point)
*/
MapProj(const std::string& coordinatesystem, const std::string& parameters="");
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment