coadd_m5_analysis

rubin_sim.maf.maf_contrib.coadd_m5_analysis(path, dbfile, run_name, slair=False, wf_dand_dd_fs=False, no_dith_only=False, best_dith_only=False, some_dith_only=False, specified_dith=None, nside=128, filter_band='r', include_dust_extinction=False, saveun_masked_coadd_data=False, pixel_radius_for_masking=5, cut_off_year=None, plot_skymap=True, plot_cartview=True, unmasked_color_min=None, unmasked_color_max=None, masked_color_min=None, masked_color_max=None, n_ticks=5, plot_power_spectrum=True, show_plots=True, save_figs=True, alm_analysis=True, ra_range=[-50, 50], dec_range=[-65, 5], save_masked_coadd_data=True)

Analyze the artifacts induced in the coadded 5sigma depth due to imperfect observing strategy.

• Creates an output directory for subdirectories containing the specified things to save.

• Creates, shows, and saves comparison plots.

• Returns the metricBundle object containing the calculated coadded depth, and the output directory name.

Parameters:

path: str

path to the main directory where output directory is to be saved.

dbfile: str

path to the OpSim output file, e.g. to a copy of enigma_1189

run_name: str

run name tag to identify the output of specified OpSim output, e.g. ‘enigma1189’

slair: `bool`

set to True if analysis on a SLAIR output. Default: False

wf_dand_dd_fs: `bool`

set to True if want to consider both WFD survet and DDFs. Otherwise will only work with WFD. Default: False

no_dith_only: `bool`

set to True if only want to consider the undithered survey. Default: False

best_dith_only: `bool`

set to True if only want to consider RandomDitherFieldPerVisit. Default: False

some_dith_only: `bool`

set to True if only want to consider undithered and a few dithered surveys. Default: False

specified_dith: str

specific dither strategy to run. Default: None

nside: int

HEALpix resolution parameter. Default: 128

filter_band: str

any one of ‘u’, ‘g’, ‘r’, ‘i’, ‘z’, ‘y’. Default: ‘r’

include_dust_extinction: `bool`

set to include dust extinction. Default: False

saveun_masked_coadd_data: `bool`

set to True to save data before border masking. Default: False

pixel_radius_for_masking: int

number of pixels to mask along the shallow border. Default: 5

cut_off_year: 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

plot_skymap: `bool`

set to True if want to plot skymaps. Default: True

plot_cartview: `bool`

set to True if want to plot cartview plots. Default: False

unmasked_color_min: float

lower limit on the colorscale for unmasked skymaps. Default: None

unmasked_color_max: float

upper limit on the colorscale for unmasked skymaps. Default: None

masked_color_min: float

lower limit on the colorscale for border-masked skymaps. Default: None

masked_color_max: float

upper limit on the colorscale for border-masked skymaps. Default: None

n_ticks: int

(number of ticks - 1) on the skymap colorbar. Default: 5

plot_power_spectrum: `bool`

set to True if want to plot powerspectra. Default: True

show_plots: `bool`

set to True if want to show figures. Default: True

save_figs: `bool`

set to True if want to save figures. Default: True

alm_analysis: `bool`

set to True to perform the alm analysis. Default: True

ra_range: float array

range of right ascention (in degrees) to consider in alm cartview plot; applicable when alm_analysis=True. Default: [-50,50]

dec_range: float array

range of declination (in degrees) to consider in alm cartview plot; applicable when alm_analysis=True. Default: [-65,5]

save_masked_coadd_data: `bool`

set to True to save the coadded depth data after the border masking. Default: True