rubin_sim.maf.maf_contrib.os_bias_overplots(out_dir, data_paths, lim_mags_i, legend_labels, fsky_dith_dict, fsky_best, mock_data_path, run_name, theory_lim_mag, specified_dith_only=None, run_name_filetag=None, ell_min=100, ell_max=300, lmax=500, filters=['u', 'g', 'r', 'i'], nside=256, pixel_radius=14, yr_cutoff=None, zbin='0.66<z<1.0', poisson_noise=False, zero_pt=True, plot_interms=False, color_dict=None, ylim_min=None, ylim_max=None, show_plot=False, suptitle=None, file_append=None)

Calculate/plot the OS bias uncertainty and the statistical floor for the specified redshift bin.

Could vary the dither strategies, but the data should be from the same OpSim run. The title of of each panel in final plot will be <dither strategy>, and each panel can have OS bias uncertainity from many different galaxy catalogs. Panel legends will specify the redshift bin and the magnitude cut.

* out_dir: str: output directory where the output plots will be saved; a folder named

‘os_bias_overplots’ will be created in the directory, if its not there already.

* data_paths: list of strings: list of strings containing the paths where the artificialStructure data will be

found for the filters specified.

* lim_mags_i: list of floats: list of the i-band magnitude cuts to get the data for.
* legend_labels: list of strings: list of the ‘tags’ for each case; will be used in the legends. e.g. if

lim_mags_i=[24.0, 25.3], legend_labels could be [‘i<24.0’, ‘i<25.3’] or [‘r<24.4’, ‘i<25.7’] if want to label stuff with r-band limits.

* fsky_dith_dict: dict: dictionary containing the fraction of sky covered; keys should be the dither strategies.

The function get_fsky outputs the right dictionary.

* fsky_best: float: best fsky for the survey to compare everything relative to.
* mock_data_path: str: path to the mock data to consider
* run_name: str: run name tag to identify the output of specified OpSim output.
* theory_lim_mag: float: magnitude cut as the identifer in the filename from Hu.

Allowed options: 24.0, 25.6, 27.5

* specified_dith_only: list of string: list of the names (strings) of the dither strategies to consider, e.g.

if want to plot only NoDither, specified_dith_only= [‘NoDither’]. If nothing is specified, all the dither strategies will be considered (based on the npy files available for the runs). Default: None

* run_name_filtag: str: run name file tag. Default: None
* filters: list of strings: list containing the bands (in strings) to be used to calculate the OS bias

and its error. should contain AT LEAST two bands. e.g. if filters=[‘g’, ‘r’], OS bias (at every ell) will be calculated as the mean across g and r cls, while the bias error (at every ell) will be calculated as the std. dev. across g and r cls. Default: [‘u’, ‘g’, ‘r’, ‘i’]

* nside: int: HEALpix resolution parameter. Default: 256
* pixel_radius: int: number of pixels to mask along the shallow border. Default: 14
* yr_cutoff: int: year cut to restrict analysis to only a subset of the survey.

Must range from 1 to 9, or None for the full survey analysis (10 yrs). Default: None

* zbin: str: options include ‘0.15<z<0.37’, ‘0.37<z<0.66, ‘0.66<z<1.0’, ‘1.0<z<1.5’, ‘1.5<z<2.0’

Default: ‘0.66<z<1.0’

* poisson_noise: bool: set to True to consider the case where poisson noise is added to galaxy counts

after border masking (and the incorporation of calibration errors). Default: False

* zero_pt: bool: set to True to consider the case where 0pt calibration errors were incorporated.

Default: True

* plot_interms: bool: set to True to plot intermediate plots, e.g. BAO data. Default: False
* color_dict: dict: color dictionary; keys should be the indentifiers provided. Default: None
**** Please note that in-built colors are for only a few indentifiers:

‘r<24.0’], ‘r<25.7’,’r<27.5’, ‘r<22.0’, ‘i<24.0’, ‘i<25.3’,’i<27.5’, ‘i<22.’ **

* ylim_min: float: lower y-lim for the final plots. Defaut: None
* ylim_max: float: upper y-lim for the final plots. Defaut: None
* show_plot: bool: set to True if want to display the plot (aside from saving it). Default: False
* suptitle: str: title to plot. Default: None
* file_append: str: optional string to append to the saved plot