Skip to content

Commit 0751f89

Browse files
authored
Update README.md
1 parent 5c42f5e commit 0751f89

1 file changed

Lines changed: 67 additions & 3 deletions

File tree

README.md

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
Tool to perform various corrections on imagery from supported sensors, including Sentera 6X, Sentera Double 4K and DJI Mavic 3 Multispectral.
33

44

5-
#### GUI Usage
65
<p align="center"><img width="602" height="532" alt="image" src="https://github.com/user-attachments/assets/acd53b21-6dfd-4f37-a6e3-269c3bc2a764" /></p>
76

87
The Sentera Radiometric Corrections tool will perform corrections on multispectral drone imagery as well as recflectance corrections when a supported Sentera calibration panel is used.
@@ -19,12 +18,77 @@ The Sentera Radiometric Corrections tool will perform corrections on multispectr
1918
##### Advanced Inputs/Parameters
2019
- ExifTool Path: Optionally provide an updated/custom version of exiftool. If not provided the default version is included in the tool.
2120
- Calibration ID: For Sentera sensors, calibration images are tagged with "CAL". Optionally provide a different tag if the image names have been modified. For non-Sentera sensors all images are scanned for calibration panels.
22-
- Use all panel sets(6X): By default only the best calibration set will be used to perform corrections for Sentera sensors. Select this option to perform corrections using all available calibration panel captures.
21+
- Use All Panel Sets(6X): By default only the best calibration set will be used to perform corrections for Sentera sensors. Select this option to perform corrections using all available calibration panel captures.
2322
- Delete/Overwrite Original Images: Select this option and set the input and output paths to match to overwrite the original images with the corrected images. Not reccomended as original images cannot be restored.
24-
- Output as uint16(0-65535): By default corrected images are formated in Float32 with values in reflectance ranging from 0-1. Selecting this option will output the corrected images in Uint16 with values ranging from 0-65535. This may be required for certain photogrametry software and corrected images will have a much smaller file size.
23+
- Output as UInt16(0-65535): By default corrected images are formated in Float32 with values in reflectance ranging from 0-1. Selecting this option will output the corrected images in Uint16 with values ranging from 0-65535. This may be required for certain photogrametry software and corrected images will have a much smaller file size.
2524

2625

2726

27+
## Installation instructions for usage/development in Python
28+
29+
#### Windows (Conda)
30+
31+
1) Download [Miniconda](https://docs.conda.io/en/latest/miniconda.html) for Python3.7
32+
33+
2) Open Anaconda Prompt and clone **py-radiometric-corrections** with
34+
35+
>> git clone https://github.com/SenteraLLC/py-radiometric-corrections.git
36+
37+
3) Open Anaconda Prompt and navigate to **py-radiometric-corrections/**. Run:
38+
39+
>> conda env create -f environment.yml
40+
>> conda activate imgcorrect-venv
41+
>> pip install .
42+
43+
4) This creates an *imgcorrect-venv* environment that all scripts should be run in and installs the **analyticstest**
44+
library for the scripts to reference.
45+
46+
If no errors appear, the **imgcorrect** library should be installed correctly.
47+
48+
### Usage
49+
The imagery correction in this repository can be used via:
50+
* Importing the various library functions defined in the package
51+
* Running the pre-defined scripts with a Python installation of version 3.6 or above
52+
* Running the standalone executable on the command line
53+
54+
Open Anaconda Prompt and navigate to **py-radiometric-corrections/**. Run:
55+
56+
>> conda activate imgcorrect-venv
57+
Get a list of required arguments:
58+
59+
>> python scripts\correct_images.py -h
60+
Run corrections:
61+
62+
>> python scripts\correct_images.py "input_path" -o "output_path" **Additional optional commands
63+
64+
65+
Optional commands:
66+
67+
--calibration_id "CALIBRATION_ID", -c CALIBRATION_ID
68+
* Identifier in the name of the image that denotes it is from the calibration set. If not specified, defaults to "CAL".
69+
70+
--output_path OUTPUT_PATH, -o OUTPUT_PATH
71+
* Path to output folder at which the corrected images will be stored. If not supplied, corrected images will be placed into the input directory.
72+
73+
--no_ils_correct, -i
74+
* If selected, ILS correction will not be applied to the images.
75+
76+
--no_reflectance_correct, -r
77+
* If selected, reflectance correction will not be applied to the images.
78+
79+
--all_panels, -a
80+
* If selected, reflectance correction will be applied using all panel images.
81+
82+
--delete_original, -d
83+
* Overwrite original 12-bit images with the corrected versions. If selected, corrected images are renamed to their original names. If not, an extension is added.
84+
85+
--exiftool_path EXIFTOOL_PATH, -e EXIFTOOL_PATH
86+
* Path to ExifTool executable. ExifTool is required for the conversion; if not passed, the script will use a bundled ExifTool executable.
87+
88+
--uint16_output, -u
89+
* If selected, scale of output values will be adjusted to 0-65535 and dtype will be changed to uint16.
90+
91+
2892
#### Building the Executable
2993
In a Windows 10 x64 environment, rebuild the executable with pyinstaller using this command:
3094

0 commit comments

Comments
 (0)