sensor_responsePolarisation

Workspace.sensor_responsePolarisation(self: pyarts.arts._Workspace, sensor_response: pyarts.arts.WorkspaceVariable | pyarts.arts.Sparse | None = self.sensor_response, sensor_response_f: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.sensor_response_f, sensor_response_pol: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.sensor_response_pol, sensor_response_dlos: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.sensor_response_dlos, sensor_response_pol_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.sensor_response_pol_grid, sensor_response_f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.sensor_response_f_grid, sensor_response_dlos_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.sensor_response_dlos_grid, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, iy_unit: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit, instrument_pol: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.instrument_pol, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) → None

Extraction of non-default polarisation components.

The default is to output the Stokes elements I, Q, U and V (up to stokes_dim). This method allows to change the “polarisation” of the output. Polarisation components to be extracted are selected by instrument_pol. This method can be applied at any step of the sensor matrix set-up.

The method can only be applied on data for I, Q, U and V. The value of stokes_dim must be sufficiently large for the selected components. For example, I+45 requires that stokes_dim is at least 3.

See instrument_pol for coding of polarisation states.

Note that the state of iy_unit is considered. This WSV must give the actual unit of the data. This as, the extraction of components is slightly different if data are radiances or brightness temperatures. In practise this means that iy_unit (as to be applied inside iy_main_agenda) must be set before calling this method.

Author(s): Patrick Eriksson

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_pol_grid (ArrayOfIndex, optional) – The “polarisation grid” associated with sensor_response. See sensor_response_pol_grid, defaults to self.sensor_response_pol_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_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 [IN]

  • stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See stokes_dim, defaults to self.stokes_dim [IN]

  • iy_unit (String, optional) – Selection of output unit for radiative transfer methods. See iy_unit, defaults to self.iy_unit [IN]

  • instrument_pol (ArrayOfIndex, optional) – Definition of the polarisation of an instrument. See instrument_pol, defaults to self.instrument_pol [IN]

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