getdist.plots.get_subplot_plotter

getdist.plots.get_subplot_plotter(subplot_size: Optional[float] = None, width_inch: Optional[float] = None, scaling: Optional[bool] = None, rc_sizes=False, subplot_size_ratio: Optional[float] = None, style: Optional[str] = None, **kwargs) → GetDistPlotter[source]

Get a GetDistPlotter for making an array of subplots.

If width_inch is None, just makes plot as big as needed for given subplot_size, otherwise fixes total width and sets default font sizes etc. from matplotlib’s default rcParams.

Use this or get_single_plotter() to make a GetDistPlotter instance for making plots. This function will use the active style by default, which will determine defaults for the various optional parameters (see set_active_style()).

Parameters

  • subplot_size – The size of each subplot in inches

  • width_inch – Optional total width in inches

  • scaling – whether to scale down fonts and line widths for small sizes (relative to reference sizes, 3.5 inch)

  • rc_sizes – set default font sizes from matplotlib’s current rcParams if no explicit settings passed in kwargs

  • subplot_size_ratio – ratio of height to width for subplots

  • style – name of a plotter style (associated with custom plotter class/settings), otherwise uses active

  • kwargs – arguments for GetDistPlotter

Returns

The GetDistPlotter instance