SimPEG.utils.GaussianMixtureWithNonlinearRelationships

class SimPEG.utils.GaussianMixtureWithNonlinearRelationships(mesh, n_components=1, covariance_type='full', tol=0.001, reg_covar=1e-06, max_iter=100, n_init=1, init_params='kmeans', weights_init=None, means_init=None, precisions_init=None, random_state=None, warm_start=False, verbose=0, verbose_interval=10, cluster_mapping=None)

Bases: SimPEG.utils.pgi_utils.WeightedGaussianMixture

Gaussian mixture class for non-linear relationships.

This class built upon the WeightedGaussianMixture, which itself built upon from the mixture.gaussian_mixture.GaussianMixture class from Scikit-Learn.

In addition to weights samples/observations by the cells volume of the mesh, this class can be given specified nonlinear relationships between physical properties. (polynomial etc.) Those nonlinear relationships are given in the form of a list of mapping (cluster_mapping argument). Functions are added and modified to fill that purpose, in particular the fit and samples functions.

Disclaimer: this class built upon the GaussianMixture class from Scikit-Learn. New functionalitie are added, as well as modifications to existing functions, to serve the purposes pursued within SimPEG. This use is allowed by the Scikit-Learn licensing (BSD-3-Clause License) and we are grateful for their contributions to the open-source community.

Addtional parameters to provide, compared to WeightedGaussianMixture:

Parameters

cluster_mapping(n_components) list

List of mapping describing a nonlinear relationships between physical properties; one per cluster/unit.

Methods

sample([n_samples])

[modified from Scikit-Learn.mixture.gaussian_mixture] Generate random samples from the fitted Gaussian distribution with nonlinear relationships.

Galleries and Tutorials using SimPEG.utils.GaussianMixtureWithNonlinearRelationships

Petrophysically guided inversion: Joint linear example with nonlinear relationships

Petrophysically guided inversion: Joint linear example with nonlinear relationships