PlotDefaults.caps2surf#

static PlotDefaults.caps2surf()[source]#

Plotting defaults for CAP.caps2surf.

Returns:

dict[str, Any] – Default parameters for surface plots:

  • General Figure Parameters:

    • dpiint, default=300 –

      Dots per inch for the plot.

    • title_padint, default=-3 –

      Padding for the plot title.

    • bbox_inchesstr, default=”tight” –

      Alters size of the whitespace in the saved image.

  • Color Parameters:

    • cmapstr or callable, default=”cold_hot” –

      Colormap to be used for the plot.

    • cbar_kwsdict, default={“location”: “bottom”, “n_ticks”: 3} –

      Customizes colorbar.

    • color_rangetuple or None, default=None –

      The minimum and maximum value to display in plots (min, max).

    • alphafloat or int, default=1 –

      Transparency level of the colorbar (0=transparent, 1=opaque).

    • zero_transparentbool, default=True –

      Turns vertices with a value of 0 transparent.

  • Surface Parameters:

    • surface: {“inflated”, “veryinflated”}, default=”inflated” –

      The surface atlas used for plotting.

    • viewslist, default=[“lateral”, “medial”] –

      Views to be displayed in the plot.

    • as_outlinebool, default=False –

      Plots only an outline of contiguous vertices with the same value.

    • outline_alphafloat, default=1 –

      Transparency level of the colorbar for outline if as_outline is True.

  • Brightness, Layout, Sizing, and Parameters:

    • sizetuple, default=(500, 400) –

      Size of the plot in pixels.

    • layoutstr, default=”grid” –

      Layout of the plot.

    • zoomfloat, default=1.5 –

      Zoom level for the plot.

    • brightnessfloat, default=0.5 –

      Brightness level of the plot.

    • figsizetuple or None, default=None –

      Size of the figure.

    • scaletuple, default=(2, 2) –

      Scale factors for the plot.

Note

For “cbar_kws”, refer to _add_colorbars for surfplot.plotting.Plot in Surfplot’s Plot Documentation for valid parameters.