artist.field.tower_target_areas_cylindrical
===========================================

.. py:module:: artist.field.tower_target_areas_cylindrical


Attributes
----------

.. autoapisummary::

   artist.field.tower_target_areas_cylindrical.log


Classes
-------

.. autoapisummary::

   artist.field.tower_target_areas_cylindrical.TowerTargetAreasCylindrical


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

.. py:data:: log

   A logger for the cylindrical tower target areas.


.. py:class:: TowerTargetAreasCylindrical(names: list[str], centers: torch.Tensor, normals: torch.Tensor, axes: torch.Tensor, radii: torch.Tensor, heights: torch.Tensor, opening_angles: torch.Tensor)

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


   Initialize the cylindrical target areas.

   Parameters
   ----------
   names : list[str]
       Name of each cylindrical target area.
   centers : torch.Tensor
       Center coordinate of each cylindrical target area.
       The center is defined at the halfway point between top and bottom of the cylinder on the cylinder axis.
       Shape is ``[number_of_target_areas, 4]``.
   normals : torch.Tensor
       Normal vector of each cylindrical target area.
       Shape is ``[number_of_target_areas, 4]``.
   axes : torch.Tensor
       Cylinder axes of all cylinder target areas.
       Shape is ``[number_of_target_areas, 4]``.
   radii : torch.Tensor
       Radius of each cylindrical target area.
       Shape is ``[number_of_target_areas]``.
   heights : torch.Tensor
       Height of each cylindrical target area.
       Shape is ``[number_of_target_areas]``.
   opening_angles : torch.Tensor
       Opening angle of each cylindrical target area in radians.
       For full cylinders, this is 2*pi or 360°.
       Shape is ``[number_of_target_areas]``.


   .. py:attribute:: radii


   .. py:attribute:: heights


   .. py:attribute:: axes


   .. py:attribute:: opening_angles


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


      Load all cylindrical 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
      -------
      TowerTargetAreasCylindrical
          Target areas loaded from the HDF5 file.