Match

cosmic.Match.dat_transform(dat, dat_list)

Transform a data set to have limits between zero and one using param_transform, then transform to log space

Parameters:
dat “ DataFrame

Data to transform to eventually perform KDE

dat_listlist

List of DataFrame columns to include in transformation

Returns:
dat_transarray

Transformed data for columns in dat_list

cosmic.Match.match(dataCm)

Performs the Match calculation in Eq. 1 of Breivik & Larson (2018)

Parameters:
dataCmlist

List of two cumulative data sets for a single paramter

Returns:
matchlist

List of matches for each cumulative data set

binwidthfloat

Binwidth of histograms used for match computation

cosmic.Match.perform_convergence(conv_params, conv_1, conv_2, log_file)

Performs the convergence calculations for each convergence parameter and binary state

Parameters:
conv_paramsdict

List of user supplied convergence parameters

conv_1DataFrame

Cumulative data set of conv arrays

conv_2DataFrame

Most recent data set of conv array from most recent BSE run

log_filefile write

File to log matches or if the convergence params are not appropriate e.g. eccentricity for a disrupted system

Returns:
matcharray

Matches for each cumulative data set