edges_analysis.beams.antenna_beam_factor

edges_analysis.beams.antenna_beam_factor(beam: Beam, ground_loss_file: tp.PathLike | None = ':', f_low: tp.FreqType = <Quantity 0. MHz>, f_high: tp.Freqtype = <Quantity inf MHz>, normalize_beam: bool = True, sky_model: sky_models.SkyModel = SkyModel(frequency=408.0, temperature=array([192.10422, 190.78244, 190.67949, ..., 183.18246, 181.32964,        182.89944], dtype='>f4'), coords=<SkyCoord (Galactic): (l, b) in deg     [( 45.        ,  0.0746039 ), ( 45.08789062,  0.14920793),      ( 44.91210938,  0.14920793), ..., (315.08789062, -0.14920793),      (314.91210938, -0.14920793), (315.        , -0.0746039 )]>, name='Haslam408', healpix=<astropy_healpix.high_level.HEALPix object>, pixel_res=3.994741635118857e-06), index_model: sky_models.IndexModel = GaussianIndex(index_pole=2.65, index_center=2.4, sigma_deg=8.5), lsts: np.ndarray | None = None, reference_frequency: tp.FreqType | None = None, beam_smoothing: bool = True, smoothing_model: mdl.Model = Polynomial(parameters=None, n_terms=12, transform=IdentityTransform(), offset=0.0), interp_kind: Literal['linear', 'nearest', 'slinear', 'cubic', 'quintic', 'pchip', 'spline', 'sphere-spline'] = 'sphere-spline', lst_progress: bool = True, freq_progress: bool = True, location: apc.EarthLocation = <EarthLocation (-2553239.64058645, 5097473.27470581, -2850021.53546025) m>, sky_at_reference_frequency: bool = True, use_astropy_azel: bool = True)[source]

Calculate the antenna beam factor.

Parameters:

  • beam – A Beam object.

  • ground_loss_file – A file pointing to a ground-loss model. By default, gets the default ground loss model for the given band.

  • f_low – Minimum frequency to keep in the simulation (frequencies otherwise defined by the beam).

  • f_high – Maximum frequency to keep in the simulation (frequencies otherwise defined by the beam).

  • normalize_beam – Whether to normalize the beam to be maximum unity.

  • sky_model – A sky model to use.

  • index_model – An IndexModel to use to generate different frequencies of the sky model.

  • twenty_min_per_lst – How many periods of twenty minutes fit into each LST bin.

  • save_dir – The directory in which to save the output beam factor.

  • save_fname – The filename to save the output beam factor.

  • reference_frequency – The frequency to take as the “reference”, i.e. where the chromaticity will be by construction unity.

  • lst_progress – Whether to show a progress bar over the LSTs.

  • freq_progress – Whether to show a progress bar over the frequencies.

  • location – The location of the telescope.

Returns:

beam_factor (:class`BeamFactor` instance)