Simulations🍋
SGS
🍋
Bases: Simulations
Sequential Gaussian Simulations Solver class.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
covariance_model
|
Union[Covariance, CovarianceElem]
|
Covariance used for distance computation. |
required |
neighborhood_model
|
Neighborhood
|
Neighborhood model used for weights computation. |
required |
axes
|
List[Coord]
|
If solver is 2D or 3D. |
[U, V, W]
|
Attributes:
| Name | Type | Description |
|---|---|---|
covariance_model |
Covariance used for distance computation. |
|
neighborhood_model |
Neighborhood model used for weights computation. |
|
axes |
If solver is 2D or 3D. |
covariance_model: Union[Covariance, CovarianceElem]
property
🍋
Return Covariance Model.
Returns:
| Type | Description |
|---|---|
Union[Covariance, CovarianceElem]
|
Covariance model. |
neighborhood_model: Neighborhood
property
🍋
solve(obj, obj_region, obj_attribute, support, support_region, support_attribute, simulations_number)
🍋
Solve SGS on a support using a conditioning object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj
|
Optional[GeoRefObject]
|
Conditioning Object. |
required |
obj_region
|
Optional[str]
|
Spatial subset of conditioning. |
required |
obj_attribute
|
Optional[str]
|
Property to estimate. |
required |
support
|
GeoRefObject
|
Object to estimate onto. |
required |
support_region
|
Optional[str]
|
Spatial subset of estimation. |
required |
support_attribute
|
str
|
Property name to add in support. |
required |
simulations_number
|
int
|
Number of simulations to be realized. |
required |
Raises:
| Type | Description |
|---|---|
Warning
|
Maximum allowed neighbors is higher than number of conditioning data. |
solve_api(neighborhood_model, covariance_model, dim, support_coords, simulations_number, obj_coords=None, obj_data=None)
staticmethod
🍋
Low-level SGS solving method.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
covariance_model
|
Covariance
|
Covariance used for distance computation. |
required |
neighborhood_model
|
Neighborhood
|
Neighborhood model used for weights computation. |
required |
dim
|
int
|
Number of dimensions. |
required |
support_coords
|
ndarray
|
Support coordinates in region along specified axes. |
required |
simulations_number
|
int
|
Number of simulations to be realized. |
required |
obj_coords
|
Optional[ndarray]
|
Conditioning object coordinates in region along specified axes. |
None
|
obj_data
|
Optional[ndarray]
|
Values in selected region. |
None
|
Returns:
| Type | Description |
|---|---|
ndarray
|
SGS results. |
Raises:
| Type | Description |
|---|---|
Warning
|
Maximum allowed neighbors is higher than number of conditioning data. |
Simulations
🍋
Bases: Entity
Simulations Solver class.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
covariance_model
|
Union[Covariance, CovarianceElem]
|
Covariance used for distance computation. |
required |
neighborhood_model
|
Neighborhood
|
Neighborhood model used for weights computation. |
required |
axes
|
List[Coord]
|
If solver is 2D or 3D. |
[U, V, W]
|
Attributes:
| Name | Type | Description |
|---|---|---|
covariance_model |
Union[Covariance, CovarianceElem]
|
Covariance used for distance computation. |
neighborhood_model |
Neighborhood model used for weights computation. |
|
axes |
If solver is 2D or 3D. |
covariance_model: Union[Covariance, CovarianceElem]
property
🍋
Return Covariance Model.
Returns:
| Type | Description |
|---|---|
Union[Covariance, CovarianceElem]
|
Covariance model. |
neighborhood_model: Neighborhood
property
🍋
solve()
abstractmethod
🍋
Use the defined method to interpolate onto target locations.