Class Plot

surfplot/plotting.py:169–551

Plot brain surfaces with data layers Parameters ---------- surf_lh, surf_rh : str or os.PathLike or BSPolyData, optional Left and right hemisphere cortical surfaces, either as a file path to a valid surface file (e.g., .gii. .surf) or a pre-loaded surface from

class Plot(object):
    """Plot brain surfaces with data layers

    Parameters
    ----------
    surf_lh, surf_rh : str or os.PathLike or BSPolyData, optional
        Left and right hemisphere cortical surfaces, either as a file path 
        to a valid surface file (e.g., .gii. .surf) or a pre-loaded 
        surface from :func:`brainspace.mesh.mesh_io.read_surface`. At least one 
        hemisphere must be provided. Default: None
    layout : {'grid', 'column', 'row'}, optional
        Layout in which to plot brain surfaces. 'row' plots brains as a 
        single row ordered from left-to-right hemispheres (if applicable), 
        'column' plots brains as a single column descending from 
        left-to-right hemispheres (if applicable). 'grid' plots surfaces 
        as a views-by-hemisphere (left-right) array; if only one 
        hemipshere is provided, then 'grid' is equivalent to 'row'. By 
        default 'grid'.
    views : {'lateral', 'medial', 'dorsal', 'ventral', 'anterior', 
                'posterior'}, str or list[str], optional
        Views to plot for each provided hemisphere. Views are plotted in 
        in the order they are provided. If None, then lateral and medial
        views are plotted. Default: None
    mirror_views : bool, optional
        Flip the order of the right hemisphere views for 'row' or 'column' 
        layouts, such that they mirror the left hemisphere views. Ignored if 
        `surf_rh` is None and `layout` is 'grid'. 
    flip : bool, optional
        Flip the display order of left and right hemispheres in `grid` or 
        `row` layouts, if applicable. Useful when showing only 'anterior` 
        or 'inferior' views. Default: False
    size : tuple of int, optional
        The size of the space to plot surfaces, defined by (width, height). 
        Note that this differs from `figsize` in Plot.build(), which 
        determines the overall figure size for the matplotlib figure. 
        Default: (500, 400)
    zoom : int, optional
        Level of zoom to apply. Default: 1.5
    background : tuple, optional
        Background color, default: (1, 1, 1)
    label_text : dict[str, array-like], optional
        Brainspace label text for column/row. Possible keys are 
        {‘left’, ‘right’, ‘top’, ‘bottom’}, which indicate the location. 
        See brainspace.plotting.surface_plotting.plot_surf for more 
        details Default: None. 
    brightness : float, optional
        Brightness of plain gray surface. 0 = black, 1 = white. Default: 
        .5
    
    Raises
    ------
    ValueError
        Neither `surf_lh` or `surf_rh` are provided
    """
    def __init__(self, surf_lh=None, surf_rh=None, layout='grid', views=None, 
                 mirror_views=False, flip=False, size=(500, 400), zoom=1.5, 
                 background=(1, 1, 1), label_text=None, brightness=.5):
        hemi_inputs = zip(['left', 'right'], [surf_lh, surf_rh])