WSL/SLF GitLab Repository

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

A few typos have been fixed in the documentation, the welcome page has been...

A few typos have been fixed in the documentation, the welcome page has been restructured and a naming conflict (GRID_POINT for both 2D and 3D grids) has been temporarily avoided by calling these structures GRID_POINT_2/3D. This still leaves the question of how to handle DEMObject with 3D grid open though...
parent 192883b2
......@@ -304,7 +304,7 @@ double DEMObject::horizontalDistance(Coords point1, const Coords& point2)
*
*/
double DEMObject::terrainDistance(Coords point1, const Coords& point2) {
std::vector<GRID_POINT> vec_points;
std::vector<GRID_POINT_2D> vec_points;
double distance=0.;
unsigned int last_point=0; //point 0 is always the starting point
......@@ -344,7 +344,7 @@ double DEMObject::terrainDistance(Coords point1, const Coords& point2) {
* @param vec_points vector of points that are in between
*
*/
void DEMObject::getPointsBetween(Coords point1, Coords point2, std::vector<GRID_POINT>& vec_points) {
void DEMObject::getPointsBetween(Coords point1, Coords point2, std::vector<GRID_POINT_2D>& vec_points) {
if(point1.isSameProj(point2)==false) {
point1.copyProj(point2);
......@@ -366,7 +366,7 @@ void DEMObject::getPointsBetween(Coords point1, Coords point2, std::vector<GRID_
if(ix1==ix2) {
//special case of vertical alignement
for(int iy=MIN(iy1,iy2); iy<=MAX(iy1,iy2); iy++) {
GRID_POINT pts;
GRID_POINT_2D pts;
pts.ix = ix1;
pts.iy = iy;
vec_points.push_back(pts);
......@@ -394,7 +394,7 @@ void DEMObject::getPointsBetween(Coords point1, Coords point2, std::vector<GRID_
}
for(int iy=y1; iy<=y2; iy++) {
GRID_POINT pts;
GRID_POINT_2D pts;
pts.ix = ix;
pts.iy = iy;
//make sure we only return points within the dem
......
......@@ -74,7 +74,7 @@ class DEMObject : public Grid2DObject {
double horizontalDistance(const double& xcoord1, const double& ycoord1, const double& xcoord2, const double& ycoord2);
double horizontalDistance(Coords point1, const Coords& point2);
double terrainDistance(Coords point1, const Coords& point2);
void getPointsBetween(Coords point1, Coords point2, std::vector<GRID_POINT>& vec_points);
void getPointsBetween(Coords point1, Coords point2, std::vector<GRID_POINT_2D>& vec_points);
private:
void CalculateAziSlopeCurve(slope_type algorithm);
......
......@@ -33,9 +33,9 @@
*
* A few data transformations are also supported besides filtering:
* - accumulation: data accumulates over a given period, see FilterAlgorithms::AccumulateProcess
* - resample: linear data ressampling, FilterAlgorithms::LinResamplingProcess
* - median_avg: running median average over a given window, see FilterAlgorithms::MedianAvgFilter
* - mean_avg: running mean average over a given window, see FilterAlgorithms::MeanAvgFilter
* - resample: linear data resampling, FilterAlgorithms::LinResamplingProcess
* - median_avg: running median average over a given window, see FilterAlgorithms::MedianAvgProcess
* - mean_avg: running mean average over a given window, see FilterAlgorithms::MeanAvgProcess
* - wind_avg: vector average over a given window, see FilterAlgorithms::WindAvgProcess
*/
......@@ -410,7 +410,7 @@ bool FilterAlgorithms::AccumulateProcess(const std::vector<MeteoData>& vecM, con
}
/**
* @brief Linear Data ressampling
* @brief Linear Data resampling
* If a point is requested that is in between two input data points, the requested value is automatically calculated using
* a linear interpolation.
*/
......
......@@ -44,10 +44,10 @@ class Grid2DObject : POPBase {
class Grid2DObject {
#endif
public:
typedef struct GRID_POINT {
typedef struct GRID_POINT_2D {
unsigned int ix; ///<grid index along X
unsigned int iy; ///<grid index along Y
} grid_point;
} grid_point_2d;
Grid2DObject& operator=(const Grid2DObject&); ///<Assignement operator
friend std::ostream& operator<<(std::ostream& os, const Grid2DObject& grid);
......
......@@ -38,11 +38,11 @@ class Grid3DObject : POPBase {
class Grid3DObject{
#endif
public:
typedef struct GRID_POINT {
typedef struct GRID_POINT_3D { //TODO: this potentially conflicts with the definition in Grid2DObject
unsigned int ix; ///<grid index along X
unsigned int iy; ///<grid index along Y
unsigned int iz; ///<grid index along Z
} grid_point;
} grid_point_3d;
Grid3DObject& operator=(const Grid3DObject&); ///<Assignement operator
friend std::ostream& operator<<(std::ostream& os, const Grid3DObject& grid);
......
/***********************************************************************************/
/* Copyright 2009 WSL Institute for Snow and Avalanche Research SLF-DAVOS */
/* Copyright 2009-2010 WSL Institute for Snow and Avalanche Research SLF-DAVOS */
/***********************************************************************************/
/* This file is part of MeteoIO.
MeteoIO is free software: you can redistribute it and/or modify
......@@ -33,12 +33,15 @@
*
* @section table_of_content Table of content
* -# \subpage quick_overview "Quick overview" of the functionnality provided by MeteoIO
* -# \subpage plugins "Available plugins" and usage
* -# \subpage filters "Available filters" and usage
* -# \subpage interpol2d "Available spatial interpolations" and usage
* -# \subpage dev_plugins How to write a "Plugin"
* -# \subpage dev_filters How to write a "Filter"
* -# \subpage examples "Examples"
* -# End User documentation
* -# \subpage plugins "Available plugins" and usage
* -# \subpage filters "Available filters" and usage
* -# \subpage interpol2d "Available spatial interpolations" and usage
* -# Programing using MeteoIO
* -# \subpage examples "Usage examples"
* -# Expanding MeteoIO
* -# How to \subpage dev_plugins "write a Plugin"
* -# How to \subpage dev_filters "write a Filter"
*/
/**
......@@ -224,8 +227,8 @@
* //writing some data out in order to prove that it really worked!
* for (unsigned int ii=0; ii < vecMeteo.size(); ii++) {
* std::cout << "---------- Station: " << (ii+1) << " / " << vecStation.size() << std::endl;
* std::cout << vecStation[ii].toString() << std::endl;
* std::cout << vecMeteo[ii].toString() << std::endl;
* std::cout << vecStation[ii] << std::endl;
* std::cout << vecMeteo[ii] << std::endl;
* }
*
* delete io;
......@@ -272,22 +275,14 @@
* void spatial_interpolations(IOHandler& io, DEMObject& dem, std::vector<MeteoData>& vecMeteo,
* std::vector<StationData>& vecStation);
* {
* Grid2DObject p(dem.ncols, dem.nrows, dem.xllcorner, dem.yllcorner, dem.latitude, dem.longitude, dem.cellsize);
* Grid2DObject hnw(dem.ncols, dem.nrows, dem.xllcorner, dem.yllcorner, dem.latitude, dem.longitude, dem.cellsize);
* Grid2DObject vw(dem.ncols, dem.nrows, dem.xllcorner, dem.yllcorner, dem.latitude, dem.longitude, dem.cellsize);
* Grid2DObject rh(dem.ncols, dem.nrows, dem.xllcorner, dem.yllcorner, dem.latitude, dem.longitude, dem.cellsize);
* Grid2DObject ta(dem.ncols, dem.nrows, dem.xllcorner, dem.yllcorner, dem.latitude, dem.longitude, dem.cellsize);
* Grid2DObject ta;
* Meteo2DInterpolator mi(dem, vecMeteo, vecStation);
*
* mi.interpolate(hnw, rh, ta, vw, p);
*
* std::cout << "Writing the Grids to *.2d files" << std::endl;
* io->write2DGrid(ta, "output/ta.2d");
* io->write2DGrid(p, "output/p.2d");
* io->write2DGrid(vw, "output/vw.2d");
* io->write2DGrid(nswc, "output/nswc.2d");
* io->write2DGrid(rh, "output/rh.2d");
* mi.interpolate(MeteoData::TA, ta);
*
* std::cout << "Writing the Grids to files" << std::endl;
* io->write2DGrid(ta, "ta_2d.asc");
*
* }
* \endcode
*/
......
......@@ -31,7 +31,7 @@ PROJECT_NAME = MeteoIODoc
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 0.9
PROJECT_NUMBER = MeteoIODoc-1.0-β
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
......
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