Skip to content

Commit b9e8a41

Browse files
committed
mask_function doc
1 parent c680ab6 commit b9e8a41

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

getdist/plots.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1689,9 +1689,11 @@ def plot_2d(self, roots, param1=None, param2=None, param_pair=None, shaded=False
16891689
to add to (defaults to current plot or the first/main plot if none)
16901690
:param mask_function: Function that defines regions in the 2D parameter space to exclude from the plot.
16911691
Must have signature mask_function(minx, miny, stepx, stepy, mask), where:
1692-
- minx, miny: minimum values of x and y parameters
1693-
- stepx, stepy: step sizes in x and y directions
1694-
- mask: 2D boolean numpy array (modified in-place)
1692+
1693+
* minx, miny: minimum values of x and y parameters
1694+
* stepx, stepy: step sizes in x and y directions
1695+
* mask: 2D boolean numpy array (modified in-place)
1696+
16951697
The function should set mask values to 0 where points should be excluded by the prior.
16961698
Useful for implementing non-rectangular prior boundaries not aligned with parameter axes,
16971699
- see the example in the plot gallery.

0 commit comments

Comments
 (0)