API reference#
Public names are re-exported from the top-level package
(import multicolorfits as mcf), matching the historical flat namespace.
Grouped by topic below; each page lists functions and classes with
signatures pulled from the source.
Every v2.x name (greyRGBize_image, saveRGBfits, reproject2D, …)
still works as a silent alias for its renamed v3 counterpart; the full
old-to-new table is in Migrating from v2, and the mapping is importable
as mcf.LEGACY_ALIASES.
- Getting oriented
- Color pipeline
- Compositing
- WCS & FITS
- Session
- Figures
- Palettes
- multicolorfits.get_palette
- multicolorfits.list_palettes
- multicolorfits.suggest_colors
- multicolorfits.palettes.list_hue_patterns
- multicolorfits.palettes.list_palette_menu
- multicolorfits.palettes.colors_for_hue_pattern
- multicolorfits.palettes.rotate_colors_from_base
- multicolorfits.palettes.check_palette_colorblind
- Overlays
- multicolorfits.overlays_available
- multicolorfits.overlays.add_compass
- multicolorfits.overlays.add_beam
- multicolorfits.overlays.add_scale_bar
- multicolorfits.overlays.apply_overlays
- multicolorfits.overlays.apply_compose_overlays
- multicolorfits.overlays.offset_coord_wcs
- multicolorfits.overlays.make_offset_figure
- multicolorfits.overlays.require_overlays
- High-level pipeline
- GUIs
mcf.overview() / mcf.recipes() and the generated llms.txt corpus.
to_grey_rgb, colorize_image, combine_multicolor, stretching helpers.
Lab / HSV / HSL, RYB / CMYK, backgrounds, combine_colorized_layers, swatches.
McfHeader, squeeze/crop, coordinates, reprojection helpers.
McfSession, PanelState, ComposeState, save/load, export script.
Combined WCS figures, component mosaics, bare/publication styling.
Curated palettes, hue patterns, color-vision checks.
Optional compass / beam / scale bar ([overlays] / skyplothelper).
combine_layers, combine_from_files, save_combined, stack align.
gui, gui_qt, gui_embed, notebook helpers.