Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
f-PLT committed May 2, 2024
1 parent 44fa297 commit 1714071
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
8 changes: 7 additions & 1 deletion scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,10 @@ This folder is dedicated to scripts, whether python, bash or sbatch.
Generally, scripts are more for standalone processes while figuring them out.

Once a script is more mature, it should be generalized and integrated into the package
itself.
itself.

## Scripts

| Scripts | Description |
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `resample_tiff_raster.py` | Script to resample a target tiff image, so it matches a source image's grid size and area. Resampling strategy is using a Nearest Neighbor algorythm to keep original values. <br/><br/>Use the scripts CLI for more information : `python3 resample_tiff_raster.py --help` |
6 changes: 3 additions & 3 deletions scripts/resample_tiff_raster.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
PROJECT_DATA_DIR = pathlib.Path(os.getenv("BASE_DATA_PATH", DATA_DIR))


def get_source_information(source_image):
def get_source_information(source_image: pathlib.Path):
with rasterio.open(source_image) as source:
# Save a lot of the information that is needed, so ortho image can be closed and
# we can save space
# Save a lot of the information that is needed, so ortho image can be closed, and
# we can save memory use
source_transform = source.transform
source_crs = source.crs
source_height = source.height
Expand Down

0 comments on commit 1714071

Please sign in to comment.