pint.plot_utils.phaseogram

pint.plot_utils.phaseogram(mjds_in, phases, weights=None, title=None, bins=100, rotate=0.0, size=5, alpha=0.25, width=6, maxphs=2.0, plotfile=None, binned=False)[source]

Make a nice 2-panel phaseogram

Makes a phaseogram of photons with phases, with a point for each photon that can have a transparency determined by an array of weights.

Parameters:

  • mjds_in (array or astropy.units.Quantity or astropy.time.Time) – Assumes units of days if bare numerical array, otherwise will convert Quantity or Time into days.

  • phases (array) – Phases for each photon, assumes range is [0,1)

  • weights (array) – A [0,1] probability weight for each photon.

  • title (string) – The title for the upper (histogram) axis.

  • bins (integer) – The number of bins to include in the histogram(s).

  • rotate (float) – An optional [0,1] phase shift for display.

  • size (integer) – The marker size for the 2-d scatter plot (if not binned).

  • alpha (float) – If weights aren’t provided, a transparency parameter.

  • width (float) – Figure width in inches.

  • maxphs (float) – The maximum x-range to plot.

  • plotfile (str) – An output file name for the histogram.

  • binned (boolean) – Either bin the 2-d portion of the plot of scatter plot each photon.