colliderscope.eta_phi_scatter(pmu: Iterable[tuple[float, float, float, float]], pdg: Iterable[int] | None = None, masks: Mapping[str, Iterable[bool]] | None = None, eta_max: float | None = None, pt_min: float | None = None, indices: Iterable[int] | None = None, title: str | None = None, pi_units: bool = True) PlotlyFigure

Produces a scatter plot of particles over the \(\eta-\phi\), ie. pseudorapidity-azimuth, plane.

New in version 0.2.0.

Changed in version 0.2.3: Added pi_units and title parameters. Set defaults for eta_max and pt_min as None. Made pdg an optional parameter.

Parameters:
pmu : iterable[tuple[float, float, float, float]]

Four momenta of particles in basis \((p_x, p_y, p_z, E)\).

pdg : iterable[int], optional

PDG particle identification codes. Default is None.

masks : mapping[str, iterable[bool]], optional

Groups particles using key-value pairs, where the values are boolean masks identifying members of a group, and the keys are used in the plot legend. Default is None.

eta_max : float, optional

Maximum cut-off for the pseudorapidity, \(\eta\). Default is None.

pt_min : float, optional

Minimum cut-off for the transverse momentum, \(p_T\). Default is None.

indices : iterable[int], optional

Adds custom data indices to points on scatter plot. Mostly useful for keeping track of particles in Dash callbacks. Default is None.

title : str, optional

Main heading for the figure. Default is None.

pi_units : bool

If True, will rescale the \(\phi\)-axis to range \([-1, 1]\), by putting it in units of \(\pi\). Default is True.

Returns:

Interactive scatter plot over the \(\eta-\phi\) plane.

Return type:

PlotlyFigure


Last update: Jun 27, 2025