Welcome to demcompare documentation!

Demcompare is a python software that aims at comparing two DEMs together.

Demcompare has several benefits:

• Works whether or not the two DEMs share common format projection system, planimetric resolution, and altimetric unit.

• Performs the coregistration based on the Nuth & Kääb universal coregistration method.

• Computes the statistics on an input DEM, or on the difference of two input DEMs.

• Provides a wide variety of standard metrics and allows one to classify the DEMs to obtain statistics by class.

A comparison report can be compiled as html or pdf documentation with statistics printed as tables and plots.

Contents:

• Getting started
  • Install
  • Command line execution
• User guide
  • Execution from the command line
  • Input DEM
    • Basic input DEMs configuration
    • Geoid reference
    • ROI
    • Altimetric unit
    • Nodata
    • Input DEMs configuration
    • Output configuration
  • Coregistration
    • Introduction
      • i) Reprojection
      • ii) Offsets estimation
      • iii) Shift of the input_sec DEM from x and y planimetric offsets
      • Schematic overview
    • Detailed parameters
      • Sampling source
      • Initial shift
      • Number of iterations
      • Coregistration analysis
    • Full list of parameters
      • Scientific parameters
      • I/O parameters
    • References
  • Statistics
    • DEM processing methods
      • Stats computation
    • Metrics
      • Hillshade and sky-view factor representations
      • Quality measures
    • Classification layers
      • The modes
      • Metric selection
    • Statistics parameters
    • Statistics outputs
      • Output files and their required parameters
      • Output directories
  • Generated output report
    • Sphinx report
  • Notebook execution
    • Execution from the example notebooks
• Developer guide
  • Contributing guide
    • Bug report
    • Contributing workflow
    • Licensing
    • Merge request acceptation process
  • Developer Install
    • Sample execution from source
  • Coding guide: Quality, Tests, Documentation, Pre-commit
    • General rules
    • Code quality
      • Isort
      • Black
      • Flake8
      • Pylint
      • Mypy
    • Tests
    • Documentation
    • Pre-commit validation
  • Demcompare architecture
    • Demcompare high level description
    • Demcompare CLI
    • Demcompare pipeline module
      • Coregistration step orchestration
      • Statistics step orchestration
    • Dem Tools modules
      • Dem_tools module
      • Dataset_tools module
      • Img_tools module
    • Coregistration module
      • Coregistration step architecture
    • DEM processing module
    • Stats module
      • Statistics step architecture
    • Report module
  • Development tutorials
    • New coregistration class implementation
    • New metric implementation
      • Basic metric structure and functions
      • Advanced metric functions
    • New DEM processing method implementation
      • Basic DEM processing method structure and functions
• API Reference
  • demcompare
    • Subpackages
      • demcompare.classification_layer
      • demcompare.coregistration
      • demcompare.dem_processing
      • demcompare.metric
    • Submodules
      • demcompare.dataset_tools
      • demcompare.dem_tools
      • demcompare.demcompare
      • demcompare.demcompare_tiles
      • demcompare.helpers_init
      • demcompare.img_tools
      • demcompare.internal_typing
      • demcompare.log_conf
      • demcompare.report
      • demcompare.sphinx_project_generator
      • demcompare.stats_dataset
      • demcompare.stats_processing
      • demcompare.transformation
    • Attributes
    • Functions
    • Package Contents
      • __version__
      • __author__
      • __email__
      • run()
      • load_input_dems()
      • run_coregistration()
• Frequently Asked Questions
  • Installation troubleshooting
  • Data Dimension Management
• Glossary

Related:

• CARS, CNES 3D reconstruction software