artist.field.tower_target_areas
===============================

.. py:module:: artist.field.tower_target_areas


Attributes
----------

.. autoapisummary::

   artist.field.tower_target_areas.log


Classes
-------

.. autoapisummary::

   artist.field.tower_target_areas.TowerTargetAreas


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

.. py:data:: log

   A logger for the tower target areas.


.. py:class:: TowerTargetAreas(names: list[str], geometries: list[str], centers: torch.Tensor, normal_vectors: torch.Tensor, dimensions: torch.Tensor, curvatures: torch.Tensor)

   Initialize the target area array.

   A target area array consists of one or more target areas that are positioned
   on the solar tower, in front of the heliostats. The target area array is provided
   with a list of target areas to initialize the target areas.

   Parameters
   ----------
   names : list[str]
       The names of each target area.
   geometries : list[str]
       The type of geometry of each target area.
   centers : torch.Tensor
       The center point coordinate of each target area.
       Tensor of shape [number_of_target_areas, 4].
   normal_vectors : torch.Tensor
       The normal vector of each target area.
       Tensor of shape [number_of_target_areas, 4].
   dimensions : torch.Tensor
       The dimensions of each target area (width, then height).
       Tensor of shape [number_of_target_areas, 2].
   curvatures : torch.Tensor
       The curvature of the target area in 2 dimensions (0.0 if not applicable).
       Tensor of shape [number_of_target_areas, 2].


   .. py:attribute:: names


   .. py:attribute:: geometries


   .. py:attribute:: centers


   .. py:attribute:: normal_vectors


   .. py:attribute:: dimensions


   .. py:attribute:: curvatures


   .. py:attribute:: number_of_target_areas


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


      Load all target areas 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
      -------
      TowerTargetAreas
          The target areas loaded from the HDF5 file.