three_orientations module

Implements the three RP orientation fit.

class reaction_plane_fit.three_orientations.BackgroundFit(*args, **kwargs)[source]

Bases: reaction_plane_fit.three_orientations.ReactionPlaneFit

RPF for background region in 3 reaction plane orientations.

This is a simple helper class to define the necessary fit component. Contains fit components for 3 background RP orientations.

Parameters:as for ReactionPlaneFit. (Same) –
create_full_set_of_components(input_data: Dict[FitType, pachyderm.histogram.Histogram1D]) → Dict[str, reaction_plane_fit.fit.FitComponent][source]

Create the full set of fit components.

class reaction_plane_fit.three_orientations.BackgroundFitComponent(rp_orientation: str, *args, **kwargs)[source]

Bases: reaction_plane_fit.fit.BackgroundFitComponent

Background fit component for three RP orientations.

determine_fit_function(resolution_parameters: Dict[str, float], reaction_plane_parameter: reaction_plane_fit.base.ReactionPlaneParameter) → None[source]

Use the class parameters to determine the fit and background functions and store them.

class reaction_plane_fit.three_orientations.InclusiveSignalFit(*args, use_constrained_inclusive_background: bool = False, **kwargs)[source]

Bases: reaction_plane_fit.three_orientations.ReactionPlaneFit

RPF for inclusive signal region, and background region in 3 reaction planes orientations.

This is a simple helper class to define the necessary fit component. Contains an inclusive signal fit, and 3 background RP orientations.

Parameters:as for ReactionPlaneFit. (Same) –
create_full_set_of_components(input_data: Dict[FitType, pachyderm.histogram.Histogram1D]) → Dict[str, reaction_plane_fit.fit.FitComponent][source]

Create the full set of fit components.

class reaction_plane_fit.three_orientations.ReactionPlaneFit(resolution_parameters: Dict[str, float], use_log_likelihood: bool, signal_region: Optional[Tuple[float, float]] = None, background_region: Optional[Tuple[float, float]] = None, use_minos: bool = False, verbosity: int = 3)[source]

Bases: reaction_plane_fit.fit.ReactionPlaneFit

Base class for reaction plane fit for 3 reaction plane orientations.

_rp_orientations

List of the reaction plane orientations.

reaction_plane_parameter

Reaction plane parameters, including the orientation, center, and width.

reaction_plane_parameters = {'in_plane': ReactionPlaneParameter(orientation='in_plane', phiS=0, c=0.5235987755982988), 'inclusive': ReactionPlaneParameter(orientation='inclusive', phiS=0, c=1.5707963267948966), 'mid_plane': ReactionPlaneParameter(orientation='mid_plane', phiS=0.7853981633974483, c=0.2617993877991494), 'out_of_plane': ReactionPlaneParameter(orientation='out_of_plane', phiS=1.5707963267948966, c=0.5235987755982988)}
class reaction_plane_fit.three_orientations.SignalFit(*args, **kwargs)[source]

Bases: reaction_plane_fit.three_orientations.ReactionPlaneFit

RPF for signal and background regions with 3 reaction plane orientations.

This is a simple helper class to define the necessary fit component. Contains 3 signal orientations and 3 background RP orientations.

Parameters:as for ReactionPlaneFit. (Same) –
create_full_set_of_components(input_data: Dict[FitType, pachyderm.histogram.Histogram1D]) → Dict[str, reaction_plane_fit.fit.FitComponent][source]

Create the full set of fit components.

class reaction_plane_fit.three_orientations.SignalFitComponent(inclusive_background_function: Callable[[...], float], *args, **kwargs)[source]

Bases: reaction_plane_fit.fit.SignalFitComponent

Signal fit component for three RP orientations.

Parameters:inclusive_background_function – Background function for the inclusive RP orientation. By default, one should use fourier, but when not fitting the inclusive orientation, one should use the constrained fourier which sets the background level.
determine_fit_function(resolution_parameters: Dict[str, float], reaction_plane_parameter: reaction_plane_fit.base.ReactionPlaneParameter) → None[source]

Use the class parameters to determine the fit and background functions and store them.

reaction_plane_fit.three_orientations.background(x: float, phi: float, c: float, resolution_parameters: Dict[str, float], B: float, v2_t: float, v2_a: float, v4_t: float, v4_a: float, v1: float, v3: float, **kwargs) → float[source]

The background function is of the form specified in the RPF paper.

Resolution parameters implemented include R{2,2} through R{8,2}, which denotes the resolution of an order m reaction plane with respect to n = 2 reaction plane. R{8,2} is the highest value which should contribute to v_4^{eff}.

Parameters:
  • x (float) – Delta phi value for which the background will be calculated.
  • phi (float) – Center of the reaction plane bin. Matches up to phi_s in the RPF paper
  • c (float) – Width of the reaction plane bin. Matches up to c in the RPF paper
  • resolution_parameters (dict) – Contains the resolution parameters with respect to the n = 2 reaction plane. Note the information about the parameters above. The expected keys are “R22” - “R82”.
  • B (float) – Overall multiplicative background level.
  • v2_t (float) – Trigger v_{2}.
  • v2_a (float) – Associated v_{2}.
  • v4_t (float) – Trigger v_{4}.
  • v4_a (float) – Associated v_{4}
  • v1 (float) – v1 parameter.
  • v3 (float) – v3 parameter.
  • kwargs (dict) – Used to absorbs extra possible parameters from Minuit (especially when used in conjunction with other functions).
Returns:

Values calculated by the function.
Return type:

float
reaction_plane_fit.three_orientations.constrained_inclusive_background(x: Union[numpy.ndarray, float], B: float, v2_t: float, v2_a: float, v4_t: float, v4_a: float, v1: float, v3: float, **kwargs) → float[source]

Background function for inclusive signal component when performing the background fit.

Includes the trivial scaling factor of B / 3 because there are 3 RP orientations and that background level is set by the individual RP orientations. So when they are added together, they are (approximately) 3 times more. This constrain is not included by default because there is additional information in the relative scaling of the various EP orientations.

Parameters:
  • x (float) – Delta phi value for which the background will be calculated.
  • B (float) – Overall multiplicative background level.
  • v2_t (float) – Trigger v_{2}.
  • v2_a (float) – Associated v_{2}.
  • v4_t (float) – Trigger v_{4}.
  • v4_a (float) – Associated v_{4}
  • v1 (float) – v1 parameter.
  • v3 (float) – v3 parameter.
  • kwargs (dict) – Used to absorbs extra possible parameters from Minuit (especially when used in conjunction with other functions).
Returns:

Values calculated by the function.
Return type:

float
reaction_plane_fit.three_orientations.unconstrained_inclusive_background(x: Union[numpy.ndarray, float], B: float, v2_t: float, v2_a: float, v4_t: float, v4_a: float, v1: float, v3: float, **kwargs) → float[source]

Background function for inclusive signal component when performing the background fit.

This basically just forwards the arguments onto the Fourier series, but it renames the background variable. It doesn’t include the trivial scaling factor of approximately B / 3 that occurs when adding the three event plane orientations to compare against the inclusive because that information can be useful to further constrain the fits.

Parameters:
  • x – Delta phi value for which the background will be calculated.
  • B – Overall multiplicative background level.
  • v2_t – Trigger v_{2}.
  • v2_a – Associated v_{2}.
  • v4_t – Trigger v_{4}.
  • v4_a – Associated v_{4}
  • v1 – v1 parameter.
  • v3 – v3 parameter.
  • kwargs – Used to absorbs extra possible parameters from Minuit (especially when used in conjunction with other functions).
Returns:

Values calculated by the function.
Return type:

float