@@ -19,6 +19,7 @@ Regular axis
1919 :align: center
2020
2121.. py :function :: bh.axis.Regular(bins, start, stop, * , metadata = " " , underflow = True , overflow = True , circular = False , growth = False , transform = None )
22+ :noindex:
2223
2324The regular axis can have overflow and/or underflow bins (enabled by default). It can also grow if ``growth=True `` is given. In general, you should not mix options, as growing axis will already have the correct flow bin settings. The exception is ``underflow=False, overflow=False ``, which is quite useful together to make an axis with no flow bins at all.
2425
@@ -29,6 +30,7 @@ There are some other useful axis types based on regular axis:
2930 :align: center
3031
3132.. py :function :: bh.axis.Regular(... , circular = True )
33+ :noindex:
3234
3335 This wraps around, so that out-of-range values map back into the valid range circularly.
3436
@@ -48,14 +50,17 @@ functions, you can keep the high performance you would expect from a Regular axi
4850precompiled transforms:
4951
5052.. py :function :: bh.axis.Regular(... , transform = bh.axis.transform.sqrt)
53+ :noindex:
5154
5255 This is an axis with bins transformed by a sqrt.
5356
5457.. py :function :: bh.axis.Regular(... , transform = bh.axis.transform.log)
58+ :noindex:
5559
5660 Transformed by log.
5761
5862.. py :function :: bh.axis.Regular(... , transform = bh.axis.transform.Power(v))
63+ :noindex:
5964
6065 Transformed by a power (the argument is the power).
6166
@@ -68,6 +73,7 @@ Variable axis
6873 :align: center
6974
7075.. py :function :: bh.axis.Variable([edge1, ... ], * , metadata = " " , underflow = True , overflow = True , circular = False , growth = False )
76+ :noindex:
7177
7278 You can set the bin edges explicitly with a variable axis. The options are mostly the same as the Regular axis.
7379
@@ -79,6 +85,7 @@ Integer axis
7985 :align: center
8086
8187.. py :function :: bh.axis.Integer(start, stop, * , metadata = " " , underflow = True , overflow = True , circular = False , growth = False )
88+ :noindex:
8289
8390 This could be mimicked with a regular axis, but is simpler and slightly faster. Bins are whole integers only,
8491 so there is no need to specify the number of bins.
@@ -88,6 +95,7 @@ One common use for an integer axis could be a true/false axis:
8895.. code :: python3
8996
9097 bool_axis = bh.axis.Integer(0, 2, underflow=False, overflow=False)
98+ :noindex:
9199
92100 Another could be for an IntEnum (Python 3 or backport) if the values are contiguous.
93101
@@ -99,6 +107,7 @@ Category axis
99107 :align: center
100108
101109.. py :function :: bh.axis.IntCategory([value1, ... ], metadata = " " , grow = False )
110+ :noindex:
102111
103112 You should put integers in a category axis; but unlike an integer axis, the integers do not need to be adjacent.
104113
@@ -113,9 +122,11 @@ One use for an IntCategory axis is for an IntEnum (Python 3):
113122 b = 5
114123
115124 my_enum_axis = bh.axis.IntEnum(list(MyEnum), underflow=False, overflow=False)
125+ :noindex:
116126
117127
118128 .. py :function :: bh.axis.StrCategory([str1, ... ], metadata = " " , grow = False )
129+ :noindex:
119130
120131 You can put strings in a category axis as well. The fill method supports lists or arrays of strings
121132 to allow this to be filled.
0 commit comments