pdg.measurement module

class pdg.measurement.PdgFootnote(api: PdgApi, foot_id: int)[source]

Bases: object

Class for footnotes associated with a PdgMeasurement.

Note

The constructor is intended for internal API use.

Parameters:

api – API object for retrieving data.
foot_id – Primary key of the footnote in the SQLite file.

measurements() → Iterator[PdgMeasurement][source]: Get an iterator of PdgMeasurement objects that refer to this footnote.

references() → Iterator[PdgMeasurement][source]: Deprecated alias for measurements()

property text: str[source]: The footnote text, in plain text format.

class pdg.measurement.PdgMeasurement(api: PdgApi, msmt_id: int)[source]

Bases: object

Class for an individual measurement from the PDG Listings.

Note

The constructor is intended for internal API use.

Parameters:

api – API object for retrieving data.
msmt_id – Primary key of the measurement in the SQLite file.

property changebar: bool[source]: True if this measurement has been added or updated since the previous PDG edition

property charge: str[source]: Case-specific representation of the charge(s) of the particles involved in this measurement.

property comment: str[source]: Inline comment displayed with this measurement in the PDG Listings.

property confidence_level: float | None[source]: The confidence level of this measurement.

property event_count: str[source]: The number of events in the sample used for this measurement.

footnotes() → Iterator[PdgFootnote][source]: Get an iterator of PdgFootnote objects for this measurements.

get_value() → PdgValue[source]

Get the PdgValue associated with this measurement.

Raises:: PdgAmbiguousValueError – If there are multiple values (i.e. this is a multi-column measurement).

property pdgid: str[source]: The PDG Identifier to which this measurement applies.

property reference: PdgReference[source]: The PdgReference associated with this measurement.

property technique: str[source]: The technique used in this measurement.

values() → Iterator[PdgValue][source]: Get an iterator of PdgValue objects for all of the quantities associated with this measurement.

class pdg.measurement.PdgReference(api: PdgApi, ref_id: int)[source]

Bases: object

Class for literature references associated with a PdgMeasurement.

Note

The constructor is intended for internal API use.

Parameters:

api – API object for retrieving data.
ref_id – Primary key of the reference in the SQLite file.

property document_id: str[source]: The identifier for this publication in AUTHOR YEAR format.

property doi: str[source]: The DOI of this publication.

property inspire_id: str[source]: The INSPIRE identifier of this publication.

property publication_name: str[source]: The abbreviated bibliographic name (e.g. journal initials, issue, page) of this publication.

property publication_year: int[source]: The year of this publication.

property title: str[source]: The title of this publication.

class pdg.measurement.PdgValue(api: PdgApi, value_id: int)[source]

Bases: object

Class for an individual numerical value associated with a PdgMeasurement.

Note

The constructor is intended for internal API use.

Parameters:

api – API object for retrieving data.
value_id – Primary key of the value in the SQLite file.

property column_name: str[source]: The name of the column (in plain text format) in which this value is displayed in the PDG Listings.

property column_name_tex: str[source]: The name of the column (in TeX format) in which this value is displayed in the PDG Listings.

property display_in_percent: bool[source]

True if value is rendered in percent for display in Listings.

Implies that display_power_of_ten is -2.

property display_power_of_ten: int[source]: Unit multiplier (as power of ten) as used for display in Listings.

property display_value_text: str[source]

Value and uncertainty in plain text format as displayed in Listings tables.

Does not include any power of ten or percent sign. Must be combined with the display_power_of_ten property in order to obtain the numerical value in units given by the property units.

property error: float | None[source]

The total symmetric error for this value.

If the positive and negative errors differ, and the API is not in pedantic mode, accessing this property will give the average of the two.

Raises:: PdgAmbiguousValueError – If the error is asymmetric and the API is in pedantic mode.

property error_negative: float | None[source]: The total negative error for this value.

property error_positive: float | None[source]: The total positive error for this value.

property is_limit: bool[source]: True if value is a limit.

property is_lower_limit: bool[source]: True if value is a lower limit.

property is_upper_limit: bool[source]: True if value is an upper limit.

property measurement: PdgMeasurement[source]: The corresponding PdgMeasurement for this value.

property stat_error: float | None[source]

The statistical symmetric error for this value.

If the positive and negative errors differ, and the API is not in pedantic mode, accessing this property will give the average of the two.

Raises:: PdgAmbiguousValueError – If the error is asymmetric and the API is in pedantic mode.

property stat_error_negative: float | None[source]: The statistical component of the negative error for this value.

property stat_error_positive: float | None[source]: The statistical component of the positive error for this value.

property syst_error: float | None[source]

The systematic symmetric error for this value.

If the positive and negative errors differ, and the API is not in pedantic mode, accessing this property will give the average of the two.

Raises:: PdgAmbiguousValueError – If the error is asymmetric and the API is in pedantic mode.

property syst_error_negative: float | None[source]: The systematic component of the negative error for this value.

property syst_error_positive: float | None[source]: The systematic component of the positive error for this value.

property unit_text: str[source]: The units (in plain text format) in which this value is specified.

property used_in_average: bool[source]: True if value is used for calculating averages shown in Summary Tables.

property used_in_fit: bool[source]: True if value is used for calculating best-fits shown in Summary Tables.

property value: float[source]: The numerical value itself.

property value_text: str[source]: Value and uncertainty (in plain text format) in units given by property units, including the power of ten, if applicable (see display_power_of_ten).