sensor_responseAntenna

Workspace.sensor_responseAntenna(self: pyarts.arts._Workspace, sensor_response: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Sparse]] = self.sensor_response, sensor_response_f: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.sensor_response_f, sensor_response_pol: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfIndex]] = self.sensor_response_pol, sensor_response_dlos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.sensor_response_dlos, sensor_response_dlos_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.sensor_response_dlos_grid, sensor_response_f_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.sensor_response_f_grid, sensor_response_pol_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfIndex]] = self.sensor_response_pol_grid, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, antenna_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.antenna_dim, antenna_dlos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.antenna_dlos, antenna_response: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.GriddedField4]] = self.antenna_response, sensor_norm: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.sensor_norm, option_2d: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = "-", solid_angles: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = Vector{}, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Includes response of the antenna.

The function returns the sensor response matrix after the antenna characteristics have been included.

The function handles “multi-beam” cases where the polarisation coordinate system is the same for all beams.

See antenna_dim, antenna_dlos and antenna_response for details on how to specify the antenna response.

The text below refers to mblock_dlos despite it is not an input to the method. The method instead uses sensor_response_dlos_grid but the values in this WSV are likely coming from mblock_dlos.

One dimensional antenna patterns are handled as other response functions. That is, both antenna response and radiances are treated as piece-wise linear functions, and the pencil beam calculations must cover the full sensor response (i.e. mblock_dlos shall be sufficiently broad).

There exist different options for two dimensional antenna patterns. (If 2D, the GIN option_2d must be set, the default setting results in an error). A normalisation is always applied for 2D antennas.

“interp_response” Both radiances and the antenna pattern are treated as step-wise constant functions. The antenna pattern is interpolated to the mblock_dlos directions. At extrapolation, the antenna response is set to zero. This option considers GIN solid_angles, that shall be a vector with length matching the rows of mblock_dlos. The values going into sensor_response are the interpolated antenna values times the corresponding solid angle.

“gridded_dlos” This option is more similar to the 1D case. The radiances are treated as a bi-linear function, but the antenna response is treated as step- wise constant function (in contrast to 1D). For this option mblock_dlos must match a combination of zenith and azimuth grids, and this for a particular order. If the zenith and azimuth grids have 3 and 2 values, respectively, the order shall be:

[(za1,aa1); (za2,aa1); (za3,aa1); (za1,aa2); (za2,aa2); (za3,aa2)]

Both these grids must be strictly increasing and as for 1D must cover the antenna response completely.

Author(s): Patrick Eriksson, Mattias Ekstrom

Parameters:

  • sensor_response (Sparse, optional) – The matrix modelling the total sensor response. See sensor_response, defaults to self.sensor_response [INOUT]

  • sensor_response_f (Vector, optional) – The frequencies associated with the output of sensor_response. See sensor_response_f, defaults to self.sensor_response_f [INOUT]

  • sensor_response_pol (ArrayOfIndex, optional) – The polarisation states associated with the output of. See sensor_response_pol, defaults to self.sensor_response_pol [INOUT]

  • sensor_response_dlos (Matrix, optional) – The relative zenith and azimuth angles associated with the output of. See sensor_response_dlos, defaults to self.sensor_response_dlos [INOUT]

  • sensor_response_dlos_grid (Matrix, optional) – The zenith and azimuth angles associated with sensor_response. See sensor_response_dlos_grid, defaults to self.sensor_response_dlos_grid [INOUT]

  • sensor_response_f_grid (Vector, optional) – The frequency grid associated with sensor_response. See sensor_response_f_grid, defaults to self.sensor_response_f_grid [IN]

  • sensor_response_pol_grid (ArrayOfIndex, optional) – The “polarisation grid” associated with sensor_response. See sensor_response_pol_grid, defaults to self.sensor_response_pol_grid [IN]

  • atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]

  • antenna_dim (Index, optional) – The dimensionality of the antenna pattern (1-2). See antenna_dim, defaults to self.antenna_dim [IN]

  • antenna_dlos (Matrix, optional) – The relative line-of-sight of each antenna pattern. See antenna_dlos, defaults to self.antenna_dlos [IN]

  • antenna_response (GriddedField4, optional) – The antenna pattern/response. See antenna_response, defaults to self.antenna_response [IN]

  • sensor_norm (Index, optional) – Flag if sensor response should be normalised or not (0 or 1). See sensor_norm, defaults to self.sensor_norm [IN]

  • option_2d (String, optional) – Calculation option for 2D antenna cases. See above for details. Defaults to "-" [IN]

  • solid_angles (Vector, optional) – The solid angle of each mblock_dlos direction. Only considered for 2D with “interp_response”. Defaults to [] [IN]

  • verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]