Classification of Sub-aquatic Height Extracted Photons
Project description
C-SHELPh V2
C-SHELPh is the Classification of Sub-aquatic Height Extracted Photons. It is designed to isolate bathymetric photons in ICESat2 ATL03 files.
Installation
It is recommended that the dependancies are installed via:
conda install -c conda-forge geopandas utm numpy matplotlib s3fs xarray zarr pyproj proj-data h5py earthaccess h5netcdf dask tqdm
pip install cshelph
Using C-SHELPh
This software is accompanied by two run scripts:
- run_bathymetry_extraction.ipynb: A notebook designed to process single tracks to gain familiarity with the software
- run_bathy_extraction.py: Automated runs of c-shelph for mass processing
A simple use of C-SHELPh is:
python run_bathy_extraction.py -i icesat2_atl03_file.h5 -l 1 -th 20
where:
-i: the input ICESat2 ATL03 h5 file
-l: laser number (1-3)
-th: density threshold value (percentile; 0-100) which is used to change the sensitivity of the photon classification to noise
Additional options can be specifed to customize runs and override defaults (which are based on some underlying assumptions)
FAQs
Why does C-SHELPh classify my water surface as bathy?
C-SHELPh performs an orthometric correction that models the water surface at approximately 0m elevation in reference to the EGM2008 geoid. In some locations this is not true and so C-SHELPh gets confused and thresholds set in the code to help C-SHELPh find the water surface are not sufficient. Thresholds can be passed in as arguments.
Why isn't C-SHELPh detecting my bathy points
C-SHELPh classifies photons based on photon density. In cases where the noise is higher than the signal (e.g., a small quantity of steep/deep and/or turbid waters) C-SHELph struggles to perform well. Optimum conditions for C-SHELPh are clear shallow waters.
Additional notes
Note: The refraction correction currently uses photon level metrics (photon azimuth, photon elevation, satellite elev) to get an as accurate bathymetric model as possible. This requires some assuptions about the spacecraft orbit (its vertical movements are a constant rate thus linear interpolation holds true) and geometry and radius of the Earth. Ultimately, the advantages of increased precision of this implementation are believed to outweigh uncertainty introduced by the assumption. The refraction correction follows that outlined by the excellent Parrish et al., 2019 publication: https://www.mdpi.com/2072-4292/11/14/1634
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cshelph-2.9.0.tar.gz
(12.6 kB
view details)
Built Distribution
cshelph-2.9.0-py3-none-any.whl
(18.4 kB
view details)
File details
Details for the file cshelph-2.9.0.tar.gz
.
File metadata
- Download URL: cshelph-2.9.0.tar.gz
- Upload date:
- Size: 12.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66b9bf282b0b1e303bbc5648b6927e33e123939ec2785ba4519864c167c392cc |
|
MD5 | 654d0fe458c74d56bd9f559b180e5bce |
|
BLAKE2b-256 | d71caa4fde77992f5fb0c16df24243e9296f43808ba5d9832fb733d6c196ec89 |
File details
Details for the file cshelph-2.9.0-py3-none-any.whl
.
File metadata
- Download URL: cshelph-2.9.0-py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4957369fa4ceac16870682395d0e0170c15027d39b529d605f073581e0012f3f |
|
MD5 | 9cb5cbc1d668b410c290cfd4afa00290 |
|
BLAKE2b-256 | 641725be2cbe3eb0ae607612719403db4c4e1830d392f5fcc8de47c107d933b1 |