base module¶
Utility functions for the reaction plane fit.
-
class
reaction_plane_fit.base.FitType(region: str, orientation: str)[source]¶ Bases:
objectDescribes the fit parameters of a particular component.
-
region¶ Describes the region in which the data for the fit originates. It should be either “signal” or “background” dominated.
-
orientation¶ Describe the reaction plane orientation of the data. For data which does not select or orientation, it should be described as “inclusive”. Otherwise, the values are up to the particular implementation. As an example, for three RP orientations, they are known as “in_plane”, “mid_plane”, and “out_of_plane”.
-
-
class
reaction_plane_fit.base.ReactionPlaneParameter(orientation: str, phiS: float, c: float)[source]¶ Bases:
objectParameters that defined a reaction plane.
-
orientation¶ Reaction plane orientation.
- Type
str
-
phiS¶ Center of the reaction plane bin.
- Type
float
-
c¶ Width of the reaction plane bin.
- Type
float
-
-
reaction_plane_fit.base.component_fit_result_from_rp_fit_result(fit_result: pachyderm.fit.base.FitResult, component: fit.FitComponent) → pachyderm.fit.base.BaseFitResult[source]¶ Create a component fit result from the fit component and the RP fit result.
- Parameters
fit_result – Fit result from the RP fit.
component – Fit component for this fit result.
- Returns
Constructed component fit result.
-
reaction_plane_fit.base.format_input_data(data: Union[Dict[str, Dict[str, Union[Any, pachyderm.histogram.Histogram1D]]], Dict[FitType, pachyderm.histogram.Histogram1D]]) → Dict[reaction_plane_fit.base.FitType, pachyderm.histogram.Histogram1D][source]¶ Convert input data into a more convenient format.
By using
FitType, we can very easily check that all fit components have the appropriate data.- Parameters
data – Input data to be formatted.
- Returns
Properly formatted data, with
FitTypekeys and histograms as values.