.. |br| raw:: html
Configuration
-------------
.. csv-table::
:header: "Variable", "Default", "Tunable", "Description"
:align: left
:widths: auto
Input Ports
-----------
.. csv-table::
:header: "Port name", "Data Type", "Flags", "Description"
:align: left
:widths: auto
"string", "string", "_required", "Where strings are read from."
Output Ports
------------
.. csv-table::
:header: "Port name", "Data Type", "Flags", "Description"
:align: left
:widths: auto
Pipefile Usage
--------------
The following sections describe the blocks needed to use this process in a pipe file.
Pipefile block
--------------
.. code::
# ================================================================
process
:: take_string
# ================================================================
Process connections
~~~~~~~~~~~~~~~~~~~
The following Input ports will need to be set
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code::
# This process will consume the following input ports
connect from .string
to .string
The following Output ports will need to be set
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code::
# This process will produce the following output ports
Class Description
-----------------
.. doxygenclass:: sprokit::take_string_process
:project: kwiver
:members: