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/pipeline.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/pipeline.rst')
| -rw-r--r-- | docs/source/operations/pipeline.rst | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/docs/source/operations/pipeline.rst b/docs/source/operations/pipeline.rst index abe98776..9223202d 100644 --- a/docs/source/operations/pipeline.rst +++ b/docs/source/operations/pipeline.rst @@ -4,18 +4,18 @@ The pipeline operator ================================================================================ +.. versionadded:: 5.0.0 + Construct complex operations by daisy-chaining operations in a sequential pipeline. +-----------------+--------------------------------------------------------------------+ -| **Input type** | Any. | -+-----------------+--------------------------------------------------------------------+ -| **Output type** | Any. | +| **Alias** | pipeline | +-----------------+--------------------------------------------------------------------+ -| **Options** | +| **Domain** | 2D, 3D and 4D | +-----------------+--------------------------------------------------------------------+ -| `step` | Separate each step in a pipeline. | +| **Input type** | Any | +-----------------+--------------------------------------------------------------------+ -| `inv` | Invert a step in a pipeline. | +| **Output type** | Any | +-----------------+--------------------------------------------------------------------+ .. note:: See the section on :ref:`transformation` for a more thorough introduction @@ -109,3 +109,20 @@ pass an operation that outputs projected coordinates to an operation that expect +step +proj=merc # Mercator outputs projected coordinates +step +proj=robin # The Robinson projection expects angular input +Parameters +------------------------------------------------------------------------------- + +Required ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. option:: +step + + Separate each step in a pipeline. + + +Optional ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. option:: +inv + + Invert a step in a pipeline. |