iySurfaceRtpropCalc

Workspace.iySurfaceRtpropCalc(self: pyarts.arts._Workspace, iy: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.iy, diy_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfTensor3 | None = self.diy_dx, surface_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.surface_los, surface_rmatrix: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.surface_rmatrix, surface_emission: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.surface_emission, dsurface_names: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.dsurface_names, dsurface_rmatrix_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfTensor4 | None = self.dsurface_rmatrix_dx, dsurface_emission_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfMatrix | None = self.dsurface_emission_dx, iy_transmittance: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.iy_transmittance, iy_id: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.iy_id, jacobian_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.jacobian_do, suns_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.suns_do, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, atmosphere_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmosphere_dim, nlte_field: pyarts.arts.WorkspaceVariable | pyarts.arts.EnergyLevelMap | None = self.nlte_field, cloudbox_on: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_on, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, rtp_pos: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rtp_pos, rtp_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rtp_los, rte_pos2: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_pos2, iy_unit: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit, iy_main_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_main_agenda, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None

Applies surface_los, surface_rmatrix and surface_emission.

This method is designed to be part of iy_surface_agenda and should be mandatory when using methods describing the surface radiative transfer properties by surface_los, surface_rmatrix and surface_emission. The task of this method is to apply these three WSVs to obtain the upwelling radiation from the surface. This upwelling radiation is the sum of surface emission and reflected downwelling radiation. The later part is calculated by calling iy_main_agenda. See further AUG.

Author(s): Patrick Eriksson

Parameters:
  • iy (Matrix, optional) – Monochromatic pencil beam radiance spectrum. See iy, defaults to self.iy [OUT]

  • diy_dx (ArrayOfTensor3, optional) – Derivative of iy with respect to retrieval quantities. See diy_dx, defaults to self.diy_dx [INOUT]

  • surface_los (Matrix, optional) – Downwelling radiation directions to consider in surface reflection. See surface_los, defaults to self.surface_los [IN]

  • surface_rmatrix (Tensor4, optional) – The reflection coefficients for the directions given by. See surface_rmatrix, defaults to self.surface_rmatrix [IN]

  • surface_emission (Matrix, optional) – The emission from the surface. See surface_emission, defaults to self.surface_emission [IN]

  • dsurface_names (ArrayOfString, optional) – Name of surface retrieval quantities. See dsurface_names, defaults to self.dsurface_names [IN]

  • dsurface_rmatrix_dx (ArrayOfTensor4, optional) – The derivative of surface_rmatrix with respect to quantities. See dsurface_rmatrix_dx, defaults to self.dsurface_rmatrix_dx [IN]

  • dsurface_emission_dx (ArrayOfMatrix, optional) – The derivative of surface_emission with respect to quantities. See dsurface_emission_dx, defaults to self.dsurface_emission_dx [IN]

  • iy_transmittance (Tensor3, optional) – Transmittance to be included in iy. See iy_transmittance, defaults to self.iy_transmittance [IN]

  • iy_id (Index, optional) – Identification number of iy. See iy_id, defaults to self.iy_id [IN]

  • jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See jacobian_do, defaults to self.jacobian_do [IN]

  • suns_do (Index, optional) – Flag to activate the sun(s). See suns_do, defaults to self.suns_do [IN]

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

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

  • nlte_field (EnergyLevelMap, optional) – The field of NLTE temperatures and/or ratios. See nlte_field, defaults to self.nlte_field [IN]

  • cloudbox_on (Index, optional) – Flag to activate the cloud box. See cloudbox_on, defaults to self.cloudbox_on [IN]

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

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

  • rtp_pos (Vector, optional) – Position of a radiative transfer point. See rtp_pos, defaults to self.rtp_pos [IN]

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

  • rte_pos2 (Vector, optional) – A second geographical position to define the geometry for. See rte_pos2, defaults to self.rte_pos2 [IN]

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

  • iy_main_agenda (Agenda, optional) – Calculation of a single monochromatic pencil beam spectrum. See iy_main_agenda, defaults to self.iy_main_agenda [IN]

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