SegmentFitValidationModule Class Reference

Inheritance diagram for SegmentFitValidationModule:

Public Member Functions
def	__init__ (self, output_file_name)
def	initialize (self)
def	prepare (self)
def	pick (self, segment)
def	peel (self, segment)

Public Attributes
	mc_segment_lookup
	by default, there is no method to find matching MC track segments
	mc_hit_lookup
	Method to find matching MC hits.

Static Public Attributes
refiners	save_histograms = refiners.save_histograms(outlier_z_score=5.0, allow_discrete=True)
	Save histograms in a sub folder.
refiners	save_tree = refiners.save_tree()
	Save a tree of all collected variables in a sub folder.
refiners	save_curvature_pull
	Save curvature-pull information in a sub folder.
refiners	save_curvature_pull_rl_pure
	Save right-left curvature-pull information in a sub folder.
refiners	save_absolute_curvature_pull
	Save absolute curvature-pull information in a sub folder.
refiners	save_fit_quality_histograms
	Save fit-quality histograms in a sub folder.

Detailed Description

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

Definition at line 221 of file record.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			output_file_name
	)

Constructor

Definition at line 226 of file record.py.

    def __init__(self, output_file_name):
        """Constructor"""
        super().__init__(foreach='CDCSegment2DVector',
                         output_file_name=output_file_name)
 
        
        self.mc_segment_lookup = None
 

Member Function Documentation

initialize()

def initialize

(

self

)

Receive signal at the start of event processing

Definition at line 234 of file record.py.

    def initialize(self):
        """Receive signal at the start of event processing"""
        super().initialize()
 
        
        self.mc_segment_lookup = Belle2.TrackFindingCDC.CDCMCSegment2DLookUp.getInstance()
        
        self.mc_hit_lookup = Belle2.TrackFindingCDC.CDCMCHitLookUp.getInstance()
 

peel()

def peel	(		self,
			segment
	)

Aggregate the track and MC information for track-segment analysis

Definition at line 255 of file record.py.

    def peel(self, segment):
        """Aggregate the track and MC information for track-segment analysis"""
 
        mc_segment_lookup = self.mc_segment_lookup
        mc_hit_lookup = self.mc_hit_lookup
 
        segment_crops = cdc_peelers.peel_segment2d(segment)
 
        mc_particle = mc_segment_lookup.getMCParticle(segment)
        mc_particle_crops = peelers.peel_mc_particle(mc_particle)
 
        fit3d_truth = mc_segment_lookup.getTrajectory3D(segment)
        curvature_truth = fit3d_truth.getCurvatureXY()
 
        reconstructed_backward = mc_segment_lookup.isForwardOrBackwardToMCTrack(segment)
        is_fake = mc_segment_lookup.getMCTrackId(segment) < 0
 
        if reconstructed_backward != 1:
            curvature_truth = -curvature_truth
 
        truth_crops = dict(
            tan_lambda_truth=fit3d_truth.getTanLambda(),
            curvature_truth=curvature_truth,
            abs_curvature_truth=abs(curvature_truth),
            curvature_residual=segment_crops["curvature_estimate"] - curvature_truth,
            curvature_pull=(segment_crops["curvature_estimate"] - curvature_truth) / segment_crops["curvature_variance"],
            reconstructed_backward=reconstructed_backward,
            is_fake=is_fake
        )
 
        rl_sum = 0
        n_correct = 0
        n_total = segment.size()
        first_i_incorrect = float("nan")
        last_i_incorrect = float("nan")
        first_l_incorrect = 0
        last_l_incorrect = 0
 
        n_rl_switch = 0
        last_rl_info = 0
        for i, reco_hit2d in enumerate(segment):
            rl_info = reco_hit2d.getRLInfo()
            hit = reco_hit2d.getWireHit().getHit()
            true_rl_info = mc_hit_lookup.getRLInfo(hit)
 
            if rl_info != last_rl_info:
                n_rl_switch += 1
                last_rl_info = rl_info
 
            if true_rl_info == rl_info:
                n_correct += 1
            else:
                if first_i_incorrect != first_i_incorrect:
                    first_i_incorrect = i
                    first_l_incorrect = reco_hit2d.getRefDriftLength()
                last_i_incorrect = i
                last_l_incorrect = reco_hit2d.getRefDriftLength()
            if rl_info == 1:
                rl_sum += 1
            elif rl_info == -1 or rl_info == 65535:  # <- The root interface mistakes the signed enum value for an unsigned value
                rl_sum -= 1
 
        alias_score = segment.getAliasScore()
 
        rl_crops = dict(
            n_total=n_total,
            n_correct=n_correct,
            n_incorrect=n_total - n_correct,
            rl_purity=n_correct / n_total,
            first_incorrect_location=first_i_incorrect / (n_total - 1),
            first_l_incorrect=first_l_incorrect,
            last_incorrect_location=last_i_incorrect / (n_total - 1),
            last_l_incorrect=last_l_incorrect,
            n_rl_switch=n_rl_switch,
            n_rl_asymmetry=rl_sum / n_total,
            n_abs_rl_asymmetry=abs(rl_sum) / n_total,
            may_alias=alias_score == 0,
            alias_score=alias_score
        )
 
        segment_crops.update(truth_crops)
        segment_crops.update(mc_particle_crops)
        segment_crops.update(rl_crops)
        return segment_crops
 

pick()

def pick	(		self,
			segment
	)

Select segments with 4 or more hits and a matching primary MC particle

Definition at line 247 of file record.py.

    def pick(self, segment):
        """Select segments with 4 or more hits and a matching primary MC particle"""
        mc_segment_lookup = self.mc_segment_lookup
        mc_particle = mc_segment_lookup.getMCParticle(segment)
 
        # Check that mc_particle is not a nullptr
        return mc_particle and is_primary(mc_particle) and segment.size() > 3
 

prepare()

def prepare

(

self

)

Initialize the MC-hit lookup method

Definition at line 243 of file record.py.

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

Member Data Documentation

mc_hit_lookup

mc_hit_lookup

Method to find matching MC hits.

Definition at line 241 of file record.py.

mc_segment_lookup

mc_segment_lookup

by default, there is no method to find matching MC track segments

Method to find matching MC track segments.

Definition at line 232 of file record.py.

save_absolute_curvature_pull

refiners save_absolute_curvature_pull

static

Initial value:

=  refiners.save_pull_analysis(
        part_name="curvature",
        unit="1/cm",
        absolute=True,
        aux_names=["tan_lambda_truth", "abs_curvature_truth"],
        groupby=[
            "stereo_kind",
            "superlayer_id"
        ],
        outlier_z_score=4.0,
        title_postfix="")

Save absolute curvature-pull information in a sub folder.

Definition at line 377 of file record.py.

save_curvature_pull

refiners save_curvature_pull

static

Initial value:

=  refiners.save_pull_analysis(
        part_name="curvature",
        unit="1/cm",
        absolute=False,
        aux_names=["tan_lambda_truth", "abs_curvature_truth"],
        groupby=[
            "stereo_kind",
            "superlayer_id"
        ],
        outlier_z_score=4.0,
        title_postfix="")

Save curvature-pull information in a sub folder.

Definition at line 347 of file record.py.

save_curvature_pull_rl_pure

refiners save_curvature_pull_rl_pure

static

Initial value:

=  refiners.save_pull_analysis(
        part_name="curvature",
        unit="1/cm",
        absolute=True,
        filter_on="rl_purity",
        filter=lambda rl_purity: rl_purity > 0.5,
        aux_names=["tan_lambda_truth", "abs_curvature_truth"],
        groupby=[
            "stereo_kind",
            "superlayer_id"
        ],
        outlier_z_score=4.0,
        title_postfix="",
        folder_name="rl_pure/{groupby_addition}"
    )

Save right-left curvature-pull information in a sub folder.

Definition at line 360 of file record.py.

save_fit_quality_histograms

refiners save_fit_quality_histograms

static

Initial value:

=  refiners.save_histograms(
        outlier_z_score=5.0,
        select={
            "ndf": "ndf",
            "chi2": "#chi2",
            "p_value": "p-value",
            "tan_lambda_truth": "true tan #lambda",
        },
        groupby=[None, "stereo_kind", "superlayer_id"],
        title="Histogram of {part_name}{stacked_by_indication}{stackby}",
        description="Distribution of {part_name} in the segment fits",
    )

Save fit-quality histograms in a sub folder.

Definition at line 390 of file record.py.

save_histograms

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

static

Save histograms in a sub folder.

Definition at line 342 of file record.py.

save_tree

refiners save_tree = refiners.save_tree()

static

Save a tree of all collected variables in a sub folder.

Definition at line 344 of file record.py.

---

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

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