ScatElementsSelect

Workspace.ScatElementsSelect(self: pyarts.arts._Workspace, scat_data_raw: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfArrayOfSingleScatteringData]] = self.scat_data_raw, scat_meta: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfArrayOfScatteringMetaData]] = self.scat_meta, scat_species: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfString]] = self.scat_species, species: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], sizeparam: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], sizemin: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 0., sizemax: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = -1., tolerance: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 1e-6, delim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = "-", verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Allows to limit considered scattering elements according to size.

Scattering elements of a specified scattering species are removed from scat_data_raw and scat_meta, i.e. removed from further calculations, if their particle size exceeds the specified limits. Specification of the scattering species is done by name matching the scattering species name part of scat_species tag. As size parameter, all size parameters reported by the meta data can be used (see scat_meta_single for offered parameters and their naming).

Author(s): Daniel Kreyling, Oliver Lemke, Jana Mendrok

Parameters:

  • scat_data_raw (ArrayOfArrayOfSingleScatteringData, optional) – Array of raw single scattering data. See scat_data_raw, defaults to self.scat_data_raw [INOUT]

  • scat_meta (ArrayOfArrayOfScatteringMetaData, optional) – An Array of scattering meta data (scat_meta_single). See scat_meta, defaults to self.scat_meta [INOUT]

  • scat_species (ArrayOfString, optional) – Array of Strings defining the scattering species to consider. See scat_species, defaults to self.scat_species [IN]

  • species (String) – Species on which to apply size selection. [IN]

  • sizeparam (String) – Size parameter to apply for size selection. [IN]

  • sizemin (Numeric, optional) – Minimum size [m] of the scattering elements to consider. Defaults to 0. [IN]

  • sizemax (Numeric, optional) – Maximum size [m] of the scattering elements to consider (if negative, no max. limitation is applied). Defaults to -1. [IN]

  • tolerance (Numeric, optional) – Relative numerical tolerance of size limit values. Defaults to 1e-6 [IN]

  • delim (String, optional) – Delimiter string of scat_species elements. Defaults to "-" [IN]

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