summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRyan Baumann <ryan.baumann@gmail.com>2016-08-23 16:14:48 -0400
committerRyan Baumann <ryan.baumann@gmail.com>2016-08-23 16:14:48 -0400
commit48b73c35c312d9a00d94f34bffc7d5e1a8f10904 (patch)
tree696ce996ed06ea5cd4532e4df476806911b76200 /README.md
parentacb4c878bde601de3c792fed38198ad03f69b21e (diff)
Initial pass at automatic hi-res NYPL Stereogranimator morphing
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 028a7a2..de85c5c 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,9 @@ This process is inspired by Patrick Feaster's post on [Animating Historical Phot
For input, you need two PNG images of the same dimensions named e.g. `filename_0.png` and `filename_1.png`. You can then run `./run-torchwarp.sh filename` to run all the steps and output the morphing animation as `morphed_filename.gif`.
-You can also use `./run-stereogranimator.sh ID` with an image ID from [NYPL's Stereogranimator](http://stereo.nypl.org/) to download an animated GIF and run it through the morphing process.
+You can also use `./run-stereogranimator.sh ID` with an image ID from [NYPL's Stereogranimator](http://stereo.nypl.org/) to download an animated GIF at low resolution and run it through the morphing process.
+
+If you sign up for [the NYPL Digital Collections API](http://api.repo.nypl.org/), you can use your API token to download high-resolution original images. The `nypl_recrop.rb` script reads the token from the `NYPL_API_TOKEN` environment variable, and takes a Stereogranimator image ID as an argument, downloading the original TIFF image and using `template_matching_multiscale.rb` to calculate the crop and split the image into two views at full resolution. The `run-stereogranimator-hi-res.sh` script uses this process instead of `wget` with low-resolution GIFs. You can also pass the `NYPL_API_TOKEN` environment variable [in your `docker run` command](https://docs.docker.com/engine/reference/run/#/env-environment-variables).
## Docker Usage