Skip to content

Commit

Permalink
doc clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
cmbant committed Feb 17, 2025
1 parent 8ae9564 commit 3f4297e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion getdist/plots.py
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,7 @@ def add_2d_contours(self, root, param1=None, param2=None, plotno=0, of=None, col
to add to (defaults to current plot or the first/main plot if none)
:param mask_function: optional function, mask_function(minx, miny, stepx, stepy, mask),
which which sets mask to zero for values of parameter name that are excluded by prior.
This is used to correctly estimate densities near the boundary.
See the example in the plot gallery.
:param kwargs: optional keyword arguments:
Expand Down Expand Up @@ -1687,7 +1688,10 @@ def plot_2d(self, roots, param1=None, param2=None, param_pair=None, shaded=False
:param proxy_root_exclude: any root names not to include when adding to the legend proxy
:param ax: optional :class:`~matplotlib:matplotlib.axes.Axes` instance (or y,x subplot coordinate)
to add to (defaults to current plot or the first/main plot if none)
:param mask_function: Function that defines regions in the 2D parameter space to exclude from the plot.
:param mask_function: Function that defines regions in the 2D parameter space that are excluded by a prior,
which is needed to correctly estimate kernel densities near the sharp boundary defined by the mask
function.
Must have signature mask_function(minx, miny, stepx, stepy, mask), where:
* minx, miny: minimum values of x and y parameters
Expand Down

0 comments on commit 3f4297e

Please sign in to comment.