edges_analysis.beams.Beam.from_hfss

classmethod Beam.from_hfss(path: str | Path, frequency: Quantity, linear: bool = True, theta_min: float = 0, theta_max: float = 180, theta_resolution: float = 1, phi_min: float = 0, phi_max: float = 359, phi_resolution: float = 1) → Beam[source]

Create a Beam object from a HFSS file.

Parameters:

  • path – Path to the file. Use resolve_file() to get the absolute path from a a relative path (starting with ‘:’).

  • linear – Whether the beam values are in linear units (or decibels)

  • theta_min, theta_max – Min/Max of the zenith angle (degrees)

  • theta_resolution – Resolution of the zenith angle.

  • phi_min, phi_max – Min/Max of the azimuth angles (degrees)

  • phi_resolution – The resolution of the azimuth angle.

Returns:

beam – The beam object.