dacapo.gp.product
=================

.. py:module:: dacapo.gp.product


Classes
-------

.. autoapisummary::

   dacapo.gp.product.Product


Module Contents
---------------

.. py:class:: Product(x1_key: gunpowder.ArrayKey, x2_key: gunpowder.ArrayKey, y_key: gunpowder.ArrayKey)



   A BatchFilter that multiplies two input arrays and produces an output array.

   .. attribute:: x1_key

      The key of the first input array.

      :type: :class:`ArrayKey`

   .. attribute:: x2_key

      The key of the second input array.

      :type: :class:`ArrayKey`

   .. attribute:: y_key

      The key of the output array.

      :type: :class:`ArrayKey`

   Provides:
       y_key (gp.ArrayKey): The key of the output array.
   Method:
       __init__: Initialize the Product BatchFilter.
       setup: Set up the Product BatchFilter.
       prepare: Prepare the Product BatchFilter.
       process: Process the Product BatchFilter.



   .. py:attribute:: x1_key


   .. py:attribute:: x2_key


   .. py:attribute:: y_key


   .. py:method:: setup()

      Set up the Product BatchFilter.

      Enables autoskip and specifies the output array.

      :raises AssertionError: If the input arrays are not provided.

      .. rubric:: Examples

      >>> setup()
      setup()



   .. py:method:: prepare(request)

      Prepare the Product BatchFilter.

      :param request: The batch request.
      :type request: gp.BatchRequest

      :returns: The dependencies.
      :rtype: gp.BatchRequest

      :raises AssertionError: If the input arrays are not provided.

      .. rubric:: Examples

      >>> prepare(request)
      prepare(request)



   .. py:method:: process(batch, request)

      Process the Product BatchFilter.

      :param batch: The input batch.
      :type batch: gp.Batch
      :param request: The batch request.
      :type request: gp.BatchRequest

      :returns: The output batch.
      :rtype: gp.Batch

      :raises AssertionError: If the input arrays are not provided.

      .. rubric:: Examples

      >>> process(batch, request)
      process(batch, request)