dacapo.gp.dacapo_array_source
=============================

.. py:module:: dacapo.gp.dacapo_array_source


Classes
-------

.. autoapisummary::

   dacapo.gp.dacapo_array_source.DaCapoArraySource


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

.. py:class:: DaCapoArraySource(array: dacapo.experiments.datasplits.datasets.arrays.Array, key: gunpowder.ArrayKey)



   A DaCapo Array source node

   .. attribute:: array

      The array to be served.

      :type: Array

   .. attribute:: key

      The key of the array to be served.

      :type: gp.ArrayKey

   .. method:: setup()

      Set up the provider.

   .. method:: provide(request)

      Provides the array for the requested ROI.

   .. note::

      This class is a subclass of gunpowder.BatchProvider and is used to
      serve array data to gunpowder pipelines.


   .. py:attribute:: array


   .. py:attribute:: array_spec


   .. py:attribute:: key


   .. py:method:: setup()

      Adds the key and the array spec to the provider.

      :raises RuntimeError: If the key is already provided.

      .. rubric:: Examples

      >>> array_source.setup()



   .. py:method:: provide(request)

      Provides data based on the given request.

      :param request: The request for data
      :type request: gp.BatchRequest

      :returns: The batch containing the provided data
      :rtype: gp.Batch

      :raises ValueError: If the input data contains NaN values

      .. rubric:: Examples

      >>> array_source.provide(request)