particle_bulkprop_fieldClip

Workspace.particle_bulkprop_fieldClip(self: pyarts.arts._Workspace, particle_bulkprop_field: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor4]] = self.particle_bulkprop_field, particle_bulkprop_names: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfString]] = self.particle_bulkprop_names, bulkprop_name: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], limit_low: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = -std::numeric_limits<Numeric>::infinity(), limit_high: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = std::numeric_limits<Numeric>::infinity(), verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Clipping of particle_bulkprop_field.

The method allows you to apply hard limits the values of particle_bulkprop_field. All values, of the property selected, below limit_low, are simply set to limit_low. And the same is performed with respect to limit_high. That is, the data in x for the retrieval quantity are forced to be inside the range [limit_low,limit_high].

Setting species=”ALL”, is a shortcut for applying the limits on all properties.

Author(s): Patrick Eriksson

Parameters:

  • particle_bulkprop_field (Tensor4, optional) – Container for various data that describes scattering bulk properties. See particle_bulkprop_field, defaults to self.particle_bulkprop_field [INOUT]

  • particle_bulkprop_names (ArrayOfString, optional) – Identification of the data in particle_bulkprop_field. See particle_bulkprop_names, defaults to self.particle_bulkprop_names [IN]

  • bulkprop_name (String) – Name of bulk property to consider, or “ALL”. [IN]

  • limit_low (Numeric, optional) – Lower limit for clipping. Defaults to -Inf [IN]

  • limit_high (Numeric, optional) – Upper limit for clipping. Defaults to Inf [IN]

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