Updated README.md

master
Jonathan Chan 2 years ago
parent 34bfe4eec9
commit 128a1431e0

@ -63,15 +63,15 @@ NOTE: `coastsnap_sites.csv` is called by all of the scripts in this repo. DON'T
4. Update the environment: `conda env update --name coastsnap --file environment.yml` 4. Update the environment: `conda env update --name coastsnap --file environment.yml`
## Usage ## Usage
### Batch download images from Spotteron ### Download images from Spotteron
#### Batch download
Run `batch_spotteron_download.bat` Run `batch_spotteron_download.bat`
Script Logic: For every site in `coastsnap_sites.csv`, download the latest Spotteron images and save to Processed. Script Logic: For every site in `coastsnap_sites.csv`, download the latest Spotteron images and save to Processed.
* Starts downloading from the most recent image and stops downloading for the site when an image has already been downloaded, to avoid overwriting images. * Starts downloading from the most recent image and stops downloading for the site when an image has already been downloaded, to avoid overwriting images.
### Batch register images ### Register images in photoshop
#### Batch register
Run `batch_photoshop_registration.bat` Run `batch_photoshop_registration.bat`
Script Logic: For every site in `coastsnap_sites.csv`, iterate through the sites' Processed images (Images/Site/Processed). For any image that hasn't already been photoshop registered (in Images/Site/Photoshop), register it. Script Logic: For every site in `coastsnap_sites.csv`, iterate through the sites' Processed images (Images/Site/Processed). For any image that hasn't already been photoshop registered (in Images/Site/Photoshop), register it.
@ -91,8 +91,8 @@ Script Logic: For every site in `coastsnap_sites.csv`, iterate through the sites
* Output images are all 1280px wide and will have the same aspect ratio as the sites' Target.jpg image * Output images are all 1280px wide and will have the same aspect ratio as the sites' Target.jpg image
* Batch Size: Images are registered with the target and seed images, in batches of 15. This is set on line 13 of `photoshop_registration_all_sites.jsx` and can be changed. Images may be registered in smaller batch sizes if there are less than 15 images in the Site/Processed/Year folder. * Batch Size: Images are registered with the target and seed images, in batches of 15. This is set on line 13 of `photoshop_registration_all_sites.jsx` and can be changed. Images may be registered in smaller batch sizes if there are less than 15 images in the Site/Processed/Year folder.
### Batch tag images ### Tag images
#### Batch tag images
Run `batch_tag_registered.bat` Run `batch_tag_registered.bat`
Script Logic: For every site in oneDrive CoastSnap directory, iterate through the sites' registered images (Images/Site/Photoshop). Tag the images with their Date, Time, Contributor and Tide (if tide data for site exists), suffix the filename with "_registered" and save at Images/Site/Registered. Script Logic: For every site in oneDrive CoastSnap directory, iterate through the sites' registered images (Images/Site/Photoshop). Tag the images with their Date, Time, Contributor and Tide (if tide data for site exists), suffix the filename with "_registered" and save at Images/Site/Registered.
@ -100,6 +100,8 @@ Script Logic: For every site in oneDrive CoastSnap directory, iterate through th
* Starts tagging from the most recent image and stops for the site when an image has already been tagged. This way, the user can manually remove bad registered/tagged images, and they will not be automatically replaced. * Starts tagging from the most recent image and stops for the site when an image has already been tagged. This way, the user can manually remove bad registered/tagged images, and they will not be automatically replaced.
* Retrieves tide data for the site from the .mat file specified in Database/CoastSnapDB.xlsx * Retrieves tide data for the site from the .mat file specified in Database/CoastSnapDB.xlsx
####
### Images Snapshot ### Images Snapshot
Run `generate_images_snapshot.bat` Run `generate_images_snapshot.bat`

Loading…
Cancel
Save