SymmetricGPO

class SymmetricGPO[source]

Bases: OverbounderBase

Represents a Symmetric Gaussian-Pareto Overbounder object.

__init__()[source]

Initialize an object.

Parameters:
  • inside_pierce_locator (float) – Determines the proportional factor on the sample standard deviation for the lower bound on the overbound enforcement in the core region. The default is 1 and should not be changed unless for experimental purposes.

  • ThresholdReductionFactor (int) – Dividing factor for reduction of the space over which the search is conducted for a threshold. Currently, this feature is not implemented so there is no purpose in altering it.

Return type:

None.

Methods

__init__

Initialize an object.

overbound

Produce Symmetric Gaussian-Pareto model object that overbounds input error data.

overbound(data)[source]

Produce Symmetric Gaussian-Pareto model object that overbounds input error data.

Parameters:

data (N numpy array) – Array containing sample of error data to be overbounded.

Returns:

Symmetric Gaussian-Pareto distribution object which overbounds the input data.

Return type:

serums.models.SymmetricGaussianPareto