limiting_mags

simcado.simulation.limiting_mags(exptimes=None, filter_names=None, AB_corrs=None, limiting_sigma=5, return_mags=True, make_graph=False, mmin=22, mmax=31, cmds=None, **kwargs)

Return or plot a graph of the limiting magnitudes for MICADO

Parameters

exptimesarray

[s] Exposure times for which limiting magnitudes should be found

filter_nameslist

A list of filters. See simcado.optics.get_filter_set()

AB_corrslist

[mag] A list of magnitude corrections to convert from Vega to AB magnitudes

limiting_sigmafloat

[sigma] The number of sigmas to use to define the limiting magnitude. Default is 5*sigma

return_magsbool

If True (defualt), the limiting magnitude are returned

make_graphbool

If True (defualt), a graph of the limiting magnitudes vs exposure time is plotted Calls plot_exptime_vs_limiting_mag()

cmdssimcado.UserCommands

A custom set of commands for building the optical train

Returns

mags_alllist

[mag] If return_mags=True, returns a list of limiting magnitudes for each exposure time for each filter Dimensions are [n, m] where n is the number of filters and m is the number of exposure times passed

Notes

Vega to AB = {“J” : 0.91 , “H” : 1.39 , “Ks” : 1.85}

Examples

:

>>> # Set 30 logarithmic time bins between 1 sec and 5 hours
>>> exptimes = np.logspace(0, np.log10(18000), num=30, endpoint=True)
>>> limiting_mags(exptimes=exptimes, filter_names=["J", "PaBeta"],
...               make_graph=False)