QCumulantFlow

class QCumulantFlow.QCumulantFlow(n=2, k=2, imaginary='zero')

This class implements the Q-Cumulant method for anisotropic flow analysis.

References:

• [1] PhD Thesis A. Bilandzic

• [2] Phys.Rev.C 83 (2011) 044913

Parameters:

nint, optional

The order of the harmonic flow (default is 2).

kint, optional

The order of the cumulant (2, 4, or 6) (default is 2).

imaginarystr, optional

Specifies the treatment of imaginary roots. Options are ‘zero’, ‘negative’, or ‘nan’ (default is ‘zero’).

Examples

A demonstration of how to use the QCumulantFlow class to calculate flow.

>>> flow_instance = QCumulantFlow(n=2, k=2, imaginary='zero')
>>> result = flow_instance.integrated_flow(particle_data)

Attributes:

n_int

The order of the harmonic flow.

k_int

The order of the cumulant.

imaginary_str

Specifies the treatment of imaginary roots.

cumulant_factor_dict

Dictionary mapping cumulant order to corresponding flow.

rand_reaction_planes_list

List to store randomly sampled reaction planes.

Methods

integrated_flow:	Computes the integrated flow.
differential_flow:	Computes the differential flow.

QCumulantFlow.integrated_flow(particle_data)

Compute the integrated flow.

Parameters:

particle_datalist

List of particle data, where each sublist represents an event with particles.

Returns:

tuple

A tuple containing the computed flow magnitude and its uncertainty.

QCumulantFlow.differential_flow(particle_data, bins, flow_as_function_of, poi_pdg=None)

Compute the differential flow. The cumulants of second and fourth order are implemented.

Parameters:

particle_datalist

List of particle data.

binslist or np.ndarray

Bins used for the differential flow calculation.

flow_as_function_ofstr

Variable on which the flow is calculated (“pt”, “rapidity”, or “pseudorapidity”).

poi_pdglist

List of PDG id for identified particle differential flow.

Returns:

list of tuples

A list of tuples containing flow values and their corresponding uncertainty.