artist.scene.light_source_array
===============================

.. py:module:: artist.scene.light_source_array


Attributes
----------

.. autoapisummary::

   artist.scene.light_source_array.log


Classes
-------

.. autoapisummary::

   artist.scene.light_source_array.LightSourceArray


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

.. py:data:: log

   A logger for the light source array.


.. py:class:: LightSourceArray(light_source_list: collections.abc.Sequence[artist.scene.light_source.LightSource])

   Initialize the light sources included in the considered scenario.

   The light source array bundles all light sources considered in the scenario. The light source
   sends out the rays that are then used for ray tracing. The position of the light sources can be
   dynamic throughout a time span.

   Parameters
   ----------
   light_source_list : Sequence[LightSource]
       A list of light sources included in the scenario.


   .. py:attribute:: light_source_list


   .. py:method:: from_hdf5(config_file: h5py.File, device: torch.device | None = None) -> typing_extensions.Self
      :classmethod:


      Load a light source array from an HDF5 file.

      Parameters
      ----------
      config_file : h5py.File
          The HDF5 file containing the configuration to be loaded.
      device : torch.device | None
          The device on which to perform computations or load tensors and models (default is None).
          If None, ``ARTIST`` will automatically select the most appropriate
          device (CUDA or CPU) based on availability and OS.

      Returns
      -------
      LightSourceArray
          The light source array loaded from the HDF5 file.