multicolorfits.plot_combined_rgb#

multicolorfits.plot_combined_rgb(multicolorin, hdrin, axtitle, savepath, xaxislabel='RA', yaxislabel='DEC', tickcolor='w', labelcolor='k', facecolor='w', minorticks=True, dpi=150, legend=None, legend_loc='upper right', legend_inverse=False, band_labels=None, band_labels_loc='upper left', swatch=None, swatch_loc='lower right', swatch_labels=False, swatch_label_offset=0.62, swatch_inset_scale=0.24, show_compass=False, compass_loc='lower left', show_beam=False, beam_loc='lower left', beam_style='crosshair', show_scale_bar=False, scale_bar_asec=0.0, scale_bar_loc=4, bare_plot=False)[source]#

Plot a multicolor RGB image with WCS axes and save it to disk.

Tick and label colors accept any matplotlib color ('k', 'black', '#000000', '0.0', …).

Parameters:

  • multicolorin (array) – Multicolor RGB image – as would be output from combine_multicolor()

  • hdrin (astropy.io.fits.header) – Header to use for WCS information

  • axtitle (str) – String to use for plot title. e.g. “My crazy 5-color image”, or empty quotes “” for nothing.

  • savepath (str) – Path to save file to. e.g., “./plots/mycrazyimage.pdf”

  • xaxislabel (str) – Label to use for x-axis. Default=’RA’

  • yaxislabel (str) – Label to use for y-axis. Default=’DEC’

  • tickcolor (str) – Color to use for ticks in plot, default = ‘w’.

  • labelcolor (str) – Color to use for ticklabels, default = ‘k’

  • facecolor (str) – Color to use for figure facecolor (border around plot), default =’w’

  • minorticks (bool) – True to use minor ticks

  • dpi (int) – Default=150. Dots per inch value to use for saved plot.

  • legend (list of (color, label) or None) – If given, draw a channel legend (which color = which image) over the image using these (matplotlib_color, str) entries. Default None.

  • legend_loc (str) – Matplotlib legend location, e.g. ‘upper right’. Default=’upper right’.

  • legend_inverse (bool) – Set True when the combined image was made with inverse=True (light background) so legend text/frame colors stay readable. Default False.

  • band_labels (list of (color, label) or None) – If given, draw colored per-band text labels in a corner (each label in its channel color). Default None.

  • band_labels_loc (str) – Corner for band labels: ‘upper left’/’upper right’/’lower left’/’lower right’. Default ‘upper left’.

  • swatch (dict or None) – Pre-rendered color-combination swatch from mcf.combo_swatch(...) (keys ‘rgba’, ‘circles’, ‘size’). If given, drawn as a floating corner inset showing the honest overlapping mixed colors. Default None.

  • swatch_loc (str) – Corner for the swatch inset. Default ‘lower right’.

  • swatch_labels (bool) – Label each swatch circle in its color. Default False.

  • swatch_label_offset (float) – Radial push for swatch circle labels (fraction of radius). Default 0.62.

  • swatch_inset_scale (float) – Corner inset size as a fraction of the axes (0.08–0.45). Default 0.24.

  • show_compass (bool) – Optional skyplothelper overlays (require multicolorfits[overlays]).

  • show_beam (bool) – Optional skyplothelper overlays (require multicolorfits[overlays]).

  • show_scale_bar (bool) – Optional skyplothelper overlays (require multicolorfits[overlays]).

  • compass_loc (str) – Corner placement for compass / beam overlays.

  • beam_loc (str) – Corner placement for compass / beam overlays.

  • beam_style (str) – Beam style passed to skyplothelper (e.g. 'crosshair').

  • scale_bar_asec (float) – Scale-bar length in arcsec; 0 selects an automatic length.

  • scale_bar_loc (int) – Matplotlib anchored-artist location code (1–4) for the scale bar.