artist.field.tower_target_areas_planar
======================================

.. py:module:: artist.field.tower_target_areas_planar


Attributes
----------

.. autoapisummary::

   artist.field.tower_target_areas_planar.log


Classes
-------

.. autoapisummary::

   artist.field.tower_target_areas_planar.TowerTargetAreasPlanar


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

.. py:data:: log

   A logger for the planar tower target areas.


.. py:class:: TowerTargetAreasPlanar(names: list[str], centers: torch.Tensor, normals: torch.Tensor, dimensions: torch.Tensor)

   Bases: :py:obj:`artist.field.tower_target_areas.TowerTargetAreas`


   Initialize the planar target areas.

   Parameters
   ----------
   names : list[str]
       Name of each planar target area.
   centers : torch.Tensor
       Center point coordinate of each planar target area.
       Shape is ``[number_of_target_areas, 4]``.
   normals : torch.Tensor
       Normal vector of each planar target area.
       Shape is ``[number_of_target_areas, 4]``.
   dimensions : torch.Tensor
       Dimensions of each planar target area (width, then height).
       Shape is ``[number_of_target_areas, 2]``.


   .. py:attribute:: dimensions


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


      Load all planar target areas from an HDF5 file.

      Parameters
      ----------
      config_file : h5py.File
          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
      -------
      TowerTargetAreasPlanar
          Target areas loaded from the HDF5 file.