:html_theme.sidebar_secondary.remove:
tidy3d.rf.DirectivityData
=========================

.. autoclass:: tidy3d.rf.DirectivityData
   :members:
   :show-inheritance:
   :undoc-members:
   :member-order: bysource
   :exclude-members: __hash__

   
   
   .. rubric:: Attributes

   .. autosummary::
      :toctree:
      
      
        axial_ratio
      
      
      
      
      
      
        directivity
      
      
      
      
      
      
        fields_circular_polarization
      
      
      
      
        left_polarization
      
      
      
      
      
      
      
        radiated_power
      
      
        radiation_intensity
      
      
        right_polarization
      
      
      
      
      
      
        monitor
      
      
        flux
      
      
        projection_surfaces
      
      
        Er
      
      
        Etheta
      
      
        Ephi
      
      
        Hr
      
      
        Htheta
      
      
        Hphi
      
      
        medium
      
      
        is_2d_simulation
      
      
        attrs
      
      
      

   
   
   .. rubric:: Methods

   .. autosummary::
       :toctree:
       
          
          
          
            calc_gain
          
          
            calc_partial_gain
          
          
            calc_radiation_efficiency
          
          
          
          
          
          
          
          
          
          
          
            fields_linear_polarization_tilted
          
          
          
          
          
          
          
          
          
            from_spherical_field_dataset
          
          
          
          
          
          
          
          
          
          
          
          
          
          
          
            normalize
          
          
          
          
          
            partial_directivity
          
          
            partial_radiation_intensity
          
          
          
          
          
          
          
          
          
          
          
          
          
          
          
          
          
       
       


   .. rubric:: Inherited Common Usage

   .. include:: ../_custom_autosummary/tidy3d.rf.DirectivityData.rst
      :optional: