cortex.quickflat.composite.add_rois¶
- cortex.quickflat.composite.add_rois(fig: Axes, dataview: Dataview, extents: tuple[float, float, float, float] | None = None, height: int | None = None, with_labels: bool = True, roi_list: Sequence[str] | None = None, overlay_file: str | None = None, shadow: float | None = None, **kwargs) AxesImage[source]¶
Add ROIs layer to a figure
NOTE: zorder for rois is 3
- Parameters:
- figfigure or ax
figure into which to plot image of curvature
- dataviewcortex.Dataview object
dataview containing data to be plotted, subject (surface identifier), and transform.
- extentsarray-like
4 values for [Left, Right, Top, Bottom] extents of image plotted. None defaults to extents of images already present in figure.
- heightscalar
Height of image. None defaults to height of images already present in figure.
- with_labelsbool
Whether to display text labels on ROIs
- roi_list
- shadowfloat, optional
Standard deviation of the gaussian shadow. Set to 0 if you want no shadow. None (default) leaves the svg file’s own shadow setting untouched.
- kwargs
- Returns:
- imgmatplotlib.image.AxesImage
matplotlib axes image object for plotted data