Add arithmetic for SpatialDimension

[ckolbPTB]

When saving our data to Dicom we need to recalculate positions and orientations. This would provide the arithemtic to do this more easily.

Current disadvantage: z,y,x were int | float | Tensor but are now always Tensor. This makes lots of things easier but would require quite some changes to our code (especially the SliceProjectionOp). We could of course keep it as int | float | Tensor but then we would need quite a few checks in the arithmetic part.

Another option would be to have z,y,x as int | float and then things like read_dirwould be a list of SpatialDimension objects.

[github-actions[bot]]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/mrpro/algorithms/csm
inati.py	24	1	96%	44
iterative_walsh.py	15	1	93%	37
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	51	24	53%	41, 53–55, 79–86, 103–114
src/mrpro/data
AcqInfo.py	128	2	98%	174, 214
CsmData.py	28	3	89%	14, 84–86
DcfData.py	44	8	82%	17, 65, 77–82
IData.py	67	9	87%	119, 125, 129, 159–167
IHeader.py	75	7	91%	75, 109, 127–131
KHeader.py	164	17	90%	24, 126–130, 157, 207, 218, 225–226, 229, 236, 275–286
KNoise.py	31	15	52%	39–52, 56–61
KTrajectory.py	69	5	93%	178–182
MoveDataMixin.py	126	19	85%	14, 109, 125, 139–141, 202, 264–266, 279, 354, 358, 378–379, 381, 396–397, 399
QData.py	39	7	82%	42, 65–73
SpatialDimension.py	85	3	96%	80, 124, 175
TrajectoryDescription.py	14	1	93%	23
acq_filters.py	10	1	90%	47
src/mrpro/data/_kdata
KData.py	105	16	85%	107–108, 117, 125, 179–180, 215, 220–221, 240–251
KDataRemoveOsMixin.py	29	2	93%	43, 45
KDataSelectMixin.py	20	2	90%	46, 62
KDataSplitMixin.py	48	3	94%	49, 79, 88
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	51	2	96%	209, 213
FiniteDifferenceOp.py	27	2	93%	48, 113
FourierOp.py	77	2	97%	131, 192
GridSamplingOp.py	123	9	93%	60–61, 70–71, 78–79, 82, 84, 86
LinearOperator.py	80	3	96%	32, 131, 256
Operator.py	52	1	98%	21
SliceProjectionOp.py	166	8	95%	39, 46, 48, 54, 191, 212, 245, 285
WaveletOp.py	120	5	96%	152, 170, 205, 210, 233
ZeroPadOp.py	16	1	94%	30
src/mrpro/utils
Rotation.py	453	28	94%	58–66, 106, 283, 368, 370, 397, 452, 457, 460, 475, 492, 497, 640, 645, 648, 664, 668, 742, 744, 752–753, 993, 1075
filters.py	62	2	97%	44, 49
slice_profiles.py	45	6	87%	18, 34, 111–114, 147
sliding_window.py	34	1	97%	34
split_idx.py	10	2	80%	43, 47
summarize_tensorvalues.py	11	9	18%	20–29
zero_pad_or_crop.py	31	6	81%	26, 30, 54, 57, 60, 63
TOTAL	3655	293	92%

Tests	Skipped	Failures	Errors	Time
842	0 :zzz:	7 :x:	0 :fire:	57.318s :stopwatch:

[fzimmermann89]

I would prefer to keep it as int|float|Tensor. Especially the int part is important for mypy. We use spatal dimensions for image sizes etc where only ints are valid. This should be type-checked.

[fzimmermann89]

can you give an example where where this is required?

[ckolbPTB]

The image centre for dicom is the top left corner of the image so we have to do something like iheader.position + iheader.fov.x/2 * iheader.read_dir +... for every other dimension

would be nice if we could simply say iheader.position[idx,...] + iheader.fov.x/2 * iheader.read_dir[idx,...] +

currently that is not so straight forward.

Maybe we could add something like .as_xyz_tensor and .as_zyx_tensor?

[fzimmermann89]

the original idea was to be explicit with x,y, and z. SoSpatialDimension(x=iheader.position.x[idx]+iheader.fov.x/2 * iheader.read_dir,... ) on purpose.

Nevertheless, I will do a draft with the correct type hints of this, so we can do it in your way. give me a couple minutes.

Furthermore, this might be a good opportunity to add a orientation as a Rotation property to the header. I put this to the side in the past, as we did not have any code accessing read_dir, etc anyways. This should do the the rotation of the fov then as iheader.rotation(iheader.fov)