cloudboxSetManually

Workspace.cloudboxSetManually(self: pyarts.arts._Workspace, cloudbox_on: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.cloudbox_on, cloudbox_limits: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfIndex]] = self.cloudbox_limits, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, p_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.p_grid, lat_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lat_grid, lon_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lon_grid, p1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], p2: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], lat1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], lat2: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], lon1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], lon2: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Sets the cloud box to encompass the given positions.

The function sets cloudbox_on to 1 and sets cloudbox_limits following the given pressure, latitude and longitude positions. The index limits in cloudbox_limits are selected to give the smallest possible cloud box that encompass the given points.

The points must be given in the same order as used in cloudbox_limits. That means that the first keyword argument shall be a higher pressure than argument two, while the latitude and longitude points are given in increasing order. Positions given for dimensions not used by the selected atmospheric dimensionality are ignored.

The given pressure points can be outside the range of p_grid. The pressure limit is then set to the end point of p_grid. The given latitude and longitude points must be inside the range of the corresponding grid. In addition, the latitude and longitude points cannot be inside the outermost grid ranges as the latitude and longitude limits in cloudbox_limits are not allowed to be grid end points.

Author(s): Patrick Eriksson

Parameters:

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

  • cloudbox_limits (ArrayOfIndex, optional) – The limits of the cloud box. See cloudbox_limits, defaults to self.cloudbox_limits [OUT]

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

  • p_grid (Vector, optional) – The pressure grid. See p_grid, defaults to self.p_grid [IN]

  • lat_grid (Vector, optional) – The latitude grid. See lat_grid, defaults to self.lat_grid [IN]

  • lon_grid (Vector, optional) – The longitude grid. See lon_grid, defaults to self.lon_grid [IN]

  • p1 (Numeric) – Upper pressure point. [IN]

  • p2 (Numeric) – Lower pressure point. [IN]

  • lat1 (Numeric) – Lower latitude point. [IN]

  • lat2 (Numeric) – Upper latitude point. [IN]

  • lon1 (Numeric) – Lower longitude point. [IN]

  • lon2 (Numeric) – Upper longitude point. [IN]

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