aboutsummaryrefslogtreecommitdiff
path: root/docs/source/operations/pipeline.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/operations/pipeline.rst')
-rw-r--r--docs/source/operations/pipeline.rst29
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.