Skip to main content

CODEM: Multi-Modal Digital Elevation Model Registration

Registered Mesh

Overview

CODEM is a testbed application for registering a 3D model of an area of interest (AOI) to a larger 3D Foundation data source. Point cloud, mesh, and raster digital surface model (DSM) data types are supported. Format support is limited to the following:

  • Point Cloud: LAS, LAZ, BPF
  • Mesh: PLY, OBJ
  • DSM: GeoTIFF

CODEM follows the following basic steps to perform co-registration:

  1. Generation of normalized DSMs from the AOI and Foundation data sources.
  2. Coarse registration via matching of features extracted from the DSMs.
  3. Fine registration via an iterative closest point (ICP) algorithm.
  4. Application of the solved registration transformation to the AOI data in its original type and format.

Installing CODEM

  1. Clone the repo:

    git clone https://github.com/NCALM-UH/CODEM
    
  2. Create and activate a Conda environment containing the required dependencies. From inside the CODEM directory:

    conda env create --file environment.yml
    
    conda activate codem
    
  3. Install CODEM. From the project directory.

    pip install .
    

CoRegistration

Running CODEM

The CODEM application has two required positional arguments and numerous options. The required positional arguments are the file path to the Foundation data file and the file path to the AOI data file. Executing codem on the command line has the following form:

codem <foundation_file_path> <aoi_file_path> [-opt option_value]

For example, running CODEM on some of the sample data files in the demo directory looks like:

codem demo/Foundation-PointCloud.laz demo/AOI-Mesh.ply

Optional arguments can be placed before or after the positional arguments. For example, we can set the minimum registration pipeline resolution to a new value (default value = 1.0):

codem demo/Foundation-PointCloud.laz demo/AOI-Mesh.ply --min_resolution 2.0

A summary of all options and their default values is given in the docs/configuration.md document. The default option values should be sufficient for most landscapes.

CODEM Generated Output

All output is saved to a new directory that is created at the location of the AOI file. The directory name is tagged with the date and time of execution: registration_YYYY-MM-DD_HH-MM-SS. The directory contents include the following:

  1. Registered AOI Data File: The registered AOI file will be of the same data type and file format as the original AOI file and will have the same name with term "_registered" appended to end of the name.
  2. config.yml: A record of the parameters used in the registration.
  3. log.txt: A log file.
  4. registration.txt: Contains the solved coarse and fine registration transformation parameters and a few statistics.
  5. dsm_feature_matches.png: An image of the matched features used in the coarse registration step.

Vertical Change Detection

Running VCD

In addition to the coregistration functionality, codem provides vertical change detection functionality as well based on LiDAR scans.

vcd <before_file_path> <after_file_path> [-opt option_value]

VCD Generated Output

Raster, Mesh and Point cloud outputs are generated (inclyding ESRI 3D Shapefiles) to highlight ground/not-ground features, and vertical changes.

Additional Information

Information on available configuration options, a more in-depth review of how CODEM works, and a simple example utilizing data files contained in the demo directory of this repository are found in the docs directory:

Contact

  • Ognyan Moore - Hobu Inc. - Email
  • Preston Hartzell - University of Houston - Email
  • Jesse Shanahan - formerly of Booz Allen Hamilton (listed for software development credit attribution) - LinkedIn

Metadata

Release files for codem 0.26.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for codem 0.26.2
File Size Uploaded
codem-0.26.2.tar.gz 47.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for codem 0.26.2
File Interpreter ABI Platform
codem-0.26.2-py3-none-any.whl Python 3 none any Details

Total release size: 97.9 kB

Release files / codem-0.26.2.tar.gz

Download URL codem-0.26.2.tar.gz
Size 47.7 kB
Tags Source
SHA-256 checksum
How to use checksums
75ec628c0073c12f8f9fbe10c4c9f1b85facb1238decc1a9c984559f4478d66a
BLAKE2b-256 checksum
How to use checksums
1aa8b22a93497b7a43012d60327d07bcedeec4f59d639bb97fe30c45ec6131b6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Release files / codem-0.26.2-py3-none-any.whl

Download URL codem-0.26.2-py3-none-any.whl
Size 50.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2ca7355267891e3ad62cff8ad6a268e3a48a4947480a635c2821aba7ef628bfc
BLAKE2b-256 checksum
How to use checksums
63d16acbf46917bcff862896a6a4006a374dd5ded2a7ff9833349871e8851d09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page