.. |br| raw:: html
Configuration
-------------
.. csv-table::
:header: "Variable", "Default", "Tunable", "Description"
:align: left
:widths: auto
"factor", "(no default value)", "NO", "The value to start counting at."
Input Ports
-----------
.. csv-table::
:header: "Port name", "Data Type", "Flags", "Description"
:align: left
:widths: auto
"factor", "integer", "_required", "The factor to multiply."
Output Ports
------------
.. csv-table::
:header: "Port name", "Data Type", "Flags", "Description"
:align: left
:widths: auto
"product", "integer", "_required", "Where the product will be available."
Pipefile Usage
--------------
The following sections describe the blocks needed to use this process in a pipe file.
Pipefile block
--------------
.. code::
# ================================================================
process
:: multiplier_cluster
# The value to start counting at.
factor =
# ================================================================
Process connections
~~~~~~~~~~~~~~~~~~~
The following Input ports will need to be set
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code::
# This process will consume the following input ports
connect from .factor
to .factor
The following Output ports will need to be set
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code::
# This process will produce the following output ports
connect from .product
to .product
Class Description
-----------------
.. doxygenclass:: sprokit::multiplier_cluster
:project: kwiver
:members: