Skip to content

Commit 173ff14

Browse files
author
nils-hamel
committed
Revision of the doxygen documentation main pages
1 parent 9b0d004 commit 173ff14

File tree

5 files changed

+191
-193
lines changed

5 files changed

+191
-193
lines changed

lib/libcommon/src/common.h

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -30,62 +30,62 @@
3030
*
3131
* The _eratosthene-suite_ offers a front-end to the eratosthene indexation
3232
* server implemented in the _liberatosthene_ library. It consists in a
33-
* softwares suite offering front-end solutions to the functionalities of
33+
* software suite offering front-end solutions to the functionalities of
3434
* the eratosthene library.
3535
*
36-
* The principal software implements the server itself allowing to simply
37-
* create server instances and to maintain services. The suite also offers
38-
* a front-end software for the data injection in the available servers. It
39-
* also offers a graphical 4D solution allowing to browse the 4D earth
40-
* model offered by the available servers.
41-
*
42-
* In addition to the server, client data injection and the 4D graphical
43-
* client softwares, the suite also provides a tools allowing to massively
44-
* query 4D earth cells, following the _liberatosthene_ indexation
45-
* formalism, to build large 3D-raster datasets. Such datasets can be used
46-
* to train and validate machine learning algorithms working on 3D/4D
47-
* geographic information.
36+
* The principal software implements the server itself, allowing to simply
37+
* create server instances and to maintain network services. The suite also
38+
* offers a front-end software for the data injection in server instances.
39+
* It also offers a graphical 4D solution allowing to browse the 4D model
40+
* of Earth offered by servers.
4841
*
4942
* \section project Eratosthene Project
5043
*
51-
* The Eratosthene Project was initially imagined to answer the question of
52-
* very large point-based models of cities and environments. Indeed,
53-
* mapping a whole city at the level of the centimetre induces very large
44+
* The Eratosthene Project was initially designed to address the challenge
45+
* of very large point-based models of cities and environments. Indeed,
46+
* mapping a whole city at the level of the centimeter induces very large
5447
* and heavy models that are difficult to manipulate, explore and exploit.
5548
* Moreover, considering the time dimension implies a quick increase of the
5649
* size of the models, making them impossible to handle as a single and
5750
* monolithic object.
5851
*
59-
* The Eratosthene Project is designed to answer this question by
60-
* implementing an space-time indexation formalism able to handle, store
61-
* and access very large 4D models of cities and environments. The
62-
* indexation formalism is used to implement a server able to manage, store
63-
* and broadcast very large 4D models distributed all over the earth
64-
* surface and covering large period of time. In addition to the server,
65-
* the Eratosthene Project also implements a graphical client able to
66-
* communicate with the server and to offer a convenient way of browsing
67-
* the models in both space and time.
68-
52+
* The Eratosthene Project is designed to provide a solution by considering
53+
* a space-time indexation formalism. This indexation formalism is used to
54+
* implement a server able to manage, store and broadcast over the network
55+
* very large 4D models distributed all over the earth surface and covering
56+
* large periods of time. In addition to the server, the Eratosthene
57+
* Project also implements a graphical client able to communicate with the
58+
* remote servers to offer a convenient way to browse the models in both
59+
* space and time.
60+
*
6961
* The space-time indexation formalism is designed to efficiently manage
70-
* the storage of the incoming 4D models and to offer and simple and
71-
* efficient ways of addressing queries to the server allowing models
62+
* the storage of the incoming 4D models and to offer a simple and
63+
* efficient way of addressing queries to the server to allow models
7264
* broadcasting. The space-time indexation also allows to perform queries
73-
* to the server in a intuitive way giving the possibility to both address
74-
* the questions of the earth structures level of detail and time
65+
* to the server in an intuitive way giving the possibility to both address
66+
* the challenge of the earth structures level of details and time
7567
* management. This allows to explore the entire earth surface in terms of
7668
* 4D structures from large mountain chains in 2000 to very small details
7769
* of cities in 1850.
7870
*
7971
* The subsequent indexation formalism used to drive the storage and access
8072
* of the data also naturally brings a standardised discretisation of space
81-
* and time. Models injected in the information system are then
82-
* standardised from both spatial and temporal point of view. This allows
83-
* the implementation of binary and logical operators when considering a
84-
* model at two different times. The operators allows to deduce a third
85-
* model providing a differential point of view of the two models separated
86-
* in time. The evolution of cities and environments can be enhanced and
87-
* analysed in an efficient way, opening the way to more advanced
88-
* geographic services.
73+
* and time. Point-based models injected in the Eratosthene information
74+
* system are then standardised from both spatial and temporal point of
75+
* views. This allows the implementation of binary and logical operators
76+
* when considering a model at two different times. The operators allow to
77+
* deduce a third model on the fly providing a differential point of view
78+
* of the two models separated in time. The evolution of cities and
79+
* environments can be enhanced and analysed in an efficient way, opening
80+
* the way to more advanced geographic services.
81+
*
82+
* The ability of indexation formalism to consider polygonal models in
83+
* addition to large scale point-based models allows to enhance the
84+
* possibilities in terms of 4D geographic services. More than the
85+
* possibility to automatically manage the polygonal models level of
86+
* details and large scale display, the indexation formalism also allows
87+
* compositions on the fly of mixed models allowing to compare different
88+
* type of models, from lidar point-based models to land registers.
8989
*
9090
* \section license Copyright and License
9191
*
@@ -94,7 +94,6 @@
9494
*
9595
* This program is licensed under the terms of the GNU GPLv3.
9696
*/
97-
9897
/*
9998
header - inclusion guard
10099
*/

src/eratosthene-address/src/eratosthene-address.h

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -30,62 +30,62 @@
3030
*
3131
* The _eratosthene-suite_ offers a front-end to the eratosthene indexation
3232
* server implemented in the _liberatosthene_ library. It consists in a
33-
* softwares suite offering front-end solutions to the functionalities of
33+
* software suite offering front-end solutions to the functionalities of
3434
* the eratosthene library.
3535
*
36-
* The principal software implements the server itself allowing to simply
37-
* create server instances and to maintain services. The suite also offers
38-
* a front-end software for the data injection in the available servers. It
39-
* also offers a graphical 4D solution allowing to browse the 4D earth
40-
* model offered by the available servers.
41-
*
42-
* In addition to the server, client data injection and the 4D graphical
43-
* client softwares, the suite also provides a tools allowing to massively
44-
* query 4D earth cells, following the _liberatosthene_ indexation
45-
* formalism, to build large 3D-raster datasets. Such datasets can be used
46-
* to train and validate machine learning algorithms working on 3D/4D
47-
* geographic information.
36+
* The principal software implements the server itself, allowing to simply
37+
* create server instances and to maintain network services. The suite also
38+
* offers a front-end software for the data injection in server instances.
39+
* It also offers a graphical 4D solution allowing to browse the 4D model
40+
* of Earth offered by servers.
4841
*
4942
* \section project Eratosthene Project
5043
*
51-
* The Eratosthene Project was initially imagined to answer the question of
52-
* very large point-based models of cities and environments. Indeed,
53-
* mapping a whole city at the level of the centimetre induces very large
44+
* The Eratosthene Project was initially designed to address the challenge
45+
* of very large point-based models of cities and environments. Indeed,
46+
* mapping a whole city at the level of the centimeter induces very large
5447
* and heavy models that are difficult to manipulate, explore and exploit.
5548
* Moreover, considering the time dimension implies a quick increase of the
5649
* size of the models, making them impossible to handle as a single and
5750
* monolithic object.
5851
*
59-
* The Eratosthene Project is designed to answer this question by
60-
* implementing an space-time indexation formalism able to handle, store
61-
* and access very large 4D models of cities and environments. The
62-
* indexation formalism is used to implement a server able to manage, store
63-
* and broadcast very large 4D models distributed all over the earth
64-
* surface and covering large period of time. In addition to the server,
65-
* the Eratosthene Project also implements a graphical client able to
66-
* communicate with the server and to offer a convenient way of browsing
67-
* the models in both space and time.
68-
52+
* The Eratosthene Project is designed to provide a solution by considering
53+
* a space-time indexation formalism. This indexation formalism is used to
54+
* implement a server able to manage, store and broadcast over the network
55+
* very large 4D models distributed all over the earth surface and covering
56+
* large periods of time. In addition to the server, the Eratosthene
57+
* Project also implements a graphical client able to communicate with the
58+
* remote servers to offer a convenient way to browse the models in both
59+
* space and time.
60+
*
6961
* The space-time indexation formalism is designed to efficiently manage
70-
* the storage of the incoming 4D models and to offer and simple and
71-
* efficient ways of addressing queries to the server allowing models
62+
* the storage of the incoming 4D models and to offer a simple and
63+
* efficient way of addressing queries to the server to allow models
7264
* broadcasting. The space-time indexation also allows to perform queries
73-
* to the server in a intuitive way giving the possibility to both address
74-
* the questions of the earth structures level of detail and time
65+
* to the server in an intuitive way giving the possibility to both address
66+
* the challenge of the earth structures level of details and time
7567
* management. This allows to explore the entire earth surface in terms of
7668
* 4D structures from large mountain chains in 2000 to very small details
7769
* of cities in 1850.
7870
*
7971
* The subsequent indexation formalism used to drive the storage and access
8072
* of the data also naturally brings a standardised discretisation of space
81-
* and time. Models injected in the information system are then
82-
* standardised from both spatial and temporal point of view. This allows
83-
* the implementation of binary and logical operators when considering a
84-
* model at two different times. The operators allows to deduce a third
85-
* model providing a differential point of view of the two models separated
86-
* in time. The evolution of cities and environments can be enhanced and
87-
* analysed in an efficient way, opening the way to more advanced
88-
* geographic services.
73+
* and time. Point-based models injected in the Eratosthene information
74+
* system are then standardised from both spatial and temporal point of
75+
* views. This allows the implementation of binary and logical operators
76+
* when considering a model at two different times. The operators allow to
77+
* deduce a third model on the fly providing a differential point of view
78+
* of the two models separated in time. The evolution of cities and
79+
* environments can be enhanced and analysed in an efficient way, opening
80+
* the way to more advanced geographic services.
81+
*
82+
* The ability of indexation formalism to consider polygonal models in
83+
* addition to large scale point-based models allows to enhance the
84+
* possibilities in terms of 4D geographic services. More than the
85+
* possibility to automatically manage the polygonal models level of
86+
* details and large scale display, the indexation formalism also allows
87+
* compositions on the fly of mixed models allowing to compare different
88+
* type of models, from lidar point-based models to land registers.
8989
*
9090
* \section license Copyright and License
9191
*
@@ -95,7 +95,6 @@
9595
* This program is licensed under the terms of the GNU GPLv3.
9696
*/
9797

98-
9998
/*
10099
header - inclusion guard
101100
*/

src/eratosthene-client/src/eratosthene-client.h

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -30,62 +30,62 @@
3030
*
3131
* The _eratosthene-suite_ offers a front-end to the eratosthene indexation
3232
* server implemented in the _liberatosthene_ library. It consists in a
33-
* softwares suite offering front-end solutions to the functionalities of
33+
* software suite offering front-end solutions to the functionalities of
3434
* the eratosthene library.
3535
*
36-
* The principal software implements the server itself allowing to simply
37-
* create server instances and to maintain services. The suite also offers
38-
* a front-end software for the data injection in the available servers. It
39-
* also offers a graphical 4D solution allowing to browse the 4D Earth
40-
* model offered by the available servers.
41-
*
42-
* In addition to the server, client data injection and the 4D graphical
43-
* client softwares, the suite also provides a tools allowing to massively
44-
* query 4D Earth cells, following the _liberatosthene_ indexation
45-
* formalism, to build large 3D-raster datasets. Such datasets can be used
46-
* to train and validate machine learning algorithms working on 3D/4D
47-
* geographic information.
36+
* The principal software implements the server itself, allowing to simply
37+
* create server instances and to maintain network services. The suite also
38+
* offers a front-end software for the data injection in server instances.
39+
* It also offers a graphical 4D solution allowing to browse the 4D model
40+
* of Earth offered by servers.
4841
*
4942
* \section project Eratosthene Project
5043
*
51-
* The Eratosthene Project was initially imagined to answer the question of
52-
* very large point-based models of cities and environments. Indeed,
53-
* mapping a whole city at the level of the centimetre induces very large
44+
* The Eratosthene Project was initially designed to address the challenge
45+
* of very large point-based models of cities and environments. Indeed,
46+
* mapping a whole city at the level of the centimeter induces very large
5447
* and heavy models that are difficult to manipulate, explore and exploit.
5548
* Moreover, considering the time dimension implies a quick increase of the
5649
* size of the models, making them impossible to handle as a single and
5750
* monolithic object.
5851
*
59-
* The Eratosthene Project is designed to answer this question by
60-
* implementing an space-time indexation formalism able to handle, store
61-
* and access very large 4D models of cities and environments. The
62-
* indexation formalism is used to implement a server able to manage, store
63-
* and broadcast very large 4D models distributed all over the Earth
64-
* surface and covering large period of time. In addition to the server,
65-
* the Eratosthene Project also implements a graphical client able to
66-
* communicate with the server and to offer a convenient way of browsing
67-
* the models in both space and time.
68-
52+
* The Eratosthene Project is designed to provide a solution by considering
53+
* a space-time indexation formalism. This indexation formalism is used to
54+
* implement a server able to manage, store and broadcast over the network
55+
* very large 4D models distributed all over the earth surface and covering
56+
* large periods of time. In addition to the server, the Eratosthene
57+
* Project also implements a graphical client able to communicate with the
58+
* remote servers to offer a convenient way to browse the models in both
59+
* space and time.
60+
*
6961
* The space-time indexation formalism is designed to efficiently manage
70-
* the storage of the incoming 4D models and to offer and simple and
71-
* efficient ways of addressing queries to the server allowing models
62+
* the storage of the incoming 4D models and to offer a simple and
63+
* efficient way of addressing queries to the server to allow models
7264
* broadcasting. The space-time indexation also allows to perform queries
73-
* to the server in a intuitive way giving the possibility to both address
74-
* the questions of the Earth structures level of detail and time
75-
* management. This allows to explore the entire Earth surface in terms of
65+
* to the server in an intuitive way giving the possibility to both address
66+
* the challenge of the earth structures level of details and time
67+
* management. This allows to explore the entire earth surface in terms of
7668
* 4D structures from large mountain chains in 2000 to very small details
7769
* of cities in 1850.
7870
*
7971
* The subsequent indexation formalism used to drive the storage and access
8072
* of the data also naturally brings a standardised discretisation of space
81-
* and time. Models injected in the information system are then
82-
* standardised from both spatial and temporal point of view. This allows
83-
* the implementation of binary and logical operators when considering a
84-
* model at two different times. The operators allows to deduce a third
85-
* model providing a differential point of view of the two models separated
86-
* in time. The evolution of cities and environments can be enhanced and
87-
* analysed in an efficient way, opening the way to more advanced
88-
* geographic services.
73+
* and time. Point-based models injected in the Eratosthene information
74+
* system are then standardised from both spatial and temporal point of
75+
* views. This allows the implementation of binary and logical operators
76+
* when considering a model at two different times. The operators allow to
77+
* deduce a third model on the fly providing a differential point of view
78+
* of the two models separated in time. The evolution of cities and
79+
* environments can be enhanced and analysed in an efficient way, opening
80+
* the way to more advanced geographic services.
81+
*
82+
* The ability of indexation formalism to consider polygonal models in
83+
* addition to large scale point-based models allows to enhance the
84+
* possibilities in terms of 4D geographic services. More than the
85+
* possibility to automatically manage the polygonal models level of
86+
* details and large scale display, the indexation formalism also allows
87+
* compositions on the fly of mixed models allowing to compare different
88+
* type of models, from lidar point-based models to land registers.
8989
*
9090
* \section license Copyright and License
9191
*

0 commit comments

Comments
 (0)