diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2018-04-30 22:42:59 +0200 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2018-04-30 22:57:05 +0200 |
| commit | 970d708ff9d796f7d9ec00b22023e835fbdc7f2d (patch) | |
| tree | cbee11737ed36f20e51ba19c9e8faa757e79ac0d /docs/source/operations/conversions/axisswap.rst | |
| parent | cd23e5f1b2630ee07567bd361373ba725774061b (diff) | |
| download | PROJ-970d708ff9d796f7d9ec00b22023e835fbdc7f2d.tar.gz PROJ-970d708ff9d796f7d9ec00b22023e835fbdc7f2d.zip | |
Refactor operation doc pages
Extended the use of the :option: directive to all currently written
operation doc pages. In the process several more default parameters were
added for easy inclusion in other doc pages.
Expanded the info tables for each operation with "domain", "alias",
"input type" and "output type".
Corrected various errors along the way. Mainly formatting errors and
references to invalid parameters such as +sym in hatano.
Diffstat (limited to 'docs/source/operations/conversions/axisswap.rst')
| -rw-r--r-- | docs/source/operations/conversions/axisswap.rst | 31 |
1 files changed, 24 insertions, 7 deletions
diff --git a/docs/source/operations/conversions/axisswap.rst b/docs/source/operations/conversions/axisswap.rst index ddaad075..0fbe6d76 100644 --- a/docs/source/operations/conversions/axisswap.rst +++ b/docs/source/operations/conversions/axisswap.rst @@ -4,20 +4,26 @@ Axis swap ================================================================================ +.. versionadded:: 5.0.0 + Change the order and sign of 2,3 or 4 axes. -+--------------+---------------------------------------------------------------+ -| **Options** | -+--------------+---------------------------------------------------------------+ -| `+order` | Ordered comma-separated list of axis, e.g. `+order=2,1,3,4` | -+--------------+---------------------------------------------------------------+ ++---------------------+--------------------------------------------------------+ +| **Alias** | axisswap | ++---------------------+--------------------------------------------------------+ ++ **Domain** | 2D, 3D or 4D | ++---------------------+--------------------------------------------------------+ +| **Input type** | Any | ++---------------------+--------------------------------------------------------+ +| **Output type** | Any | ++---------------------+--------------------------------------------------------+ -Each of the possible four axes are numbered with 1-4, such that the first input axis +Each of the possible four axes are numbered with 1--4, such that the first input axis is 1, the second is 2 and so on. The output ordering is controlled by a list of the input axes re-ordered to the new mapping. -Examples +Usage ################################################################################ Reversing the order of the axes:: @@ -37,3 +43,14 @@ It is only necessary to specify the axes that are affected by the swap operation:: +proj=axisswap +order=2,1 + +Parameters +################################################################################ + +.. option:: +order=<list> + + Ordered comma-separated list of axis, e.g. *+order=2,1,3,4*. + Adding a minus in front of an axis number results in a change of direction + for that axis, e.g. southward instead of northward. + + *Required.* |