FitnessFunc#

class scikitplot._astropy.stats.FitnessFunc(p0=0.05, gamma=None, ncp_prior=None)[source]#

Base class for bayesian blocks fitness functions.

Derived classes should overload the following method:

fitness(self, **kwargs):

Compute the fitness given a set of named arguments. Arguments accepted by fitness must be among [T_k, N_k, a_k, b_k, c_k] (See [1] for details on the meaning of these parameters).

Additionally, other methods may be overloaded as well:

__init__(self, **kwargs):

Initialize the fitness function with any parameters beyond the normal p0 and gamma.

validate_input(self, t, x, sigma):

Enable specific checks of the input data (t, x, sigma) to be performed prior to the fit.

compute_ncp_prior(self, N): If ncp_prior is not defined explicitly,

this function is called in order to define it before fitting. This may be calculated from gamma, p0, or whatever method you choose.

p0_prior(self, N):

Specify the form of the prior given the false-alarm probability p0 (See [1] for details).

For examples of implemented fitness functions, see Events, RegularEvents, and PointMeasures.

References

Parameters:
compute_ncp_prior(N)[source]#

If ncp_prior is not explicitly defined, compute it from gamma or p0.

Parameters:

N (int)

Return type:

float

fit(t, x=None, sigma=None)[source]#

Fit the Bayesian Blocks model given the specified fitness function.

Parameters:
tarray-like

data times (one dimensional, length N)

xarray-like, optional

data values

sigmaarray-like or float, optional

data errors

Returns:
edgesndarray

array containing the (M+1) edges defining the M optimal bins

Parameters:

  • t (ArrayLike)

  • x (ArrayLike | None)

  • sigma (ArrayLike | float | None)

Return type:

NDArray[float]

fitness(**kwargs)[source]#
p0_prior(N)[source]#

Empirical prior, parametrized by the false alarm probability p0.

See eq. 21 in Scargle (2013).

Note that there was an error in this equation in the original Scargle paper (the “log” was missing). The following corrected form is taken from https://arxiv.org/abs/1304.2818

Parameters:

N (int)

Return type:

float

validate_input(t, x=None, sigma=None)[source]#

Validate inputs to the model.

Parameters:
tarray-like

times of observations

xarray-like, optional

values observed at each time

sigmafloat or array-like, optional

errors in values x

Returns:
t, x, sigmaarray-like, float

validated and perhaps modified versions of inputs

Parameters:

  • t (ArrayLike)

  • x (ArrayLike | None)

  • sigma (float | ArrayLike | None)

Return type:

tuple[NDArray[float], NDArray[float], NDArray[float]]