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], centers: torch.Tensor, normals: torch.Tensor)

   Initialize the target areas.

   Parameters
   ----------
   names : list[str]
       The name of each target area.
   centers : torch.Tensor
       Center point coordinate of each target area.
       Shape is ``[number_of_target_areas, 4]``.
   normals : torch.Tensor
       Normal vector of each target area.
       Shape is ``[number_of_target_areas, 4]``.


   .. py:attribute:: names


   .. py:attribute:: centers


   .. py:attribute:: normals


   .. py:attribute:: number_of_target_areas


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

      :abstractmethod:


      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.

      Raises
      ------
      NotImplementedError
          This abstract method must be overridden.