galpy.util.bovy_plot.bovy_hist

galpy.util.bovy_plot.bovy_hist(x, xlabel=None, ylabel=None, overplot=False, **kwargs)

NAME:

bovy_hist

PURPOSE:

wrapper around matplotlib’s hist function

INPUT:

x - array to histogram

xlabel - (raw string!) x-axis label, LaTeX math mode, no $s needed

ylabel - (raw string!) y-axis label, LaTeX math mode, no $s needed

yrange - set the y-axis range

+all pyplot.hist keywords

OUTPUT:

(from the matplotlib docs: http://matplotlib.sourceforge.net/api/pyplot_api.html#matplotlib.pyplot.hist)

The return value is a tuple (n, bins, patches) or ([n0, n1, ...], bins, [patches0, patches1,...]) if the input contains multiple data

HISTORY:

2009-12-23 - Written - Bovy (NYU)