propmat_clearskyAddScaledSpecies

Workspace.propmat_clearskyAddScaledSpecies(self: pyarts.arts._Workspace, propmat_clearsky: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.PropagationMatrix]] = self.propmat_clearsky, nlte_source: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.StokesVector]] = self.nlte_source, jacobian_quantities: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity]] = self.jacobian_quantities, select_abs_species: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfSpeciesTag]] = self.select_abs_species, f_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.f_grid, rtp_mag: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.rtp_mag, rtp_los: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.rtp_los, rtp_pressure: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = self.rtp_pressure, rtp_temperature: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = self.rtp_temperature, rtp_nlte: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.EnergyLevelMap]] = self.rtp_nlte, rtp_vmr: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.rtp_vmr, propmat_clearsky_agenda: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Agenda]] = self.propmat_clearsky_agenda, target: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfSpeciesTag], scale: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) None

Adds a scaled target species absorption to propmat_clearsky and nlte_source

This recomputes the entire propagation matrix. There are more efficient ways to do these calculations but this method exist because of the composability it offers

Author(s): Richard Larsson

Parameters:
  • propmat_clearsky (PropagationMatrix, optional) – This contains the absorption coefficients for one point in the atmosphere. See propmat_clearsky, defaults to self.propmat_clearsky [INOUT]

  • nlte_source (StokesVector, optional) – Variable to contain the additional source function due to NLTE effects. See nlte_source, defaults to self.nlte_source [INOUT]

  • jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]

  • select_abs_species (ArrayOfSpeciesTag, optional) – A select species tag group from abs_species. See select_abs_species, defaults to self.select_abs_species [IN]

  • f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See f_grid, defaults to self.f_grid [IN]

  • rtp_mag (Vector, optional) – Magnetic field at a radiative transfer point. See rtp_mag, defaults to self.rtp_mag [IN]

  • rtp_los (Vector, optional) – Line-of-sight at a radiative transfer point. See rtp_los, defaults to self.rtp_los [IN]

  • rtp_pressure (Numeric, optional) – Pressure at a radiative transfer point. See rtp_pressure, defaults to self.rtp_pressure [IN]

  • rtp_temperature (Numeric, optional) – Temperature at a radiative transfer point. See rtp_temperature, defaults to self.rtp_temperature [IN]

  • rtp_nlte (EnergyLevelMap, optional) – NLTE temperature/ratio at a radiative transfer point. See rtp_nlte, defaults to self.rtp_nlte [IN]

  • rtp_vmr (Vector, optional) – Absorption species abundances for radiative transfer calculations. See rtp_vmr, defaults to self.rtp_vmr [IN]

  • propmat_clearsky_agenda (Agenda, optional) – Calculate the absorption coefficient matrix. See propmat_clearsky_agenda, defaults to self.propmat_clearsky_agenda [IN]

  • target (ArrayOfSpeciesTag) – Target species tags to rescale (must be in abs_species. [IN]

  • scale (Numeric) – Rescaling factor (e.g., 0.1 adds 10% of the species to the absorption). [IN]

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