Add arithmetic to SpatialDimension

[fzimmermann89]

Follow up to #416 with correct type hints

[github-actions[bot]]

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	42	23	45%	77–78, 88–98, 113–124, 138–149
Reconstruction.py	52	24	54%	42, 54–56, 80–87, 104–115
src/mrpro/data
AcqInfo.py	128	2	98%	174, 214
CsmData.py	29	3	90%	15, 82–84
DcfData.py	45	8	82%	18, 66, 78–83
IData.py	67	9	87%	119, 125, 129, 159–167
IHeader.py	75	7	91%	75, 109, 127–131
KHeader.py	165	17	90%	25, 127–131, 158, 210, 221, 228–229, 232, 239, 278–289
KNoise.py	31	15	52%	39–52, 56–61
KTrajectory.py	69	5	93%	178–182
MoveDataMixin.py	127	18	86%	15, 110, 126, 140–142, 203, 265–267, 280, 359, 379–380, 382, 397–398, 400
QData.py	39	7	82%	42, 65–73
Rotation.py	674	36	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, 1608, 1690, 1846, 1881, 1885, 1996
SpatialDimension.py	246	23	91%	34, 104, 119, 126, 132, 167, 177, 294–296, 309–311, 345, 363, 376, 389, 402, 415, 424–425, 440, 449
TrajectoryDescription.py	14	1	93%	23
acq_filters.py	10	1	90%	47
src/mrpro/data/_kdata
KData.py	105	16	85%	108–109, 118, 126, 180–181, 216, 221–222, 241–252
KDataRemoveOsMixin.py	29	2	93%	44, 46
KDataSelectMixin.py	21	2	90%	48, 64
KDataSplitMixin.py	49	3	94%	51, 81, 90
src/mrpro/data/traj_calculators
KTrajectoryCalculator.py	25	2	92%	23, 45
KTrajectoryIsmrmrd.py	13	2	85%	41, 50
KTrajectoryPulseq.py	29	1	97%	54
src/mrpro/operators
CartesianSamplingOp.py	50	9	82%	49–50, 55–56, 61–62, 88, 91, 114
ConstraintsOp.py	60	2	97%	46, 48
EndomorphOperator.py	65	2	97%	228, 234
FiniteDifferenceOp.py	27	2	93%	40, 105
FourierOp.py	77	1	99%	131
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	161	12	93%	55, 91, 190, 220, 261, 270, 278, 287, 295, 306, 404, 409
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
modify_acq_info.py	17	1	94%	12
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	9	18%	20–29
typing.py	18	11	39%	8–23
zero_pad_or_crop.py	31	6	81%	26, 30, 54, 57, 60, 63
TOTAL	4530	351	92%

Tests	Skipped	Failures	Errors	Time
1916	0 :zzz:	0 :x:	0 :fire:	1m 37s :stopwatch:

[fzimmermann89]

I also moved Rotation out of utils (as it depended on SpatialDimension) and TYPE_CHECKING guarded modify_acq_info to avoid circular imports. Functions in utils should not depend on data classes (otherwise, we can't use them in data classes) As modify_acq_info will be deprecated anyways once we move that functionality into acqinfo, I only added the future annotations and guard.

These changes might be moved to a separate (stacked) PR .

I removed xyz to force us to always be zyx or be explicit about it and write (spatialdim.x,spatialdim.y,spatialdim.z). Otherwise, the temptation to wrongly use xyz is high..

[fzimmermann89]

This passes all tests from #416 and passes mypy

[fzimmermann89]

(To be merged after #418 into main)

[github-actions[bot]]

:books: Documentation

:file_folder: Download as zip :mag: View online

[fzimmermann89]

i cleaned the type hints a bit.

also, I removed the conversion option from the class methods. Instead, there is now an apply_ that is used after creation to do the conversion. This will anyways be required for rearranging etc..

[fzimmermann89]

Also, I added typing asserts as tests. This is in the same test_spatialdimension.py file, even though the tests is not actually run by pytest -- just parsed by mypy.

maybe @schuenke can have another look ...

[ckolbPTB]

Why do we want to support np.ndarray for SpatialDimension? It would be nice if that would be supported in the init and maybe from_-functions but it could then be converted to tensors.

[fzimmermann89]

Why do we want to support np.ndarray for SpatialDimension? It would be nice if that would be supported in the init and maybe from_-functions but it could then be converted to tensors.

from_array* will convert to tensors. I mostly added nd.array type hints to see if the hints are correct or if errors are just hidden by the fact that there is only one vector type supported. The biggest uses I see is for compatibility and object arrays (example: array of callables). I would leave it in as long as it doesn't cause issues.

[ckolbPTB]

I would leave it in as long as it doesn't cause issues.

It seems strange to me why we would support ndarrays here when everywhere else we ensure torch.tensors. I would go the other way and remove it unless we really need it. Otherwise we should also support it for getitem/setitem

[fzimmermann89]

Otherwise we should also support it for getitem/setitem

I added the overloads for getitem and setitem and a test for these.

[fzimmermann89]

Otherwise we should also support it for getitem/setitem

I added the overloads for getitem and setitem and a test for these.

Scratch that (Was kümmert mich mein Geschwätz von gestern). I removed np.ndarray support, as I wont use a SpatialDimension of callables in the use case I had in mind anyway.

[fzimmermann89]

pre-commit.ci autofix

[fzimmermann89]

pre-commit.ci autofix