WSL/SLF GitLab Repository

Commit 0d8407e4 authored by Mathias Bavay's avatar Mathias Bavay
Browse files

Documentation update: hopefuly clearer for first time users (more links added)...

Documentation update: hopefuly clearer for first time users (more links added) and removing an obsolete comment in Accumulate
parent 3f0de0c9
...@@ -30,8 +30,10 @@ namespace mio { ...@@ -30,8 +30,10 @@ namespace mio {
/** /**
* @class DEMObject * @class DEMObject
* @brief A class to represent DEMs: reads elevation grids, computes local slope, azimuth, curvature. * @brief A class to represent DEMs and automatically compute some properties.
* The nodata parameter is supposed to be IOUtils::nodata. * This class stores elevation grids and their georeferencing, expressed as the lower-left coordinates, the cellsize (cells are assumed to be square) and a nodata code for potentially empty cells (The nodata parameter is supposed to be IOUtils::nodata).
* This class also automatically computes local slope, azimuth, curvature, normals and minimal/maximal for normalization.
* Various algorithms are available to compute these properties (see mio::DEMObject::slope_type) and it is possible to toggle between automatic refresh or not. Several other DEM related values can be computed, such as the horizon, displacements within the DEM, etc
* *
* @ingroup data_str * @ingroup data_str
* @author Gaël Rosset - Mathias Bavay * @author Gaël Rosset - Mathias Bavay
......
...@@ -89,15 +89,15 @@ namespace mio { ...@@ -89,15 +89,15 @@ namespace mio {
* Since MeteoIO is a library, you, as an end user, will have a limited direct exposure to it: the library is called by the program that you are using, not directly by yourself. You will basically have to set some parameters in a configuration file that defines how MeteoIO has to behave. This configuration file is often named "io.ini" and follows the INI file format standard (see http://en.wikipedia.org/wiki/INI_file). In order to understand how this file is structured, let us first have a look at the general structure of MeteoIO and afterward the structure of this configuration file and where to find the available configuration parameters. * Since MeteoIO is a library, you, as an end user, will have a limited direct exposure to it: the library is called by the program that you are using, not directly by yourself. You will basically have to set some parameters in a configuration file that defines how MeteoIO has to behave. This configuration file is often named "io.ini" and follows the INI file format standard (see http://en.wikipedia.org/wiki/INI_file). In order to understand how this file is structured, let us first have a look at the general structure of MeteoIO and afterward the structure of this configuration file and where to find the available configuration parameters.
* *
* @section MeteoIO_structure General MeteoIO structure * @section MeteoIO_structure General MeteoIO structure
* MeteoIO can be seen as a set of modules that is focused on the handling of input/output operations (including data preparation) for numerical simulations in the realm of earth sciences. On the visible side, it offers the following modules: * MeteoIO can be seen as a set of modules that is focused on the handling of input/output operations (including data preparation) for numerical simulations in the realm of earth sciences. On the visible side, it offers the following modules, working on a pre-determined set of \ref meteoparam "meteorological parameters" or on parameters added by the developer:
* - a set of plugins for accessing the data (for example, a plugin might be responsible for fetching the raw data from a given database) * - a set of \ref plugins "plugins" for accessing the data (for example, a plugin might be responsible for fetching the raw data from a given database)
* - a set of filters and processing elements for applying transformations to the data (for example, a filter might remove all data that is out of range) * - a set of \ref processing "filters and processing elements" for applying transformations to the data (for example, a filter might remove all data that is out of range)
* - a set of spatial interpolation algorithms (for example, such an algorithm might perform Inverse Distance Weighting for filling a grid with spatially interpolated data) * - a set of \ref interpol2d "spatial interpolation algorithms" (for example, such an algorithm might perform Inverse Distance Weighting for filling a grid with spatially interpolated data)
* *
* Moreover, a few assumptions are made about the data that you are using: each data point has to be associated with a geographic location (defined by some sort of coordinates) and very often you will also need to provide a Digital Elevation Model. Therefore, you will also notice a few extra modules that come to play on the visible side: * Moreover, a few assumptions are made about the data that you are using: each data point has to be associated with a geographic location (defined by some sort of coordinates) and very often you will also need to provide a Digital Elevation Model. Therefore, you will also notice a few extra modules that come to play on the visible side:
* - a module to deal with Digital Elevation Models. Such module will, for example, interpret a grid of data as a grid of elevations and compute a grid of slopes. * - a module to deal with \ref DEMObject "Digital Elevation Models". Such module will for example interpret a grid of data as a grid of elevations and compute a grid of slopes.
* - a module to deal with coordinate systems. Such module will require you to define which coordinate system are your data in and transparently handle potential coordinate conversions in the program that you are using. * - a module to deal with \ref coords "coordinate systems". Such module will require you to define which coordinate system are your data in and transparently handle potential coordinate conversions in the program that you are using.
* - a module to deal with configuration files. The program that you are using might be using this module for other configuration files. * - a module to deal with \ref mio::Config "configuration files". The program that you are using might be using this module for other configuration files.
* *
* @section Config Configuration file * @section Config Configuration file
* @anchor config_doc * @anchor config_doc
......
...@@ -201,7 +201,7 @@ class LinearResampling : public ResamplingAlgorithms { ...@@ -201,7 +201,7 @@ class LinearResampling : public ResamplingAlgorithms {
* hourly precipitation measurements. Remarks: * hourly precipitation measurements. Remarks:
* - the accumulation period has to be provided as an argument (in seconds) * - the accumulation period has to be provided as an argument (in seconds)
* - if giving the argument "strict", nodatas will propagate (ie. a single nodata in the input will force the re-accumulated value to be nodata). By default, all valid values are aggregated and only pure nodata intervals produce a nodata in the output. * - if giving the argument "strict", nodatas will propagate (ie. a single nodata in the input will force the re-accumulated value to be nodata). By default, all valid values are aggregated and only pure nodata intervals produce a nodata in the output.
* - if the data has been measured on intervals greater than the sampling interval of the data file (for example, 24 hours accumulations written once per day in an hourly file, the other timesteps receiving nodata), the measured accumulation period can be provided as first argument. Please note that this period can not be smaller than the requested sampling period and that the requested sampling period can not have a time offset with the sampling period. Moreover, only regular sampling is currently supported for such data sets. * - if the data has been measured on intervals greater than the sampling interval of the data file (for example, 24 hours accumulations written once per day in an hourly file, the other timesteps receiving nodata), the measured accumulation period can be provided as first argument. Please note that this period can not be smaller than the requested sampling period and that the requested sampling period can not have a time offset with the sampling period.
* @code * @code
* HNW::resample = accumulate * HNW::resample = accumulate
* HNW::accumulate = 3600 * HNW::accumulate = 3600
......
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