covmat1D

Workspace.covmat1D(self: pyarts.arts._Workspace, output: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix, pyarts.arts.Sparse], grid_1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], grid_2: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = Vector{}, sigma_1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], sigma_2: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = Vector{}, cls_1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], cls_2: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = Vector{}, co: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 0.0, fname: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Create 1D covariance matrix.

Creates a 1D covariance matrix for two retrieval quantities on given grids from a given functional form. Elements of the covariance matrix are computed as:

S_{i,j} = sigma_i * sigma_j * f(d_{i,j} / l_{i,j})

where d_{i,j} is the distance between the two grid points and l_{i,j} the mean of the correlation lengths of the grid points.

If a cutoff value co is given elements with absolute value less than this are set to zero.

The following functional forms are available:

  • "exp": f(x) = exp(-x)

  • "lin": f(x) = 1.0 - x, for x > 1.0, 0.0 otherwise

  • "gauss": f(x) = exp(-x^2)

Author(s): Simon Pfreundschuh

Parameters:

  • output (Matrix or Sparse) – The matrix in which to store the covariance matrix. [OUT]

  • grid_1 (Vector) – The retrieval grid for the first retrieval quantity. [IN]

  • grid_2 (Vector, optional) – The retrieval grid for the second retrieval quantity. (If empty taken as grid_1). Defaults to [] [IN]

  • sigma_1 (Vector) – The variances of the first retrieval quantity. [IN]

  • sigma_2 (Vector, optional) – The variances of the second retrieval quantity.(If empty taken as sigma_1). Defaults to [] [IN]

  • cls_1 (Vector) – The correlations lengths of the first retrieval quantity. [IN]

  • cls_2 (Vector, optional) – The correlations lengths of the second retrieval quantity.(If empty taken as cls_1). Defaults to [] [IN]

  • co (Numeric, optional) – The cutoff value for covariance matrix elements. Defaults to 0.0 [IN]

  • fname (String) – The name of the functional form to use. [IN]

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