ElossHarvestingModule Class Reference

Inheritance diagram for ElossHarvestingModule:

Public Member Functions
	__init__ (self, output_file_name)
	initialize (self)
	prepare (self)
	pick (self, track)
	peel (self, track)
	id (self)
	event (self)
	terminate (self)
	barn (self)
	gather (self)
	refine (self, crops)

Static Public Member Functions
	create_crop_part_collection ()
	iter_store_obj (store_obj)

Public Attributes
	mc_track_lookup = None
	by default, there is no method to find matching MC tracks
	track_fitter = origin_track_fitter
	Use the CDCReimannFitter with a constrained origin for track fitting.
	mc_hit_lookup = TFCDC.CDCMCHitLookUp.getInstance()
	Method to find matching MC tracks.
	eloss_estimator = TFCDC.EnergyLossEstimator.forCDC()
	Method to estimate dE/dx in the CDC.
	bfield = TFCDC.CDCBFieldUtil
	Method to interrogate the magnetic field values.
	foreach = foreach
	Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.
	output_file_name = output_file_name
	Name of the ROOT output file to be generated.
	title = title or self.name()
	Name of this harvest.
	contact = contact
	Contact email address to be displayed on the validation page.
int	expert_level = self.default_expert_level if expert_level is None else expert_level
	Integer expert level that controls to detail of plots to be generated.
list	refiners = []
	A list of additional refiner instances to be executed on top of the refiner methods that are members of this class.
	show_results = show_results
	Switch to show the result ROOT file in a TBrowser on terminate.
	stash = self.barn()
	stash of the harvested crops (start with those in the barn)
	crops
	the dictionaries from peel
	raw_crops = raw_crops
	the dictionaries from peel as a numpy.array of doubles

Static Public Attributes
	save_tree = refiners.save_tree()
	Refiners to be executed at the end of the harvesting / termination of the module Save a tree of all collected variables in a sub folder.
	save_histograms
	Save histograms in a sub folder.
	save_histograms_stackby_charge
	Save the histograms, stacked by charge, in a sub folder.
	save_scatter
	Save the scatterplots in a sub folder.
	save_profiles
	Save the profile histograms to the output ROOT file.
	save_bz_profiles
	Save the magnetic-field profile histogram in a sub folder.
	save_cid_histogram
	Save the eloss-displacement histograms in a sub folder.
	save_cid_profiles
	Save the eloss-displacement profile histograms in a sub folder.
	save_cid_scatters
	Save the eloss-displacement scatterplots in a sub folder.
	save_energy_cid_histogram
	Save the eloss histograms in a sub folder.
	save_energy_cid_profiles
	Save the eloss profile histograms in a sub folder.
	save_energy_cid_scatters
	Save the eloss profile scatterplots in a sub folder.
int	default_expert_level = 1
	The default value of expert_level if not specified explicitly by the caller.

Detailed Description

Module to collect information about the generated segments and
compose validation plots on terminate.

Definition at line 141 of file record.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			output_file_name )

Constructor

Definition at line 146 of file record.py.

    def __init__(self, output_file_name):
        """Constructor"""
        super().__init__(foreach='CDCTrackVector',
                         output_file_name=output_file_name)
 
        ## by default, there is no method to find matching MC tracks
        self.mc_track_lookup = None
 
        origin_track_fitter = TFCDC.CDCRiemannFitter()
        origin_track_fitter.setOriginConstrained()
        ## Use the CDCReimannFitter with a constrained origin for track fitting
        self.track_fitter = origin_track_fitter
 

Member Function Documentation

barn()

barn ( self )

inherited

Coroutine that receives the dictionaries of names and values from peel and store them.

Reimplemented in PickleHarvestingModule.

Definition at line 287 of file harvesting.py.

    def barn(self):
        """Coroutine that receives the dictionaries of names and values from peel and store them."""
        crop = (yield)
        raw_crops = copy.copy(crop)
        crops = copy.copy(crop)
 
        if isinstance(crop, numbers.Number):
            raw_crops = self.create_crop_part_collection()
            try:
                while True:
                    raw_crops.append(crop)
                    # next crop
                    crop = (yield)
            except GeneratorExit:
                crops = np.array(raw_crops)
 
        elif isinstance(crop, collections.abc.MutableMapping):
            for part_name in crop:
                raw_crops[part_name] = self.create_crop_part_collection()
 
            try:
                while True:
                    for part_name, parts in list(raw_crops.items()):
                        if part_name in crop:
                            parts.append(crop[part_name])
                        else:
                            parts.append(np.NaN)
                    # next crop
                    crop = (yield)
            except GeneratorExit:
                for part_name, parts in list(raw_crops.items()):
                    crops[part_name] = np.array(parts)
 
        else:
            msg = f"Unrecognised crop {crop} of type {type(crop)}"
            raise ValueError(msg)
 
        
        self.raw_crops = raw_crops
        
        self.crops = crops
 

create_crop_part_collection()

create_crop_part_collection ( )

staticinherited

Create the storing objects for the crop values

Currently a numpy.array of doubles is used to store all values in memory.

Definition at line 279 of file harvesting.py.

    def create_crop_part_collection():
        """Create the storing objects for the crop values
 
        Currently a numpy.array of doubles is used to store all values in memory.
        """
        return array.array("d")
 

event()

event ( self )

inherited

Event method of the module

* Does invoke the prepare method before the iteration starts.
* In each event fetch the StoreArray / iterable StoreObjPtr,
* Iterate through all instances
* Feed each instance to the pick method to decide it the instance is relevant
* Forward it to the peel method that should generated a dictionary of values
* Store each dictionary of values

Definition at line 239 of file harvesting.py.

    def event(self):
        """Event method of the module
 
        * Does invoke the prepare method before the iteration starts.
        * In each event fetch the StoreArray / iterable StoreObjPtr,
        * Iterate through all instances
        * Feed each instance to the pick method to decide it the instance is relevant
        * Forward it to the peel method that should generated a dictionary of values
        * Store each dictionary of values
        """
        self.prepare()
        stash = self.stash.send
        pick = self.pick
        peel = self.peel
        for crop in self.gather():
            if pick(crop):
                crop = peel(crop)
                if isinstance(crop, types.GeneratorType):
                    many_crops = crop
                    for crop in many_crops:
                        stash(crop)
                else:
                    stash(crop)
 

gather()

gather ( self )

inherited

Iterator that yield the instances form the StoreArray / iterable StoreObj.

Yields
------
Object instances from the StoreArray, iterable StoreObj or the StoreObj itself
in case it is not iterable.

Definition at line 329 of file harvesting.py.

    def gather(self):
        """Iterator that yield the instances form the StoreArray / iterable StoreObj.
 
        Yields
        ------
        Object instances from the StoreArray, iterable StoreObj or the StoreObj itself
        in case it is not iterable.
        """
 
        registered_store_arrays = Belle2.PyStoreArray.list()
        registered_store_objs = Belle2.PyStoreObj.list()
 
        foreach = self.foreach
        foreach_is_store_obj = foreach in registered_store_objs
        foreach_is_store_array = foreach in registered_store_arrays
 
        if foreach is not None:
            if foreach_is_store_array:
                store_array = Belle2.PyStoreArray(self.foreach)
                yield from store_array
 
            elif foreach_is_store_obj:
                store_obj = Belle2.PyStoreObj(self.foreach)
                try:
                    yield from self.iter_store_obj(store_obj)
                except TypeError:
                    # Cannot iter the store object. Yield it instead.
                    yield store_obj.obj()
 
            else:
                msg = f"Name {self.foreach} does not refer to a valid object on the data store"
                raise KeyError(msg)
        else:
            yield None
 

id()

id ( self )

inherited

Working around that name() is a method.

Exposing the name as a property using a different name

Definition at line 224 of file harvesting.py.

    def id(self):
        """Working around that name() is a method.
 
        Exposing the name as a property using a different name
        """
        return self.name()
 

initialize()

initialize

(

self

)

Receive signal at the start of event processing

Reimplemented from HarvestingModule.

Definition at line 159 of file record.py.

    def initialize(self):
        """Receive signal at the start of event processing"""
        super().initialize()
        
        self.mc_track_lookup = TFCDC.CDCMCTrackLookUp.getInstance()
        
        self.mc_hit_lookup = TFCDC.CDCMCHitLookUp.getInstance()
        
        self.eloss_estimator = TFCDC.EnergyLossEstimator.forCDC()
        
        self.bfield = TFCDC.CDCBFieldUtil
 

iter_store_obj()

iter_store_obj ( store_obj )

staticinherited

Obtain a iterator from a StoreObj

Repeatedly calls iter(store_obj) or store_obj.__iter__()
until the final iterator returns itself

Returns
-------
iterator of the StoreObj

Definition at line 443 of file harvesting.py.

    def iter_store_obj(store_obj):
        """Obtain a iterator from a StoreObj
 
        Repeatedly calls iter(store_obj) or store_obj.__iter__()
        until the final iterator returns itself
 
        Returns
        -------
        iterator of the StoreObj
        """
        iterable = store_obj.obj()
        last_iterable = None
        while iterable is not last_iterable:
            if hasattr(iterable, "__iter__"):
                iterable, last_iterable = iterable.__iter__(), iterable
            else:
                iterable, last_iterable = iter(iterable), iterable
        return iterable
 
 

peel()

peel	(		self,
			track )

Aggregate the track and MC information for dE/dx analysis

Reimplemented from HarvestingModule.

Definition at line 192 of file record.py.

    def peel(self, track):
        """Aggregate the track and MC information for dE/dx analysis"""
        mc_track_lookup = self.mc_track_lookup
 
        # rl_drift_circle = 1
        # unit_variance = 0
        # observations2D = TFCDC.CDCObservations2D(rl_drift_circle, unit_variance)
 
        # for recoHit3D in track:
        #    observations2D.append(recoHit3D)
 
        # trajectory2D = track_fitter.fit(observations2D)
        # trajectory2D.setLocalOrigin(TFCDC.Vector2D(0, 0))
 
        mc_particle = mc_track_lookup.getMCParticle(track)
        pdg_code = mc_particle.getPDG()
        t_vertex = mc_particle.getVertex()
        t_mom = mc_particle.getMomentum()
        charge = mc_particle.getCharge()
        mass = mc_particle.getMass()
        mc_energy = mc_particle.getEnergy()
 
        mc_vertex2D = TFCDC.Vector2D(t_vertex.XYvector())
        mc_mom2D = TFCDC.Vector2D(t_mom.XYvector())
        mc_trajectory2D = TFCDC.CDCTrajectory2D(mc_vertex2D, 0, mc_mom2D, charge)
        mc_pt = mc_mom2D.norm()
 
        first_hit = self.mc_track_lookup.getFirstHit(track)
        first_sim_hit = first_hit.getRelated("CDCSimHits")
        if first_sim_hit is None:
            return
        # Make sure we start the track in the first layer to avoid some confusion
        if first_sim_hit.getWireID().getICLayer() != 0:
            return
 
        last_hit = self.mc_track_lookup.getLastHit(track)
        last_sim_hit = last_hit.getRelated("CDCSimHits")
        if last_sim_hit is None:
            return
        # Make sure we start the track in the last layer to avoid some confusion
        # if last_sim_hit.getWireID().getICLayer() != 55: return
        # last_sim_mom3D = TFCDC.Vector3D(last_sim_hit.getMomentum())
 
        first_sim_pos3D = TFCDC.Vector3D(first_sim_hit.getPosTrack())
        first_sim_mom3D = TFCDC.Vector3D(first_sim_hit.getMomentum())
        first_sim_tof = first_sim_hit.getFlightTime()
        first_sim_energy = np.sqrt(first_sim_mom3D.norm() ** 2 + mass ** 2)
        first_sim_pt = first_sim_mom3D.cylindricalR()
        first_sim_pz = first_sim_mom3D.z()
 
        first_sim_mom2D = first_sim_mom3D.xy()
 
        # first_sim_mom2D.normalizeTo(last_sim_mom3D.cylindricalR())
        first_sim_trajectory2D = TFCDC.CDCTrajectory2D(first_sim_pos3D.xy(), first_sim_tof, first_sim_mom2D, charge)
 
        # mc_trajectory3D = mc_track_lookup.getTrajectory3D(track)
        # mc_trajectory2D = mc_trajectory3D.getTrajectory2D()
 
        for reco_hit3D in track:
            sim_hit = self.mc_hit_lookup.getSimHit(reco_hit3D.getWireHit().getHit())
            if sim_hit is None:
                continue
 
            sim_mom3D = TFCDC.Vector3D(sim_hit.getMomentum())
            sim_energy = np.sqrt(sim_mom3D.norm() ** 2 + mass ** 2)
            sim_pt = sim_mom3D.cylindricalR()
            sim_pz = sim_mom3D.z()
 
            mc_eloss_truth = mc_energy - sim_energy
            first_eloss_truth = first_sim_energy - sim_energy
 
            sim_pos3D = TFCDC.Vector3D(sim_hit.getPosTrack())
            sim_pos2D = sim_pos3D.xy()
 
            layer_cid = reco_hit3D.getWire().getICLayer()
            bz = self.bfield.getBFieldZ(sim_pos3D)
            r = sim_pos3D.cylindricalR()
 
            # recoPos3D = reco_hit3D.getRecoPos3D()
            # recoPos3D = TFCDC.Vector3D(sim_hit.getPosTrack())
            # recoPos2D = recoPos3D.xy()
            # refPos2D = reco_hit3D.getRefPos2D()
            # l = reco_hit3D.getSignedRecoDriftLength()
 
            mc_s2D = mc_trajectory2D.calcArcLength2D(sim_pos2D)
            first_s2D = first_sim_trajectory2D.calcArcLength2D(sim_pos2D)
 
            if mc_s2D < 0:
                # mc_s2D += mc_trajectory2D.getArcLength2DPeriod()
                continue
 
            mc_eloss_estimate = self.eloss_estimator.getEnergyLoss(mc_pt, pdg_code, mc_s2D)
            first_eloss_estimate = self.eloss_estimator.getEnergyLoss(first_sim_pt, pdg_code, first_s2D)
            first_ploss_factor = self.eloss_estimator.getMomentumLossFactor(first_sim_pt, pdg_code, first_s2D)
 
            sasha_eloss_estimate = getBetheEnergyLoss(first_sim_pt, pdg_code, first_s2D)
            sasha_ploss_factor = DeltaR(first_s2D, pdg_code, first_sim_pt)
 
            # first_residual2D = first_trajectory2D.getDist2D(refPos2D) - l
            first_residual2D = first_sim_trajectory2D.getDist2D(sim_pos2D)
            first_disp2D = charge * first_residual2D
 
            first_loss_disp2D_estimate = abs(self.eloss_estimator.getLossDist2D(first_sim_pt, pdg_code, first_s2D))
            first_delossed_disp2D = first_disp2D - first_loss_disp2D_estimate
 
            # mc_residual2D = mc_trajectory2D.getDist2D(refPos2D) - l
            mc_residual2D = mc_trajectory2D.getDist2D(sim_pos2D)
            mc_disp2D = charge * mc_residual2D
 
            mc_loss_disp2D_estimate = abs(self.eloss_estimator.getLossDist2D(mc_pt, pdg_code, mc_s2D))
            mc_delossed_disp2D = mc_disp2D - mc_loss_disp2D_estimate
 
            # s2D = trajectory2D.calcArcLength2D(recoPos2D)
            # if s2D < 0: s2D += trajectory2D.getArcLength2DPeriod()
 
            # residual2D = trajectory2D.getDist2D(recoPos2D)
            # disp2D = charge * residual2D
 
            # # Original approach
            # center2D = trajectory2D.getGlobalCircle().center()
            # radius2D = recoPos2D - center2D;
 
            # eLoss = self.eloss_estimator.getEnergyLoss(mc_pt, pdg_code, mc_s2D)
            # dx = self.eloss_estimator.getMomentumLossFactor(mc_pt, pdg_code, mc_s2D)
            # deloss_radius2D = recoPos2D - center2D;
            # deloss_radius2D.scale (1.0 /  dx)
            # loss_disp2D_estimate2 = (deloss_radius2D - radius2D).norm()
 
            # loss_disp2D_estimate3 = radius2D.norm() * (1.0 /dx - 1.0)
            # loss_disp2D_estimate3 = radius2D.norm() * ((1.0 - dx) /dx)
            # loss_disp2D_estimate3 = radius2D.norm() * (eLoss / (mc_pt - eLoss))
 
            if abs(mc_residual2D) > 6:
                continue
 
            if abs(first_residual2D) > 6:
                continue
 
            yield dict(
                layer_cid=layer_cid,
                r=r,
                bz=bz,
                # pt=trajectory2D.getAbsMom2D(),
                pdg_code=abs(pdg_code),
                mass=mass,
                charge=charge,
                mc_pt=mc_pt,
                first_sim_pt=first_sim_pt,
                sim_pt=sim_pt,
 
                diff_pt=first_sim_pt - sim_pt,
                diff_pz=first_sim_pz - sim_pz,
 
                mc_eloss_truth=mc_eloss_truth,
                mc_eloss_estimate=mc_eloss_estimate,
 
                first_eloss_truth=first_eloss_truth,
 
                first_eloss_estimate=first_eloss_estimate,
                sasha_eloss_estimate=sasha_eloss_estimate,
 
                first_ploss_factor=first_ploss_factor,
                sasha_ploss_factor=sasha_ploss_factor,
 
                # l=l,
 
                first_s2D=first_s2D,
                first_residual2D=first_residual2D,
                first_disp2D=first_disp2D,
                first_loss_disp2D_estimate=first_loss_disp2D_estimate,
                first_delossed_disp2D=first_delossed_disp2D,
 
                mc_s2D=mc_s2D,
                mc_residual2D=mc_residual2D,
                mc_disp2D=mc_disp2D,
                mc_loss_disp2D_estimate=mc_loss_disp2D_estimate,
                mc_delossed_disp2D=mc_delossed_disp2D,
 
                # s2D=s2D,
                # disp2D=disp2D,
                # residual2D=residual2D,
 
                # loss_disp2D_estimate2=loss_disp2D_estimate2,
                # loss_disp2D_estimate3=loss_disp2D_estimate3,
            )
 

pick()

pick	(		self,
			track )

Select tracks with at least 4 segments and associated primary MC particle with pt >= 0.25 GeV/c

Reimplemented from HarvestingModule.

Definition at line 175 of file record.py.

    def pick(self, track):
        """Select tracks with at least 4 segments and associated primary MC particle with pt >= 0.25 GeV/c"""
        if track.size() < 4:
            return False
 
        mc_track_lookup = self.mc_track_lookup
        mc_particle = mc_track_lookup.getMCParticle(track)
 
        # Check that mc_particle is not a nullptr
        if mc_particle is None:
            return False
 
        if mc_particle.getMomentum().Rho() < 0.250:
            return False
 
        return is_primary(mc_particle)
 

prepare()

prepare

(

self

)

Initialize the MC-hit lookup method

Reimplemented from HarvestingModule.

Definition at line 171 of file record.py.

    def prepare(self):
        """Initialize the MC-hit lookup method"""
        TFCDC.CDCMCHitLookUp.getInstance().fill()
 

refine()

refine ( self, crops )

inherited

Receive the gathered crops and forward them to the refiners.

Reimplemented in PickleHarvestingModule.

Definition at line 398 of file harvesting.py.

    def refine(self, crops):
        """Receive the gathered crops and forward them to the refiners."""
 
        kwds = {}
        if self.output_file_name:
            # Save everything to a ROOT file
            if isinstance(self.output_file_name, ROOT.TFile):
                output_tdirectory = self.output_file_name
            else:
                output_tfile = ROOT.TFile(self.output_file_name, 'recreate')
                output_tdirectory = output_tfile
 
        else:
            output_tdirectory = None
 
        try:
            with root_cd(output_tdirectory):
                for refiner in self.refiners:
                    refiner(self, crops, tdirectory=output_tdirectory, **kwds)
 
                # Get the methods marked as refiners from the class
                cls = type(self)
                for name in dir(cls):
                    if isinstance(getattr(cls, name), Refiner):
                        refiner = getattr(self, name)
                        # Getattr already binds self
                        refiner(crops, tdirectory=output_tdirectory, **kwds)
 
        finally:
            # If we opened the TFile ourself, close it again
            if self.output_file_name:
                if isinstance(self.output_file_name, str):
                    output_tfile.Close()
 
        if self.show_results and self.output_file_name:
            if isinstance(self.output_file_name, str):
                output_tfile = ROOT.TFile(self.output_file_name)
                root_browse(output_tfile)
                input("Press enter to close")
                output_tfile.Close()
            else:
                root_browse(self.output_file_name)
                input("Press enter to close")
 

terminate()

terminate ( self )

inherited

Termination method of the module.

Finalize the collected crops.
Start the refinement.

Reimplemented in ClusterFilterValidationModule.

Definition at line 263 of file harvesting.py.

    def terminate(self):
        """Termination method of the module.
 
        Finalize the collected crops.
        Start the refinement.
        """
 
        self.stash.close()
        del self.stash
 
        try:
            self.refine(self.crops)
        except AttributeError:
            pass
 

Member Data Documentation

bfield

bfield = TFCDC.CDCBFieldUtil

Method to interrogate the magnetic field values.

Definition at line 169 of file record.py.

contact

contact = contact

inherited

Contact email address to be displayed on the validation page.

Definition at line 211 of file harvesting.py.

crops

crops

inherited

the dictionaries from peel

Definition at line 274 of file harvesting.py.

default_expert_level

int default_expert_level = 1

staticinherited

The default value of expert_level if not specified explicitly by the caller.

Definition at line 156 of file harvesting.py.

eloss_estimator

eloss_estimator = TFCDC.EnergyLossEstimator.forCDC()

Method to estimate dE/dx in the CDC.

Definition at line 167 of file record.py.

expert_level

int expert_level = self.default_expert_level if expert_level is None else expert_level

inherited

Integer expert level that controls to detail of plots to be generated.

Definition at line 214 of file harvesting.py.

foreach

foreach = foreach

inherited

Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.

Definition at line 196 of file harvesting.py.

mc_hit_lookup

mc_hit_lookup = TFCDC.CDCMCHitLookUp.getInstance()

Method to find matching MC tracks.

Method to find matching MC hits

Definition at line 165 of file record.py.

mc_track_lookup

mc_track_lookup = None

by default, there is no method to find matching MC tracks

Definition at line 152 of file record.py.

output_file_name

output_file_name = output_file_name

inherited

Name of the ROOT output file to be generated.

Definition at line 199 of file harvesting.py.

raw_crops

raw_crops = raw_crops

inherited

the dictionaries from peel as a numpy.array of doubles

Definition at line 325 of file harvesting.py.

refiners

list refiners = []

inherited

A list of additional refiner instances to be executed on top of the refiner methods that are members of this class.

Definition at line 218 of file harvesting.py.

save_bz_profiles

save_bz_profiles

static

Initial value:

=  refiners.save_profiles(
        x='r',
        y='bz',
    )

Save the magnetic-field profile histogram in a sub folder.

Definition at line 425 of file record.py.

save_cid_histogram

save_cid_histogram

static

Initial value:

=  refiners.save_histograms(
        select=[
            # 'mc_disp2D',
            # 'mc_delossed_disp2D',
            'first_disp2D',
            'first_delossed_disp2D',
            'bz',
            # 'disp2D',
        ],
        outlier_z_score=5.0,
        groupby=["layer_cid"],
        # stackby="pdg_code",
    )

Save the eloss-displacement histograms in a sub folder.

Definition at line 434 of file record.py.

save_cid_profiles

save_cid_profiles

static

Initial value:

=  refiners.save_profiles(
        x=["mc_pt"],
        y=[
            # 'mc_disp2D',
            # 'mc_delossed_disp2D',
            'first_disp2D',
            'first_delossed_disp2D',
        ],
        outlier_z_score=5.0,
        groupby=["layer_cid"],
        stackby="pdg_code",
    )

Save the eloss-displacement profile histograms in a sub folder.

Definition at line 449 of file record.py.

save_cid_scatters

save_cid_scatters

static

Initial value:

=  refiners.save_scatters(
        x=["mc_pt"],
        y=[
            # 'mc_disp2D',
            # 'mc_delossed_disp2D',
            'first_disp2D',
            'first_delossed_disp2D',
        ],
        outlier_z_score=5.0,
        groupby=["layer_cid"],
        stackby="pdg_code",
    )

Save the eloss-displacement scatterplots in a sub folder.

Definition at line 463 of file record.py.

save_energy_cid_histogram

save_energy_cid_histogram

static

Initial value:

=  refiners.save_histograms(
        select=[
            'pdg_code',
            'first_eloss_estimate',
            'first_eloss_truth',
        ],
        outlier_z_score=5.0,
        groupby=["layer_cid"],
        stackby="pdg_code",
        folder_name='energy/{groupby_addition}',
    )

Save the eloss histograms in a sub folder.

Definition at line 479 of file record.py.

save_energy_cid_profiles

save_energy_cid_profiles

static

Initial value:

=  refiners.save_profiles(
        x=["mc_pt"],
        y=[
            'first_eloss_truth',
            'first_eloss_estimate',
        ],
        outlier_z_score=5.0,
        groupby=["layer_cid"],
        stackby="pdg_code",
        folder_name='energy/{groupby_addition}',
    )

Save the eloss profile histograms in a sub folder.

Definition at line 492 of file record.py.

save_energy_cid_scatters

save_energy_cid_scatters

static

Initial value:

=  refiners.save_scatters(
        x=["mc_pt"],
        y=[
            'first_eloss_truth',
            'first_eloss_estimate',
        ],
        outlier_z_score=5.0,
        groupby=["layer_cid"],
        stackby="pdg_code",
        folder_name='energy/{groupby_addition}',
    )

Save the eloss profile scatterplots in a sub folder.

Definition at line 505 of file record.py.

save_histograms

save_histograms

static

Initial value:

=  refiners.save_histograms(
        outlier_z_score=5.0,
        allow_discrete=True,
    )

Save histograms in a sub folder.

Definition at line 382 of file record.py.

save_histograms_stackby_charge

save_histograms_stackby_charge

static

Initial value:

=  refiners.save_histograms(
        select=[
            # "mc_disp2D",
            "first_disp2D",
            "charge",
        ],
        outlier_z_score=5.0,
        allow_discrete=True,
        fit="gaus",
        fit_z_score=1,
        groupby="charge",
    )

Save the histograms, stacked by charge, in a sub folder.

Definition at line 388 of file record.py.

save_profiles

save_profiles

static

Initial value:

=  refiners.save_profiles(
        x=['mc_s2D'],
        y=[
            # 'mc_disp2D',
            'first_disp2D',
            'disp2D',
        ],
        groupby=[None, "charge"],
    )

Save the profile histograms to the output ROOT file.

Definition at line 414 of file record.py.

save_scatter

save_scatter

static

Initial value:

=  refiners.save_scatters(
        x=['mc_s2D'],
        y=[
            # 'mc_disp2D',
            'disp2D',
        ],
        groupby=[None, "charge"],
        filter=lambda x: x == 211,
        filter_on="pdg_code",
    )

Save the scatterplots in a sub folder.

Definition at line 402 of file record.py.

save_tree

save_tree = refiners.save_tree()

static

Refiners to be executed at the end of the harvesting / termination of the module Save a tree of all collected variables in a sub folder.

Definition at line 380 of file record.py.

show_results

show_results = show_results

inherited

Switch to show the result ROOT file in a TBrowser on terminate.

Definition at line 221 of file harvesting.py.

stash

stash = self.barn()

inherited

stash of the harvested crops (start with those in the barn)

Definition at line 237 of file harvesting.py.

title

title = title or self.name()

inherited

Name of this harvest.

Title particle of this harvest

Definition at line 208 of file harvesting.py.

track_fitter

track_fitter = origin_track_fitter

Use the CDCReimannFitter with a constrained origin for track fitting.

Definition at line 157 of file record.py.

---

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

• tracking/trackFindingCDC/studies/eloss/record.py