Add CheckDataMixin

[fzimmermann89]

This adds a new Mixin for Dataclasses that checks the types of the fields.
If the fields are Annotated with a (newly added) Annotation, specifying either its data type or shape, this will also be checked.

After some discussions following #495, this is now optional. None of the core reshaping or indexing functions will depend on these checks, but the will be performed afterwards. If this ever becomes an issue, removing the mixin from the dataclass will only remove the checks.
This is IMHO the best way to check that certain invariants are true after reshaping or indexing in a readable and maintable way.
An alternative I considered was using data class descriptors instead of Annotated and perform the check in the set of the descriptors. But this would make the checking code fundamental to the data classes, instead of just a checking addon that can be removed.

One can specify the expected shape of a field using the syntax of jaxtyping.

There is also a context manager to disable checks temporarily.
By default, when exiting the context, the suspended checks will be performed. So one can first create a wrongly shaped data class, reshape it, and on exit it is ensured that the fields follow the rules. This behavior can also be disabled to disable checks in a part of the code completely.

The string parsing etc happens on import time, not at creation time.
Parts of the shape checks are cached, so running the same invariants check multiple times without substantial changes to the shapes will be fast.

I also removed some __future__.annotation imports, as they stringify all type annotations. Instead, we should either fix the dependencies, use stringified annotations (these cannot be runtime checked) or wait for PEP 649/749

[fzimmermann89]

Stack from ghstack (oldest at bottom):

• getnested #594
• IHeader #591
• Add Indexer #580
• -> Add CheckDataMixin #568
• Refactor AcqInfo and Trajectory Calculation #560
• Ensure compressed number of coils is not greater than existing number #567
• Move functions from mixins into KData #559

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/mrpro/algorithms/csm
inati.py	24	1	96%	44
walsh.py	16	1	94%	34
src/mrpro/algorithms/dcf
dcf_voronoi.py	53	4	92%	15, 48–49, 76
src/mrpro/algorithms/optimizers
adam.py	20	1	95%	69
src/mrpro/algorithms/reconstruction
DirectReconstruction.py	28	16	43%	51–71, 85
IterativeSENSEReconstruction.py	13	1	92%	76
Reconstruction.py	50	22	56%	42, 54–56, 80–87, 104–113
RegularizedIterativeSENSEReconstruction.py	41	17	59%	96–100, 114–139
src/mrpro/data
AcqInfo.py	146	5	97%	51, 55, 59, 229, 267
CheckDataMixin.py	341	218	36%	94, 100, 102, 119, 127, 129, 131, 151–166, 177, 181–184, 188, 192–197, 201, 210, 214, 240–261, 289–322, 342–362, 444–449, 453–459, 478–515, 540–550, 578–584, 589–595, 607–613, 619–628, 648–652, 656, 662, 666–670, 674–677, 683–688, 724–756
CsmData.py	28	3	89%	13, 80–82
DcfData.py	44	8	82%	16, 64, 76–81
EncodingLimits.py	73	3	96%	33, 123, 126
IData.py	67	9	87%	119, 125, 129, 159–167
IHeader.py	75	7	91%	75, 109, 127–131
KData.py	222	27	88%	112–113, 128, 135, 147–158, 167, 175, 184–188, 240–241, 281, 298, 303–304, 326–327, 487, 489, 562, 626, 635
KHeader.py	139	14	90%	23, 108–112, 139, 187, 194–195, 198, 205, 222–229
KNoise.py	31	15	52%	39–52, 56–61
KTrajectory.py	81	7	91%	108–113, 116–118
MoveDataMixin.py	140	18	87%	15, 113, 129, 143–145, 207, 323–325, 338, 417, 437–438, 440, 455–456, 458
QData.py	39	7	82%	42, 65–73
Rotation.py	674	35	95%	100, 198, 335, 433, 477, 495, 581, 583, 592, 626, 628, 691, 768, 773, 776, 791, 808, 813, 889, 1077, 1082, 1085, 1109, 1113, 1240, 1242, 1250–1251, 1315, 1397, 1690, 1846, 1881, 1885, 1996
SpatialDimension.py	232	20	91%	34, 104, 148, 154, 274–276, 289–291, 325, 343, 356, 369, 382, 395, 404–405, 420, 429
acq_filters.py	12	1	92%	47
src/mrpro/data/traj_calculators
KTrajectoryCalculator.py	27	1	96%	85
KTrajectoryIsmrmrd.py	13	2	85%	41, 50
src/mrpro/operators
CartesianSamplingOp.py	89	3	97%	118, 157, 280
ConstraintsOp.py	60	2	97%	46, 48
EndomorphOperator.py	65	2	97%	228, 234
FiniteDifferenceOp.py	27	2	93%	40, 105
FourierOp.py	158	3	98%	263, 381, 386
Functional.py	71	5	93%	20–22, 117, 119
GridSamplingOp.py	136	9	93%	72–73, 82–83, 90–91, 94, 96, 98
LinearOperator.py	168	10	94%	55, 91, 190, 220, 261, 270, 278, 287, 295, 320
LinearOperatorMatrix.py	158	16	90%	82, 119, 152, 161, 166, 175–178, 191–194, 203, 215, 304, 331, 359
MultiIdentityOp.py	13	2	85%	43, 48
Operator.py	78	2	97%	25, 74
ProximableFunctionalSeparableSum.py	39	3	92%	50, 103, 110
SliceProjectionOp.py	173	8	95%	44, 61, 63, 69, 206, 227, 260, 300
WaveletOp.py	120	5	96%	152, 170, 205, 210, 233
ZeroPadOp.py	16	1	94%	30
src/mrpro/utils
filters.py	62	2	97%	44, 49
reshape.py	60	1	98%	191
slice_profiles.py	46	6	87%	20, 36, 113–116, 149
sliding_window.py	34	1	97%	34
split_idx.py	10	2	80%	43, 47
summarize_tensorvalues.py	11	2	82%	23, 25
typing.py	18	11	39%	8–23
zero_pad_or_crop.py	31	6	81%	26, 30, 54, 57, 60, 63
TOTAL	5246	567	89%

Tests	Skipped	Failures	Errors	Time
2265	0 💤	2 ❌	4 🔥	54.351s ⏱️

[github-actions]

📚 Documentation

📁 Download as zip
🔍 View online

[fzimmermann89]

See here for an example of the Annotations

[fzimmermann89]

see here (and next text) for the suspend checks context manager