gwinferno.preprocess.selection.get_o4a_cumulative_injection_dict

get_o4a_cumulative_injection_dict(file, param_names, ifar=1, snr=10)

Generates injection dataset with desired parameters and proper prior density calculated.

Args:

file (str): path to injection file param_names (list of strs): list of parameter names to work in. This should not include ‘prior’, as it will be generated automatically.

Valid parameter options are: ‘mass_1’, ‘mass_2’, ‘mass_ratio’, ‘redshift’, ‘a_1’, ‘a_2’, ‘cos_tilt_1’, ‘cos_tilt_2’. NOTE: ‘chi_eff’ and ‘chi_p’ cannot be accounted for here. Please use gwinferno.preprocess.data_collection.load_injection_dataset if you wish to work in ‘chi_eff’ and ‘chi_p’.

ifar (int or float, optional): Inverse false alarm rate threshold for found injections. Defaults to 1. snr (int or float, optional): signal to noise ratio threshold for found injections. Defaults to 10.

Returns:

DataArray: xarray DataArray of injection data.