Skip to content

Commit

Permalink
Merge branch 'fix_documentation' into 'master'
Browse files Browse the repository at this point in the history
Fix documentation conflicts between Datafalk contribution and Cars config refactoring

See merge request 3d/cars-park/cars!756
  • Loading branch information
dyoussef committed Oct 18, 2024
2 parents f1d97ce + bf0da20 commit 463f8b4
Show file tree
Hide file tree
Showing 9 changed files with 258 additions and 277 deletions.
4 changes: 2 additions & 2 deletions docs/source/exploring_the_field/3d_products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
===========

| CARS produces a geotiff file named ``dsm.tif`` that contains the Digital Surface Model in the required cartographic projection and the ground sampling distance defined by the user.
| If the user provides an additional input image, an ortho-image ``clr.tif`` is also produced. The latter is stackable to the DSM (See :ref:`getting_started`).
| If the user provides an additional input image, an ortho-image ``color.tif`` is also produced. The latter is stackable to the DSM (See :ref:`getting_started`).
| If the user saves points clouds as `laz format <https://docs.fileformat.com/fr/gis/laz/>`_ (point_cloud_fusion, point_cloud_outliers_removing, point_cloud_rasterization), the points clouds are saved in laz compressed format with colors or graylevel image.
These two products can be visualized with `QGIS <https://www.qgis.org/fr/site/>`_ for example.
Expand All @@ -19,5 +19,5 @@ These two products can be visualized with `QGIS <https://www.qgis.org/fr/site/>`
+--------------+-------------+-------------+-------------------+
| dsm.tif | color.tif | `QGIS`_ Mix | cloudcompare |
+--------------+-------------+-------------+-------------------+
| |dsm| | |color| | |dsmclr| | |pc| |
| |dsm| | |color| | |dsmclr| | |pc| |
+--------------+-------------+-------------+-------------------+
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ Generate a DSM step by step
| The color of the pixels (grayscale) in the image :ref:`below<matching>` corresponds to the shift value. Some pixels do not have a match, which are represented as transparent pixels in the image. These matching errors can occur due to various reasons such as moving objects, shadows, occlusions, or areas with insufficient texture.
| The transparent pixels indicate areas where the matching algorithm couldn't find a reliable correspondence between the two images, highlighting regions of uncertainty in the matching process.

.. _matching:

+--------------------------+---------------------------------------------+
Expand Down Expand Up @@ -116,8 +115,6 @@ Initial Input Digital Elevation Model
For now, CARS uses an initial input Digital Elevation Model (:term:`DEM`) which is integrated in the stereo-rectification to minimize the disparity intervals to explore.
Any geotiff file can be used.

For example, the `SRTM <https://www2.jpl.nasa.gov/srtm/>`_ data corresponding to the processed zone can be used through `otbcli_DownloadSRTMTiles <https://www.orfeo-toolbox.org/CookBook-7.4/Applications/app_DownloadSRTMTiles.html>`_.

The parameter is ``initial_elevation`` as seen in :ref:`configuration`.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ Mask and Classification Usage
=============================

| Photogrammetry is a technique that cannot reproduce altitude on water. This technique also has difficulties for moving elements or in shaded areas.
| For this reason, it is possible to mask out areas or apply ad hoc processing to aid the matching stage (see :ref:`mask_and_classification_usage`).
| For this reason, it is possible to mask out areas or apply ad hoc processing to aid the matching stage.
.. _mask_and_classification_usage:
Masks
-----

Expand All @@ -23,4 +22,4 @@ Classification
| Please, see the section :ref:`convert_image_to_binary_image` to make a multiband binary image with 1 bit per band.
| All non-zeros values of the classification image will be considered as invalid data.
| The classification can be used in each application by band name list selection parameter. See application ``classification`` parameter :ref:`configuration`.
| The classification can be used in each application by band name list selection parameter. See application ``classification`` parameter :ref:`configuration`.
1 change: 0 additions & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Getting Started
# Build the Docker image
docker build -t cars:latest .
* Get and extract data samples from CARS repository:

.. code-block:: console
Expand Down
6 changes: 1 addition & 5 deletions docs/source/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,8 @@ It can be recommended to apply a P+XS pansharpening with `OTB`_.
.. _`OTB`: https://www.orfeo-toolbox.org/CookBook-8.0/C++/UserGuide.html#image-data-representation


Convert RGB image to panchromatic image
--------------------------------------
---------------------------------------

CARS only uses panchromatic images for processing.

Expand All @@ -138,8 +137,6 @@ The line below use `"Grayscale Using Luminance" <https://en.wikipedia.org/wiki/G
otbcli_BandMath -il image.tif -out image_panchromatic.tif -exp "(0.2126 * im1b1 + 0.7152 * im1b2 + 0.0722 * im1b3)"
.. _make_a_water_mask:

Make a water mask
Expand Down Expand Up @@ -191,7 +188,6 @@ Merge Laz files
---------------

CARS generates several `laz files <https://docs.fileformat.com/gis/laz/>`_ corresponding to the tiles processed.
Merge can be done with `laszip`_.

To merge them:

Expand Down
8 changes: 5 additions & 3 deletions docs/source/software_design/plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Geometry plugin
^^^^^^^^^^^^^^^^^

Geometry plugins aim to enable the use of different geometry libraries, typically `libGEO <https://github.com/OSGeo/libgeotiff>`_ or `Shareloc <https://github.com/CNES/shareloc>`_ to perform CARS geometric operations which require the interpretation of the geometric models of the pairs to process.
Those operation are:

Those operations are:

* The epipolar grids computation
* The direct localization operation
Expand Down Expand Up @@ -45,9 +46,10 @@ For example, if the AbstractGeometry object is defined in file `cars_geometry_pl
Mandatory methods
++++++++++++++++++

Currently, the `AbstractGeometry` class requires the implementation of the following mandatory methods and properties:

* `conf_schema` which specify the user inputs json schema required by the geometric library.
* `conf_schema` which specify the user input json schema required by the geometric library.

.. code-block:: python
Expand Down Expand Up @@ -170,4 +172,4 @@ Available methods
Some methods are available in the `AbstractGeometry` class that might be useful for any geometry plugin which would only perform the triangulation using sensor coordinates.
CARS' API only provides as inputs of the geometry plugin triangulation method the epipolar coordinates for each image of the pair. Thus the `matches_to_sensor_coords` method enables any plugin to convert those coordinates into the corresponding sensor ones.

`AbstractGeometry` implements the method `image_envelope`. It computes the ground footprint of an image in sensor geometry by projecting its four corners using the direct localization method. This method can be overloaded by any geometry plugin if necessary.
`AbstractGeometry` implements the method `image_envelope`. It computes the ground footprint of an image in sensor geometry by projecting its four corners using the direct localization method. This method can be overloaded by any geometry plugin if necessary.
Loading

0 comments on commit 463f8b4

Please sign in to comment.