cortex.quickflat.composite.add_sulci¶
- cortex.quickflat.composite.add_sulci(fig: Axes, dataview: Dataview, extents: tuple[float, float, float, float] | None = None, height: int | None = None, with_labels: bool = True, sulci_list: Sequence[str] | None = None, overlay_file: str | None = None, shadow: float | None = None, **kwargs) AxesImage[source]¶
Add sulci layer to figure
- 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 for sulci
- sulci_listlist
List of sulci to include
- 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.
- Returns:
- imgmatplotlib.image.AxesImage
matplotlib axes image object for plotted data
- Other Parameters:
- kwargskeyword arguments
Keywords args govern line appearance in final plot. Allowable kwargs are : linewidth, linecolor