diff --git a/news/getoption-by-name.rst b/news/getoption-by-name.rst new file mode 100644 index 0000000..f9babfe --- /dev/null +++ b/news/getoption-by-name.rst @@ -0,0 +1,23 @@ +**Added:** + +* ``RefinableObj.GetOption`` accepts an option name, e.g. ``pp.GetOption("Fit Scale Factors at Beginning of Optimization").SetChoice("No")`` to keep fixed scale factors unchanged in ``LSQ.Refine``. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/extensions/nb_refinableobj.cpp b/src/extensions/nb_refinableobj.cpp index 9b8b545..3387eed 100644 --- a/src/extensions/nb_refinableobj.cpp +++ b/src/extensions/nb_refinableobj.cpp @@ -240,6 +240,9 @@ void wrap_refinableobj(nb::module_& m) .def("GetOption", nb::overload_cast(&RefinableObj::GetOption), nb::rv_policy::reference_internal) + .def("GetOption", + nb::overload_cast(&RefinableObj::GetOption), + nb::rv_policy::reference_internal) /* State */ .def("IsBeingRefined", &RefinableObj::IsBeingRefined) .def("BeginGlobalOptRandomMove",&RefinableObj::BeginGlobalOptRandomMove) diff --git a/tests/test_lsq.py b/tests/test_lsq.py index 99730d2..9cb781c 100644 --- a/tests/test_lsq.py +++ b/tests/test_lsq.py @@ -11,13 +11,18 @@ import unittest +import numpy as np import pytest from pyobjcryst import ObjCrystException, refinableobj +from pyobjcryst.atom import Atom +from pyobjcryst.crystal import Crystal from pyobjcryst.diffractiondatasinglecrystal import ( DiffractionDataSingleCrystal, ) from pyobjcryst.lsq import LSQ +from pyobjcryst.powderpattern import PowderPattern +from pyobjcryst.scatteringpower import ScatteringPowerAtom class TestGlobalOptim(unittest.TestCase): @@ -144,5 +149,37 @@ def test_lsq_prepare_ref_par_list_verbose(self): lsq.PrepareRefParList(copy_param=False, verbose=True) +@pytest.mark.parametrize("choice, scale_after", [("Yes", 2.0), ("No", 1.0)]) +def test_lsq_refine_fit_scale_begin_optimization(choice, scale_after): + """Refine fits even fixed scale factors at the beginning, unless the + PowderPattern option is set to "No".""" + cryst = Crystal(4.05, 4.05, 4.05, "Fm-3m") + sp = ScatteringPowerAtom("Al", "Al") + cryst.AddScatteringPower(sp) + cryst.AddScatterer(Atom(0, 0, 0, "Al", sp)) + + pp = PowderPattern() + pp.SetWavelength(1.0) + pp.SetPowderPatternX(np.radians(np.linspace(10, 60, 2000))) + pp.AddPowderPatternDiffraction(cryst) + # observed pattern = calculated pattern at twice the scale + pp.SetPowderPatternObs(np.ones(2000)) + pp.SetPowderPatternObs(2 * pp.GetPowderPatternCalc()) + pp.GetOption("Fit Scale Factors at Beginning of Optimization").SetChoice( + choice + ) + + lsq = LSQ() + lsq.SetRefinedObj(pp, 0, True, True) + lsq.PrepareRefParList(False) + lsq.GetCompiledRefinedObj().FixAllPar() + pp.GetPar("Zero").SetIsFixed(False) # LSQ needs a free parameter + lsq.Refine(nbCycle=1, silent=True) + + scale = pp.GetPar("Scale_") + assert scale.IsFixed() + assert scale.GetValue() == pytest.approx(scale_after, rel=1e-6) + + if __name__ == "__main__": unittest.main()