API Reference#

madcubapy.regions Package#

The madcubapy.regions package provides utility functions to work with Regions of Interest (rois) in different formats. This package allows the use of roi files from MADCUBA (.mcroi), DS9 (.ds9), and CARTA (.crtf) roi formats, alongside a custom format (.pyroi).

Functions#

export_roi(patch, filename[, format, ...])

Export a region of interest (ROI) to a specified file format.

import_region_contourset(ax, contour[, ...])

Import one contour region from a contour object into the selected axes.

import_region_patch(ax, contour[, index, ...])

Import one contour region from a contour object into the selected axes as a matplotlib patch.

import_roi(input_file[, fitsmap, log])

Import a RoI file as a matplotlib patch.

select_contour_regions(contour[, fig, ax, ...])

Shows the regions contained in a contour object in a pop-up window and lets the user select closed contours as regions.