From 13905f61f82aeb30558a22c9e5719612cf2db1d3 Mon Sep 17 00:00:00 2001 From: Peter Williams Date: Mon, 14 Sep 2020 21:44:51 -0400 Subject: [PATCH] docs/cli: add some more --- docs/cli.rst | 1 + docs/cli/cascade.rst | 2 ++ docs/cli/study-sample-image-tiles.rst | 9 +++++++ docs/cli/wwtl-sample-image-tiles.rst | 35 +++++++++++++++++++++++++++ 4 files changed, 47 insertions(+) create mode 100644 docs/cli/wwtl-sample-image-tiles.rst diff --git a/docs/cli.rst b/docs/cli.rst index 4464410..90cd6d1 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -7,3 +7,4 @@ CLI Reference cli/std-image-options cli/cascade cli/study-sample-image-tiles + cli/wwtl-sample-image-tiles diff --git a/docs/cli/cascade.rst b/docs/cli/cascade.rst index bf53135..7aed4d2 100644 --- a/docs/cli/cascade.rst +++ b/docs/cli/cascade.rst @@ -1,3 +1,5 @@ +.. _cli-cascade: + ================== ``toasty cascade`` ================== diff --git a/docs/cli/study-sample-image-tiles.rst b/docs/cli/study-sample-image-tiles.rst index 84efab4..7bf65cb 100644 --- a/docs/cli/study-sample-image-tiles.rst +++ b/docs/cli/study-sample-image-tiles.rst @@ -1,3 +1,5 @@ +.. _cli-study-sample-image-tiles: + =================================== ``toasty study-sample-image-tiles`` =================================== @@ -23,3 +25,10 @@ that needs to be tiled to be displayed usefully in AAS WorldWide Telescope. The ``--outdir DIR`` option specifies where the output data should be written. If unspecified, the data root will be the current directory. + +Notes +===== + +If the input image does not contain any useful astrometric information, the +emited ``index_rel.wtml`` file will contain generic information that makes the +image 1° wide and places it at RA = Dec = 0. diff --git a/docs/cli/wwtl-sample-image-tiles.rst b/docs/cli/wwtl-sample-image-tiles.rst new file mode 100644 index 0000000..264034e --- /dev/null +++ b/docs/cli/wwtl-sample-image-tiles.rst @@ -0,0 +1,35 @@ +.. _cli-wwtl-sample-image-tiles: + +================================== +``toasty wwtl-sample-image-tiles`` +================================== + +The ``wwtl-sample-image-tiles`` command is like +:ref:`cli-study-sample-image-tiles`, but loads up ``.wwtl`` WWT “layers” files, +from which it can load preexisting astrometric information and convert it to the +format needed for its tiled output. The purpose of this specialized command is +to enable an easy workflow where you can interactively position a large image +file on the sky in the AAS WorldWide Telescope Windows application, then tile it +for web viewing while preserving the astrometric alignment. + +Usage +===== + +.. code-block:: shell + + toasty wwtl-sample-image-tiles + [standard image-loading options] + [--outdir DIR] + WWTL-PATH + +See the :ref:`cli-std-image-options` section for documentation on those options. +Note that options that deal with image processing will process the image +contained in the input WWTL file. Other options might not make sense for this +command. + +The ``WWTL-PATH`` argument gives the filename of the input WWTL file. This file +should contain one layer, which should be an image-set layer. The WWTL file will +include the contents of the associated image as well. + +The ``--outdir DIR`` option specifies where the output data should be written. +If unspecified, the data root will be the current directory.