update type hinting

Author: henrikjacobsenfys

src/easydynamics/sample_model/components/damped_harmonic_oscillator.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Union
 
 import numpy as np
@@ -138,7 +140,7 @@ def convert_unit(self, unit: str):
         self.width.convert_unit(unit)
         self.unit = unit
 
-    def copy(self) -> "DampedHarmonicOscillator":
+    def copy(self) -> DampedHarmonicOscillator:
         """
         Return a deep copy of this component with independent parameters.
         """

src/easydynamics/sample_model/components/delta_function.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Union
 
 from easyscience.variable import Parameter
@@ -94,7 +96,7 @@ def convert_unit(self, unit):
         self.center.convert_unit(unit)
         self.unit = unit
 
-    def copy(self) -> "DeltaFunction":
+    def copy(self) -> DeltaFunction:
         """
         Return a deep copy of this component with independent parameters.
         """

src/easydynamics/sample_model/components/gaussian.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Union, List
 
 import numpy as np
@@ -131,7 +133,7 @@ def convert_unit(self, unit: str):
         self.width.convert_unit(unit)
         self.unit = unit
 
-    def copy(self) -> "Gaussian":
+    def copy(self) -> Gaussian:
         """
         Return a deep copy of this component with independent parameters.
         """

src/easydynamics/sample_model/components/lorentzian.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Union
 
 import numpy as np
@@ -133,7 +135,7 @@ def convert_unit(self, unit: str):
         self.width.convert_unit(unit)
         self.unit = unit
 
-    def copy(self) -> "Lorentzian":
+    def copy(self) -> Lorentzian:
         model_copy = Lorentzian(
             name=self.name,
             area=self.area.value,

src/easydynamics/sample_model/components/model_component.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 from abc import abstractmethod
 
-from typing import Union, List, Optional
+from typing import Union, List
 
 import numpy as np
 
@@ -25,14 +27,11 @@ def fix_all_parameters(self):
         """Fix all parameters in the model component."""
 
         pars = self.get_parameters()
-        if pars is None or len(pars) == 0:
-            raise ValueError("No parameters found to fix.")
-        else:
-            for p in pars:
-                p.fixed = True
+        for p in pars:
+            p.fixed = True
 
-    def fit_all_parameters(self):
-        """Fit all parameters in the model component."""
+    def free_all_parameters(self):
+        """Free all parameters in the model component."""
         for p in self.get_parameters():
             p.fixed = False
 
@@ -66,49 +65,6 @@ def get_parameter(self, parameter_name: str) -> Parameter:
         else:
             raise ValueError(f"Parameter '{parameter_name}' not found.")
 
-    def set_parameter_value(
-        self, parameter_name: str, value: float, unit: Optional[str] = None
-    ):
-        """
-        Set the value of a specific parameter by name.
-        """
-        param = self.get_parameter(parameter_name)
-        if unit is not None:
-            param.convert_unit(unit)
-        param.value = value
-
-    def set_parameter_bounds(
-        self,
-        parameter_name: str,
-        min: Union[float, None] = None,
-        max: Union[float, None] = None,
-        unit: Optional[str] = None,
-    ):
-        """
-        Set the bounds of a specific parameter by name.
-        """
-        param = self.get_parameter(parameter_name)
-        if unit is not None:
-            param.convert_unit(unit)
-        if min is not None:
-            param.min = min
-        if max is not None:
-            param.max = max
-
-    def fix_parameter(self, parameter_name: str):
-        """
-        Fix a specific parameter by name.
-        """
-        param = self.get_parameter(parameter_name)
-        param.fixed = True
-
-    def free_parameter(self, parameter_name: str):
-        """
-        Free a specific parameter by name.
-        """
-        param = self.get_parameter(parameter_name)
-        param.fixed = False
-
     @abstractmethod
     def evaluate(self, x: Union[Numeric, sc.Variable]) -> np.ndarray:
         """
@@ -135,7 +91,7 @@ def get_parameters(self) -> List[Parameter]:
         pass
 
     @abstractmethod
-    def copy(self) -> "ModelComponent":
+    def copy(self) -> ModelComponent:
         """
         Return a deep copy of this component with independent parameters.
         """

src/easydynamics/sample_model/components/polynomial.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Union
 
 import numpy as np
@@ -82,7 +84,7 @@ def get_parameters(self):
         """
         return self.coefficients
 
-    def copy(self) -> "Polynomial":
+    def copy(self) -> Polynomial:
         """
         Return a deep copy of this component with independent parameters.
         """

src/easydynamics/sample_model/components/voigt.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from scipy.special import voigt_profile
 
 from typing import Union
@@ -160,7 +162,7 @@ def get_parameters(self):
         """
         return [self.area, self.center, self.gaussian_width, self.lorentzian_width]
 
-    def copy(self) -> "Voigt":
+    def copy(self) -> Voigt:
         model_copy = Voigt(
             name=self.name,
             area=self.area.value,

tests/unit_tests/sample_model/test_components.py

@@ -46,9 +46,9 @@ def test_fix_all_parameters_sets_all_to_fixed(self, dummy):
         # THEN EXPECT
         assert all(p.fixed for p in dummy.get_parameters())
 
-    def test_fit_all_parameters_sets_all_to_unfixed(self, dummy):
+    def test_free_all_parameters_sets_all_to_unfixed(self, dummy):
         # WHEN
-        dummy.fit_all_parameters()
+        dummy.free_all_parameters()
 
         # THEN EXPECT
         assert all(not p.fixed for p in dummy.get_parameters())