FIX: use FormFactor directly from ampform

ComPWA · May 28, 2024 · 7a7416a · 7a7416a
1 parent 572b609
commit 7a7416a
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 36 deletions.
diff --git a/docs/jpsi2ksp.ipynb b/docs/jpsi2ksp.ipynb
@@ -38,7 +38,8 @@
     "import matplotlib.pyplot as plt\n",
     "import qrules\n",
     "import sympy as sp\n",
-    "from ampform.dynamics import BlattWeisskopfSquared, EnergyDependentWidth\n",
+    "from ampform.dynamics import EnergyDependentWidth\n",
+    "from ampform.dynamics.form_factor import BlattWeisskopfSquared, FormFactor\n",
     "from ampform.sympy import perform_cached_doit\n",
     "from IPython.display import Latex, Markdown\n",
     "from tensorwaves.data.transform import SympyDataTransformer\n",
@@ -47,7 +48,7 @@
     "from ampform_dpd import DalitzPlotDecompositionBuilder\n",
     "from ampform_dpd.adapter.qrules import normalize_state_ids, to_three_body_decay\n",
     "from ampform_dpd.decay import State\n",
-    "from ampform_dpd.dynamics import FormFactor, RelativisticBreitWigner\n",
+    "from ampform_dpd.dynamics import RelativisticBreitWigner\n",
     "from ampform_dpd.dynamics.builder import formulate_breit_wigner_with_form_factor\n",
     "from ampform_dpd.io import (\n",
     "    as_markdown_table,\n",

diff --git a/docs/serialization.ipynb b/docs/serialization.ipynb
@@ -53,7 +53,7 @@
     "import matplotlib.pyplot as plt\n",
     "import pandas as pd\n",
     "import sympy as sp\n",
-    "from ampform.dynamics import BlattWeisskopfSquared\n",
+    "from ampform.dynamics.form_factor import BlattWeisskopfSquared, FormFactor\n",
     "from ampform.dynamics.phasespace import BreakupMomentumSquared\n",
     "from ampform.kinematics.phasespace import Kallen\n",
     "from ampform.sympy import perform_cached_doit\n",
@@ -67,7 +67,6 @@
     "    BuggBreitWigner,\n",
     "    ChannelArguments,\n",
     "    EnergyDependentWidth,\n",
-    "    FormFactor,\n",
     "    MultichannelBreitWigner,\n",
     "    P,\n",
     "    SimpleBreitWigner,\n",

diff --git a/docs/xib2pkk.ipynb b/docs/xib2pkk.ipynb
@@ -38,7 +38,8 @@
     "import matplotlib.pyplot as plt\n",
     "import qrules\n",
     "import sympy as sp\n",
-    "from ampform.dynamics import BlattWeisskopfSquared, EnergyDependentWidth\n",
+    "from ampform.dynamics import EnergyDependentWidth\n",
+    "from ampform.dynamics.form_factor import BlattWeisskopfSquared, FormFactor\n",
     "from ampform.sympy import perform_cached_doit\n",
     "from IPython.display import Latex, Markdown\n",
     "from tensorwaves.data.transform import SympyDataTransformer\n",
@@ -52,7 +53,7 @@
     "    to_three_body_decay,\n",
     ")\n",
     "from ampform_dpd.decay import State\n",
-    "from ampform_dpd.dynamics import FormFactor, RelativisticBreitWigner\n",
+    "from ampform_dpd.dynamics import RelativisticBreitWigner\n",
     "from ampform_dpd.dynamics.builder import formulate_breit_wigner_with_form_factor\n",
     "from ampform_dpd.io import (\n",
     "    as_markdown_table,\n",

diff --git a/pyproject.toml b/pyproject.toml
@@ -26,7 +26,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "ampform >=0.15.1", # aslatex with keyword arguments
+    "ampform >=0.15.4", # aslatex with keyword arguments
     "attrs >=20.1.0", # on_setattr and https://www.attrs.org/en/stable/api.html#next-gen
     "cloudpickle",
     "qrules >=0.10.0",

diff --git a/src/ampform_dpd/dynamics/__init__.py b/src/ampform_dpd/dynamics/__init__.py
@@ -6,7 +6,7 @@
 from typing import TYPE_CHECKING, Any
 
 import sympy as sp
-from ampform.dynamics import formulate_form_factor
+from ampform.dynamics.form_factor import FormFactor
 from ampform.kinematics.phasespace import Kallen
 from ampform.sympy import unevaluated
 
@@ -195,27 +195,6 @@ def evaluate(self) -> sp.Piecewise:
         ])
 
 
-@unevaluated
-class FormFactor(sp.Expr):
-    s: Any
-    m1: Any
-    m2: Any
-    angular_momentum: Any
-    meson_radius: Any
-
-    _latex_repr_ = R"\mathcal{{F}}_{{{angular_momentum}}}\left({s}, {m1}, {m2}\right)"
-
-    def evaluate(self):
-        s, m1, m2, angular_momentum, meson_radius = self.args
-        return formulate_form_factor(
-            s=s,
-            m_a=m1,
-            m_b=m2,
-            angular_momentum=angular_momentum,
-            meson_radius=meson_radius,
-        )
-
-
 @unevaluated
 class MultichannelBreitWigner(sp.Expr):
     s: Any

diff --git a/src/ampform_dpd/dynamics/builder.py b/src/ampform_dpd/dynamics/builder.py
@@ -9,6 +9,7 @@
 from __future__ import annotations
 
 import sympy as sp
+from ampform.dynamics.form_factor import FormFactor
 
 from ampform_dpd import to_particle
 from ampform_dpd.decay import (
@@ -18,7 +19,7 @@
     State,
     ThreeBodyDecayChain,
 )
-from ampform_dpd.dynamics import FormFactor, RelativisticBreitWigner
+from ampform_dpd.dynamics import RelativisticBreitWigner
 
 
 def formulate_breit_wigner_with_form_factor(

diff --git a/src/ampform_dpd/io/serialization/dynamics.py b/src/ampform_dpd/io/serialization/dynamics.py
@@ -4,14 +4,10 @@
 from typing import TYPE_CHECKING, Callable, Protocol, TypeVar, cast
 
 import sympy as sp
+from ampform.dynamics.form_factor import FormFactor
 
 from ampform_dpd import DefinedExpression
-from ampform_dpd.dynamics import (
-    BreitWigner,
-    ChannelArguments,
-    FormFactor,
-    MultichannelBreitWigner,
-)
+from ampform_dpd.dynamics import BreitWigner, ChannelArguments, MultichannelBreitWigner
 from ampform_dpd.io.serialization.decay import get_initial_state
 from ampform_dpd.io.serialization.format import (
     BlattWeisskopfDefinition,