builder¶

import ampform.dynamics.builder

Build dynamics with correct variable names and values.

BuilderReturnType¶

Type that a ResonanceDynamicsBuilder should return.

alias of Tuple[sympy.core.expr.Expr, Dict[sympy.core.symbol.Symbol, float]]

class ResonanceDynamicsBuilder(*args, **kwargs)[source]¶

Bases: Protocol

Protocol that is used by set_dynamics.

Follow this Protocol when defining a builder function that is to be used by set_dynamics. For an example, see the source code create_relativistic_breit_wigner, which creates a relativistic_breit_wigner.

See also

Custom dynamics

__call__(resonance: Particle, variable_pool: TwoBodyKinematicVariableSet) → Tuple[Expr, Dict[Symbol, float]][source]¶: Call self as a function.

class TwoBodyKinematicVariableSet(in_edge_inv_mass: Symbol, out_edge_inv_mass1: Symbol, out_edge_inv_mass2: Symbol, helicity_theta: Symbol, helicity_phi: Symbol, angular_momentum: Optional[int] = None)[source]¶

Bases: object

Data container for the essential variables of a two-body decay.

This data container is inserted into a ResonanceDynamicsBuilder, so that it can build some lineshape expression from the dynamics module. It also allows to insert custom dynamics into the amplitude model.

__eq__(other)¶: Method generated by attrs for class TwoBodyKinematicVariableSet.

angular_momentum: Optional[int]¶

helicity_phi: Symbol¶

helicity_theta: Symbol¶

in_edge_inv_mass: Symbol¶

out_edge_inv_mass1: Symbol¶

out_edge_inv_mass2: Symbol¶

create_analytic_breit_wigner(resonance: Particle, variable_pool: TwoBodyKinematicVariableSet) → Tuple[Expr, Dict[Symbol, float]]¶: Create a relativistic_breit_wigner_with_ff with analytic continuation.

See also

Analytic continuation.

create_non_dynamic(resonance: Particle, variable_pool: TwoBodyKinematicVariableSet) → Tuple[Expr, Dict[Symbol, float]][source]¶

create_non_dynamic_with_ff(resonance: Particle, variable_pool: TwoBodyKinematicVariableSet) → Tuple[Expr, Dict[Symbol, float]][source]¶

Generate (only) a Blatt-Weisskopf form factor for a two-body decay.

Returns the sqrt of a BlattWeisskopfSquared.

create_relativistic_breit_wigner(resonance: Particle, variable_pool: TwoBodyKinematicVariableSet) → Tuple[Expr, Dict[Symbol, float]][source]¶: Create a relativistic_breit_wigner for a two-body decay.

create_relativistic_breit_wigner_with_ff(resonance: Particle, variable_pool: TwoBodyKinematicVariableSet) → Tuple[Expr, Dict[Symbol, float]]¶: Create a relativistic_breit_wigner_with_ff for a two-body decay.

AmpForm

builder¶