Custom types used in jackHI¶
jackHI contains custom Python types used throughout the code. These are defined as:
| Alias | Underlying Python Type | Description / Usage |
|---|---|---|
BArr |
npt.NDArray[np.bool_] |
Boolean mask array used for indexing and data filtering. |
DVar |
np.float64 | float |
Scalar value for floating-point data variables. |
IVar |
np.int32 | int |
Scalar value for integer data variables (e.g., bin numbers). |
TArr |
npt.NDArray |
Generic NumPy array layout shorthand. |
DArr |
npt.NDArray[np.float64] |
High-precision float array containing numerical input data. |
DList |
list[DVar] |
Python list containing float or np.float64 elements. |
IArr |
npt.NDArray[np.int32] |
Integer array containing generated indices or counts. |
IList |
list[IVar] |
Python list containing standard integer or np.int32 steps. |
DtypeVar |
npt.DTypeLike |
Valid NumPy data type identifier. |
IterVar |
Iterator[tuple[DVar, IVar]] |
Single pass data iterator containing zipped coordinate pairs. |
IterVar3 |
Iterator[tuple[DVar, IVar, DVar]] |
Data iterator layout emitting full coordinate-phase-weight triplets. |