Inheritance diagram for GeneratedDecayWeightModule:

Collaboration diagram for GeneratedDecayWeightModule:

Public Member Functions
	__init__ (self, bp_list, b0_list, gen_dmid_variable=DEFAULT_GEN_DMID_VARIABLE, weight_variable=DEFAULT_WEIGHT_VARIABLE, rest_dmid=REST_DMID, use_calibrated_dmids_only=True, store_btag_candidate_signature=False)

	initialize (self)

	event (self)

Public Attributes
	bp_list = bp_list
	B+ particle list name.

	b0_list = b0_list
	B0 particle list name.

	gen_dmid_variable = gen_dmid_variable
	ExtraInfo key name for the generated decay mode ID.

	weight_variable = weight_variable
	ExtraInfo key name for the calibration weight.

	rest_dmid = rest_dmid
	Decay mode ID used for the rest (non-calibrated) category.

	use_calibrated_dmids_only = use_calibrated_dmids_only
	Whether to restrict to calibrated decay mode IDs only.

	store_btag_candidate_signature = store_btag_candidate_signature
	Whether to store the full btag candidate signature as ExtraInfo.

Protected Member Functions
	_validate_configuration (self)

	_annotate_list (self, list_name, truth_cache)

Static Protected Member Functions
	_normalize_int (value)

	_set_extra_info (particle, key, value)

	_is_non_continuum_event (particle)

	_report_missing_truth_annotation (list_name, particle, reason)

Protected Attributes
bool	_validated = False
	Internal flag: True after configuration has been validated.

Detailed Description

Assign generated-decay dmIDs and calibration weights to FEI candidates.

Definition at line 417 of file generatedDecayWeights.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		bp_list,
		b0_list,
		gen_dmid_variable = DEFAULT_GEN_DMID_VARIABLE,
		weight_variable = DEFAULT_WEIGHT_VARIABLE,
		rest_dmid = REST_DMID,
		use_calibrated_dmids_only = True,
		store_btag_candidate_signature = False )

Initialise module parameters.

Definition at line 422 of file generatedDecayWeights.py.

    ):
        """Initialise module parameters."""
        super().__init__()
        
        self.bp_list = bp_list
        
        self.b0_list = b0_list
        
        self.gen_dmid_variable = gen_dmid_variable
        
        self.weight_variable = weight_variable
        
        self.rest_dmid = rest_dmid
        
        self.use_calibrated_dmids_only = use_calibrated_dmids_only
        
        self.store_btag_candidate_signature = store_btag_candidate_signature
        
        self._validated = False

Member Function Documentation

◆ _annotate_list()

_annotate_list	(	self,
		list_name,
		truth_cache )

protected

Annotate all candidates in list_name using the pre-built truth_cache.

Definition at line 506 of file generatedDecayWeights.py.

    def _annotate_list(self, list_name, truth_cache):
        """Annotate all candidates in list_name using the pre-built truth_cache."""
        plist = Belle2.PyStoreObj(list_name)
        if not plist.isValid():
            return
 
        particle_list = plist.obj()
        for i in range(plist.getListSize()):
            particle = particle_list.getParticle(i)
            btag_index = self._normalize_int(vm.evaluate('mostcommonBTagIndex', particle))
            tag_pdg = self._normalize_int(vm.evaluate('mostcommonBTagPDG', particle))
            is_non_continuum = self._is_non_continuum_event(particle)
 
            gen_dm_id = INVALID_DMID
            weight = config.FEI_CALIB_CONT
            match = None
            if btag_index is None:
                if is_non_continuum:
                    self._report_missing_truth_annotation(list_name, particle, 'mostcommonBTagIndex is NaN')
            elif tag_pdg is None:
                if is_non_continuum:
                    self._report_missing_truth_annotation(list_name, particle, 'mostcommonBTagPDG is NaN')
            elif abs(tag_pdg) not in (511, 521):
                if is_non_continuum:
                    self._report_missing_truth_annotation(
                        list_name,
                        particle,
                        f'mostcommonBTagPDG={tag_pdg} is not a B0 or B+ PDG'
                    )
            else:
                match = truth_cache.get(btag_index)
                if match is None:
                    if is_non_continuum:
                        self._report_missing_truth_annotation(
                            list_name,
                            particle,
                            f'mostcommonBTagIndex={btag_index} is not present in the event truth cache'
                        )
                else:
                    gen_dm_id = match['gen_dm_id']
                    weight = match['weight']
 
            self._set_extra_info(particle, self.gen_dmid_variable, float(gen_dm_id))
            self._set_extra_info(particle, self.weight_variable, float(weight))
            if self.store_btag_candidate_signature:
                if match is None:
                    signature_values = (0,) * N_SIGNATURE_VALUES
                else:
                    signature_values = match['signature']
                for key, value in _signature_to_dict(signature_values).items():
                    self._set_extra_info(particle, key, float(value))
 

◆ _is_non_continuum_event()

_is_non_continuum_event ( particle )

staticprotected

Return True if the event is not a continuum event.

Definition at line 493 of file generatedDecayWeights.py.

    def _is_non_continuum_event(particle):
        """Return True if the event is not a continuum event."""
        is_cont = vm.evaluate('isContinuumEvent', particle)
        return int(is_cont) != 1
 

◆ _normalize_int()

_normalize_int ( value )

staticprotected

Return int(value), or None if value is NaN.

Definition at line 480 of file generatedDecayWeights.py.

    def _normalize_int(value):
        """Return int(value), or None if value is NaN."""
        return None if value != value else int(value)
 

◆ _report_missing_truth_annotation()

_report_missing_truth_annotation	(	list_name,
		particle,
		reason )

staticprotected

Emit a B2ERROR for a non-continuum candidate missing its truth annotation.

Definition at line 499 of file generatedDecayWeights.py.

    def _report_missing_truth_annotation(list_name, particle, reason):
        """Emit a B2ERROR for a non-continuum candidate missing its truth annotation."""
        b2.B2ERROR(
            "ModeSelector generated weights: non-continuum candidate missing generated "
            f"B truth annotation in {list_name} (array index {particle.getArrayIndex()}): {reason}"
        )
 

◆ _set_extra_info()

_set_extra_info	(	particle,
		key,
		value )

staticprotected

Set or add an ExtraInfo entry on a particle.

Definition at line 485 of file generatedDecayWeights.py.

    def _set_extra_info(particle, key, value):
        """Set or add an ExtraInfo entry on a particle."""
        if particle.hasExtraInfo(key):
            particle.setExtraInfo(key, value)
        else:
            particle.addExtraInfo(key, value)
 

◆ _validate_configuration()

_validate_configuration ( self )

protected

Raise a fatal error if any module parameter is invalid.

Definition at line 455 of file generatedDecayWeights.py.

    def _validate_configuration(self):
        """Raise a fatal error if any module parameter is invalid."""
        if self._validated:
            return
        if not isinstance(self.bp_list, str) or not self.bp_list.startswith('B+:'):
            b2.B2FATAL(f"ModeSelector generated weights: invalid bp_list '{self.bp_list}'")
        if not isinstance(self.b0_list, str) or not self.b0_list.startswith('B0:'):
            b2.B2FATAL(f"ModeSelector generated weights: invalid b0_list '{self.b0_list}'")
        if not isinstance(self.gen_dmid_variable, str) or not self.gen_dmid_variable:
            b2.B2FATAL("ModeSelector generated weights: gen_dmid_variable must be a non-empty string")
        if not isinstance(self.weight_variable, str) or not self.weight_variable:
            b2.B2FATAL("ModeSelector generated weights: weight_variable must be a non-empty string")
        if int(self.rest_dmid) != REST_DMID:
            b2.B2FATAL(f"ModeSelector generated weights: rest_dmid must be {REST_DMID}")
        if not isinstance(self.use_calibrated_dmids_only, bool):
            b2.B2FATAL(
                "ModeSelector generated weights: use_calibrated_dmids_only must be bool"
            )
        if not isinstance(self.store_btag_candidate_signature, bool):
            b2.B2FATAL(
                "ModeSelector generated weights: store_btag_candidate_signature must be bool"
            )
        self._validated = True
 

◆ event()

event ( self )

Annotate all B candidates with generated decay mode IDs and calibration weights.

Definition at line 558 of file generatedDecayWeights.py.

    def event(self):
        """Annotate all B candidates with generated decay mode IDs and calibration weights."""
        bp_plist = Belle2.PyStoreObj(self.bp_list)
        b0_plist = Belle2.PyStoreObj(self.b0_list)
        bp_empty = not bp_plist.isValid() or bp_plist.getListSize() == 0
        b0_empty = not b0_plist.isValid() or b0_plist.getListSize() == 0
        if bp_empty and b0_empty:
            return
 
        mc_particles = Belle2.PyStoreArray('MCParticles')
        particles = [mc_particles[index] for index in range(mc_particles.getEntries())]
        truth_cache = _build_event_truth_cache(
            particles,
            use_calibrated_dmids_only=self.use_calibrated_dmids_only,
        )
        self._annotate_list(self.bp_list, truth_cache)
        self._annotate_list(self.b0_list, truth_cache)
 
 

◆ initialize()

initialize ( self )

Validate configuration once at the start of processing.

Definition at line 451 of file generatedDecayWeights.py.

    def initialize(self):
        """Validate configuration once at the start of processing."""
        self._validate_configuration()
 

Member Data Documentation

◆ _validated

bool _validated = False

protected

Internal flag: True after configuration has been validated.

Definition at line 449 of file generatedDecayWeights.py.

◆ b0_list

b0_list = b0_list

B0 particle list name.

Definition at line 437 of file generatedDecayWeights.py.

◆ bp_list

bp_list = bp_list

B+ particle list name.

Definition at line 435 of file generatedDecayWeights.py.

◆ gen_dmid_variable

gen_dmid_variable = gen_dmid_variable

ExtraInfo key name for the generated decay mode ID.

Definition at line 439 of file generatedDecayWeights.py.

◆ rest_dmid

rest_dmid = rest_dmid

Decay mode ID used for the rest (non-calibrated) category.

Definition at line 443 of file generatedDecayWeights.py.

◆ store_btag_candidate_signature

store_btag_candidate_signature = store_btag_candidate_signature

Whether to store the full btag candidate signature as ExtraInfo.

Definition at line 447 of file generatedDecayWeights.py.

◆ use_calibrated_dmids_only

use_calibrated_dmids_only = use_calibrated_dmids_only

Whether to restrict to calibrated decay mode IDs only.

Definition at line 445 of file generatedDecayWeights.py.

◆ weight_variable

weight_variable = weight_variable

ExtraInfo key name for the calibration weight.

Definition at line 441 of file generatedDecayWeights.py.

The documentation for this class was generated from the following file:

analysis/scripts/modeSelector/generatedDecayWeights.py

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _annotate_list()

◆ _is_non_continuum_event()

◆ _normalize_int()

◆ _report_missing_truth_annotation()

◆ _set_extra_info()

◆ _validate_configuration()

◆ event()

◆ initialize()

Member Data Documentation

◆ _validated

◆ b0_list

◆ bp_list

◆ gen_dmid_variable

◆ rest_dmid

◆ store_btag_candidate_signature

◆ use_calibrated_dmids_only

◆ weight_variable

◆ init()