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):

• Refactor signal model tests #661
• Make Trajectory and Idx 5D #660
• IHeader #591
• Add Indexer #580
• Add ReduceRepeatMixin #657
• -> Add CheckDataMixin #568
• Refactor AcqInfo and Trajectory Calculation #560
• Add unsqeeze_at #656
• Make Rotation einops compatible #655

[github-actions]

📚 Documentation

📁 Download as zip
🔍 View online

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/mrpro
_version.py	6	2	67%	7–8
src/mrpro/algorithms/csm
inati.py	24	1	96%	44
walsh.py	16	1	94%	53
src/mrpro/algorithms/dcf
dcf_voronoi.py	55	4	93%	15, 55–56, 89
src/mrpro/algorithms/optimizers
adam.py	20	1	95%	101
pdhg.py	79	3	96%	177–178, 184
src/mrpro/algorithms/reconstruction
DirectReconstruction.py	28	16	43%	59–79, 93
IterativeSENSEReconstruction.py	13	1	92%	79
Reconstruction.py	50	22	56%	42, 54–56, 80–87, 108–117
RegularizedIterativeSENSEReconstruction.py	41	17	59%	97–101, 115–140
src/mrpro/data
AcqInfo.py	135	4	97%	39, 43, 47, 217
CheckDataMixin.py	344	40	88%	90, 96, 98, 115, 123, 125, 127, 160–161, 184, 193, 210, 238, 254, 302, 307, 313–318, 348, 355, 446, 448, 480, 482, 484, 488, 504, 545, 550, 627, 649–653, 685, 726–729, 754
CsmData.py	28	3	89%	13, 82–84
DcfData.py	44	8	82%	16, 64, 76–81
EncodingLimits.py	73	3	96%	33, 123, 126
IData.py	60	8	87%	129, 142, 171–179
IHeader.py	96	11	89%	109, 112, 122, 125, 128, 131, 168–172
KData.py	221	31	86%	113–114, 129, 136, 148–161, 170, 178, 187, 221, 243–245, 281–282, 337–348, 509, 511, 571, 586, 650, 659
KHeader.py	141	21	85%	23, 108–114, 141, 189, 196–197, 200, 207, 224–231, 239–250
KNoise.py	31	15	52%	39–52, 56–61
KTrajectory.py	81	5	94%	207–211
MoveDataMixin.py	140	18	87%	28, 126, 142, 156–158, 220, 336–338, 351, 430, 450–451, 453, 468–469, 471
QData.py	39	7	82%	42, 65–73
Rotation.py	719	43	94%	101, 199, 336, 434, 478, 496, 583, 585, 594, 628, 630, 693, 770, 775, 778, 793, 810, 815, 891, 1079, 1084, 1087, 1111, 1115, 1243, 1245, 1253–1254, 1318, 1400, 1703, 1855, 1890, 1894, 2046, 2084, 2092, 2096, 2100–2104
SpatialDimension.py	232	21	91%	34, 104, 141, 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%	82
KTrajectoryIsmrmrd.py	27	8	70%	55–61, 66
src/mrpro/operators
CartesianSamplingOp.py	89	3	97%	118, 157, 280
ConstraintsOp.py	60	2	97%	46, 48
EndomorphOperator.py	32	2	94%	52, 58
FiniteDifferenceOp.py	27	2	93%	40, 105
FourierOp.py	73	2	97%	234, 239
Functional.py	77	9	88%	20–22, 117, 119, 226–228, 242
GridSamplingOp.py	136	9	93%	72–73, 82–83, 90–91, 94, 96, 98
LinearOperator.py	200	10	95%	48, 107, 217, 244, 251, 292, 301, 309, 326, 361
LinearOperatorMatrix.py	162	19	88%	82, 119, 152, 161, 166, 175–178, 191–194, 202–203, 208–209, 221, 310, 337, 364
MultiIdentityOp.py	13	2	85%	43, 48
NonUniformFastFourierOp.py	177	10	94%	69, 96, 206, 208, 241, 243, 302, 356, 406, 411
Operator.py	79	2	97%	32, 88
ProximableFunctionalSeparableSum.py	39	3	92%	50, 103, 110
SliceProjectionOp.py	174	8	95%	45, 62, 64, 70, 206, 227, 260, 300
WaveletOp.py	119	5	96%	151, 169, 204, 209, 232
ZeroPadOp.py	16	1	94%	30
src/mrpro/utils
filters.py	62	2	97%	44, 49
reshape.py	91	1	99%	289
slice_profiles.py	47	6	87%	21, 37, 116–119, 152
sliding_window.py	34	1	97%	34
split_idx.py	10	2	80%	43, 47
summarize_tensorvalues.py	12	9	25%	22–31
typing.py	69	55	20%	9–235
unit_conversion.py	60	14	77%	32, 40, 42, 49, 51, 58, 60, 69, 80, 82, 101, 103, 124, 126
zero_pad_or_crop.py	31	6	81%	26, 30, 55, 58, 61, 64
TOTAL	5593	501	91%

Tests	Skipped	Failures	Errors	Time
2452	0 💤	0 ❌	0 🔥	1m 13s ⏱️