Correlation

correlation_heatmap(geo_object, properties=None, region=None, **kwargs)

Return the correlation between given properties belonging to a single GeoRefObject as well as the number of points used to calculate each of them when the concerned cell is hovered. If properties parameter is None then a list of properties is built including all the objects properties excluding built-in and internal ones.

Parameters:

Name	Type	Description	Default
geo_object	GeoRefObject	GeoRefObject (e.g. DrillHoles, BlockModel, Surface, etc.).	required
properties	Optional[List[str]]	List of properties belonging to the geo_object to plot or None if a plot of every property (minus built-in and internal properties) of the GeoRefObject is wanted. Default value is None.	None
region	Optional[str]	Object region or condition to select data from.	None
**kwargs		Extra arguments to pass along to Plotly - Update Layout, arguments available at Plotly - Layout.	{}

Returns:

Type	Description
Figure	Plotly Figure.

scatter_correlation(geo_object, properties=None, region=None, normalization_coefficient=20, **kwargs)

Return the correlation coefficient between given properties belonging to a single GeoRefObject as well as the number of points used to calculate each of them. If properties parameter is None then a list of properties is built including all the objects properties excluding built-in and internal ones. The point size represents the number of points available to perform the calculation and the color refers to the correlation coefficient.

Parameters:

Name	Type	Description	Default
geo_object	GeoRefObject	GeoRefObject (e.g. DrillHoles, BlockModel, Surface, etc.).	required
properties	Optional[List[str]]	List of properties belonging to the geo_object to plot or None if a plot of every property (minus built-in and internal properties) of the GeoRefObject is wanted. Default value is None.	None
region	Optional[str]	Object region or condition to select data from.	None
normalization_coefficient	int	Point size of the biggest point displayed.	20
**kwargs		Extra arguments to pass along to Plotly - Update Layout, arguments available at Plotly - Layout.	{}

Returns:

Type	Description
Figure	Plotly Figure.

---

Last update: 2022-12-23