Add Non-Linear Conjugate Gradient (NLCG) algorithm

[fzimmermann89]

Closes #292

Status: I will not continue working on it for the foreseeable futue

[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
nlcg.py	32	32	0%	3–86
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, 81–83
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	14	89%	14, 109, 125, 139–141, 202, 265, 279, 358, 378–379, 396–397
QData.py	39	7	82%	42, 65–73
Rotation.py	447	22	95%	96, 277, 362, 364, 391, 446, 451, 454, 469, 486, 491, 634, 639, 642, 658, 662, 736, 738, 746–747, 987, 1069
SpatialDimension.py	46	2	96%	64, 103
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	20	2	90%	47, 63
KDataSplitMixin.py	48	3	94%	50, 80, 89
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	64	2	97%	225, 231
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	160	12	92%	54, 90, 189, 217, 258, 267, 275, 284, 292, 303, 401, 406
MultiIdentityOp.py	13	2	85%	44, 49
Operator.py	76	2	97%	24, 67
ProximableFunctionalSeparableSum.py	38	3	92%	49, 102, 109
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	12	7	42%	6–15
zero_pad_or_crop.py	31	6	81%	26, 30, 54, 57, 60, 63
TOTAL	4074	340	92%

Tests	Skipped	Failures	Errors	Time
1869	0 💤	0 ❌	0 🔥	1m 38s ⏱️

[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
nlcg.py	32	32	0%	3–86
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	128	3	98%	26, 169, 207
CsmData.py	29	3	90%	15, 84–86
DcfData.py	45	8	82%	18, 66, 78–83
IData.py	60	8	87%	129, 142, 171–179
IHeader.py	96	11	89%	103, 106, 116, 119, 122, 125, 162–166
KData.py	214	25	88%	111–112, 127, 134, 144, 152, 206–207, 245, 250–251, 270–281, 440, 442, 507, 522, 559, 590, 599
KHeader.py	153	17	89%	25, 119–123, 150, 199, 210, 217–218, 221, 228, 260–271
KNoise.py	31	15	52%	39–52, 56–61
KTrajectory.py	81	12	85%	112–117, 120–122, 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	682	35	95%	100, 198, 335, 433, 477, 495, 582, 584, 593, 627, 629, 692, 769, 774, 777, 792, 809, 814, 890, 1078, 1083, 1086, 1110, 1114, 1242, 1244, 1252–1253, 1317, 1399, 1702, 1854, 1889, 1893, 2004
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	25	2	92%	23, 45
KTrajectoryIsmrmrd.py	13	2	85%	41, 50
KTrajectoryPulseq.py	23	1	96%	55
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	75	1	99%	239
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	11	9	18%	20–29
typing.py	58	45	22%	9–217
zero_pad_or_crop.py	31	6	81%	26, 30, 55, 58, 61, 64
TOTAL	5200	450	91%

Tests	Skipped	Failures	Errors	Time
2413	0 💤	0 ❌	0 🔥	1m 12s ⏱️