SegmentFitValidationRun Class Reference

Inheritance diagram for SegmentFitValidationRun:

Public Member Functions
	output_file_name (self)
	harvesting_module (self, path=None)
	create_argument_parser (self, **kwds)
	create_path (self)
	pickle_crops (self, harvesting_module, crops, **kwds)
	unpickle_crops (self)
	postprocess (self)
	adjust_path (self, path)
	run (self, path)
	name (self)
	configure_and_execute_from_commandline (self)
	execute (self)
	configure_from_commandline (self)
	configure (self, arguments)

Public Attributes
	pickle_crops = self.output_file_name

Static Public Attributes
str	monte_carlo = "no"
	do not generate new events
bool	karimaki_fit = False
	use the Riemann fit instead of the Karimaki fit
str	flight_time_estimation = "none"
	do not estimate the flight time
bool	flight_time_reestimation = False
	do not re-estimate the flight time
bool	use_alpha_in_drift_length = True
	use the alpha parameter for drift length
	flight_time_mass_scale = float("nan")
	assume a very heavy particle for flight time calculation
str	fit_positions = "recoPos"
	fit the reconstructed hit position for the segment fit
str	fit_variance = "proper"
	use the drift-length variance in the segment fit
bool	show_results = False
	By default, do not show the browsing results.
bool	postprocess_only = False
	By default, browse the output TFile too.
str	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.
	generator_module = None
	By default, do not generate events.
str	detector_setup = "Default"
	By default, use the default detector setup.
list	bkg_files = []
	By default, no background overlay.
	components = None
	By default, do specific components.
bool	disable_deltas = False
	By default, do not disable delta-ray generation.
	simulation_output = None
	By default, do no store the simulation output.
bool	allow_input = True
	By default, this basf2 job can read events from an input ROOT TFile.
int	n_events = 10000
	By default, process 10000 events.
	root_input_file = None
	By default, there is no input ROOT TFile.
	random_seed = None
	By default, the random-number seed is unassigned.
int	n_processes = 0
	By default, no parallel processing.
int	n_events_to_skip = 0
	By default, do not skip any events at the start of the input ROOT TFile.

Detailed Description

Harvester to read, postprocess and inspect MC events for track-segment fit validation

Definition at line 34 of file record.py.

Member Function Documentation

adjust_path()

adjust_path ( self, path )

inherited

Add the harvester to the basf2 path

Reimplemented from EmptyRun.

Definition at line 66 of file run.py.

    def adjust_path(self, path):
        """Add the harvester to the basf2 path"""
        super().adjust_path(path)
        harvesting_module = self.harvesting_module()
        if self.output_file_name:
            harvesting_module.output_file_name = self.output_file_name
        harvesting_module.refiners.append(self.pickle_crops)
        path.add_module(harvesting_module)
        return path
 
 

configure()

configure ( self, arguments )

inherited

Save the command-line arguments as key-value pairs

Reimplemented in CDCDisplayRun, and ReadOrGenerateEventsRun.

Definition at line 73 of file minimal.py.

    def configure(self, arguments):
        """Save the command-line arguments as key-value pairs"""
        # Simply translate the arguments that have
        # the same name as valid instance arguments
        for (key, value) in list(vars(arguments).items()):
            if value is None:
                continue
            if hasattr(self, key):
                get_logger().info("Setting %s to %s", key, value)
                setattr(self, key, value)
 

configure_and_execute_from_commandline()

configure_and_execute_from_commandline ( self )

inherited

Configure basf2 job script from command-line arguments then run it

Definition at line 45 of file minimal.py.

    def configure_and_execute_from_commandline(self):
        """Configure basf2 job script from command-line arguments then run it"""
        self.configure_from_commandline()
        self.execute()
 

configure_from_commandline()

configure_from_commandline ( self )

inherited

Convert the command-line arguments to a basf2 job script

Definition at line 67 of file minimal.py.

    def configure_from_commandline(self):
        """Convert the command-line arguments to a basf2 job script"""
        argument_parser = self.create_argument_parser()
        arguments = argument_parser.parse_args()
        self.configure(arguments)
 

create_argument_parser()

create_argument_parser	(		self,
		**	kwds )

Convert command-line arguments to basf2 argument list

Reimplemented from HarvestingRunMixin.

Definition at line 83 of file record.py.

    def create_argument_parser(self, **kwds):
        """Convert command-line arguments to basf2 argument list"""
        argument_parser = super().create_argument_parser(**kwds)
 
        argument_parser.add_argument(
            '-m',
            '--monte-carlo',
            choices=["no", "medium", "full"],
            default=self.monte_carlo,
            dest='monte_carlo',
            help='Amount of monte carlo information to be used in the segment generation.',
        )
 
        argument_parser.add_argument(
            "-k",
            "--karimaki",
            dest="karimaki_fit",
            action="store_true",
            help='Use Karimaki fit instead of Riemann fit'
        )
 
        argument_parser.add_argument(
            "-fp",
            "--fit-pos",
            choices=["recoPos", "rlDriftCircle", "wirePos"],
            default=self.fit_positions,
            dest="fit_positions",
            help=("Choose which positional information the segment fit should be used. \n"
                  "* 'wirePos' means only the wire position\n"
                  "* 'recoPos' means only the reconstructed position\n"
                  "* 'rlDriftCircle' means only the drift circle with the right left passage\n")
        )
 
        argument_parser.add_argument(
            "-fv",
            "--fit-var",
            choices=["unit", "driftLength", "pseudo", "proper"],
            default=self.fit_variance,
            dest="fit_variance",
            help=("Choose which variance information the segment fit should be used. \n"
                  "* 'unit' means equal variance of 1\n"
                  "* 'driftLength' means inserting the drift length as variance, very improper because dimension mismatch\n"
                  "* 'pseudo' means the squared dirft length + plus the drift length variance "
                  "(correct dimension, proper lower bound)\n"
                  "* 'proper' means only the drift length variance\n")
        )
 
        argument_parser.add_argument(
            "-ft",
            "--flight-time-estimation",
            choices=["none", "outwards", "downwards"],
            default=self.flight_time_estimation,
            dest="flight_time_estimation",
            help=("Choose which estimation method for the time of flight should be use. \n"
                  "* 'none' no time of flight corrections\n"
                  "* 'outwards' means the minimal time needed to travel to the wire from the interaction point \n"
                  "* 'downwards' means the minimal time needed to travel to the wire from the y = 0 plane downwards \n")
        )
 
        argument_parser.add_argument(
            "-fr",
            "--flight-time-reestimation",
            action="store_true",
            dest="flight_time_reestimation",
            help=("Switch to reestimate drift length before fitting.")
        )
 
        argument_parser.add_argument(
            "-fa",
            "--use-alpha-in-drift-length",
            action="store_true",
            dest="use_alpha_in_drift_length",
            help=("Switch to serve the alpha angle to the drift length translator.")
        )
 
        argument_parser.add_argument(
            "-fm",
            "--flight-time-mass-scale",
            type=float,
            dest="flight_time_mass_scale",
            help=("Mass parameter to estimate the velocity in the time of flight estimation")
        )
 
        return argument_parser
 

create_path()

create_path

(

self

)

Sets up a path that plays back pregenerated events or generates events
based on the properties in the base class.

Reimplemented from EmptyRun.

Definition at line 168 of file record.py.

    def create_path(self):
        """
        Sets up a path that plays back pregenerated events or generates events
        based on the properties in the base class.
        """
        path = super().create_path()
 
        path.add_module("TFCDC_WireHitPreparer",
                        flightTimeEstimation=self.flight_time_estimation,
                        UseNLoops=1
                        )
 
        path.add_module("TFCDC_ClusterPreparer")
 
        
        if self.monte_carlo == "no":
            # MC free - default
            path.add_module(
                "TFCDC_SegmentFinderFacetAutomaton",
                # investigate=[],
                SegmentOrientation="none",
            )
 
        elif self.monte_carlo == "medium":
            # Medium MC - proper generation logic, but true facets and facet relations
            path.add_module("TFCDC_SegmentFinderFacetAutomaton",
                            FacetFilter="truth",
                            FacetRelationFilter="truth",
                            SegmentOrientation="none",
                            # SegmentOrientation="outwards"
                            )
 
        elif self.monte_carlo == "full":
            # Only true monte carlo segments, but make the positions realistic
            path.add_module("TFCDC_SegmentCreatorMCTruth",
                            reconstructedDriftLength=False,
                            reconstructedPositions=True)
 
        else:
            raise ValueError("Invalid degree of Monte Carlo information")
 
        path.add_module("TFCDC_SegmentFitter",
                        inputSegments="CDCSegment2DVector",
                        karimakiFit=self.karimaki_fit,
                        fitPos=self.fit_positions,
                        fitVariance=self.fit_variance,
                        updateDriftLength=self.flight_time_reestimation,
                        useAlphaInDriftLength=self.use_alpha_in_drift_length,
                        tofMassScale=self.flight_time_mass_scale)
 
        return path
 
 

execute()

execute ( self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 50 of file minimal.py.

    def execute(self):
        """Create the basf2 path then run the job"""
        # Create path and run #
        
        path = self.create_path()
        self.adjust_path(path)
        self.run(path)
 

harvesting_module()

harvesting_module	(		self,
			path = None )

Harvest and post-process the MC events

Reimplemented from HarvestingRunMixin.

Definition at line 76 of file record.py.

    def harvesting_module(self, path=None):
        """Harvest and post-process the MC events"""
        harvesting_module = SegmentFitValidationModule(self.output_file_name)
        if path:
            path.add_module(harvesting_module)
        return harvesting_module
 

name()

name ( self )

inherited

provide name of this object

Definition at line 41 of file minimal.py.

    def name(self):
        """provide name of this object"""
        return self.__class__.__name__
 

output_file_name()

output_file_name

(

self

)

Get the output ROOT filename

Reimplemented from HarvestingRunMixin.

Definition at line 63 of file record.py.

    def output_file_name(self):
        """Get the output ROOT filename"""
        file_name = "karimaki" if self.karimaki_fit else "riemann"
        file_name += "-mc-" + self.monte_carlo
        if self.flight_time_reestimation:
            file_name += "-re"
        if self.root_input_file:
            file_name += "-" + os.path.split(self.root_input_file)[1]
        else:
            file_name += ".root"
 
        return file_name
 

pickle_crops()

pickle_crops ( self, harvesting_module, crops, ** kwds )

inherited

Save the raw crops as a pickle file

Definition at line 41 of file run.py.

    def pickle_crops(self, harvesting_module, crops, **kwds):
        """Save the raw crops as a pickle file"""
        with open(self.output_file_name + ".pickle", "wb") as pickle_file:
            pickle.dump(crops, pickle_file)
 

postprocess()

postprocess ( self )

inherited

Post-process the crops

Reimplemented from BrowseTFileOnTerminateRunMixin.

Definition at line 51 of file run.py.

    def postprocess(self):
        """Post-process the crops"""
        if self.postprocess_only:
            harvesting_module = self.harvesting_module()
            if self.output_file_name:
                harvesting_module.output_file_name = self.output_file_name
            try:
                crops = self.unpickle_crops()
            except FileNotFoundError:
                print("Crops pickle file not found. Create it now.")
            else:
                harvesting_module.refine(crops)
 
        super().postprocess()
 

run()

run ( self, path )

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 45 of file mixins.py.

    def run(self, path):
        """Post-process the basf2 job output"""
        if not self.postprocess_only:
            super().run(path)
 
        self.postprocess()
 

unpickle_crops()

unpickle_crops ( self )

inherited

Load the raw crops from a pickle file

Definition at line 46 of file run.py.

    def unpickle_crops(self):
        """Load the raw crops from a pickle file"""
        with open(self.output_file_name + ".pickle", "rb") as pickle_file:
            return pickle.load(pickle_file)
 

Member Data Documentation

allow_input

bool allow_input = True

staticinherited

By default, this basf2 job can read events from an input ROOT TFile.

Definition at line 109 of file minimal.py.

bkg_files

list bkg_files = []

staticinherited

By default, no background overlay.

Definition at line 47 of file event_generation.py.

components

components = None

staticinherited

By default, do specific components.

Definition at line 49 of file event_generation.py.

description

str description = "Empty execution of basf2"

staticinherited

Description of the run setup to be displayed on command line.

Definition at line 33 of file minimal.py.

detector_setup

str detector_setup = "Default"

staticinherited

By default, use the default detector setup.

Definition at line 45 of file event_generation.py.

disable_deltas

bool disable_deltas = False

staticinherited

By default, do not disable delta-ray generation.

Definition at line 51 of file event_generation.py.

fit_positions

str fit_positions = "recoPos"

static

fit the reconstructed hit position for the segment fit

Definition at line 58 of file record.py.

fit_variance

str fit_variance = "proper"

static

use the drift-length variance in the segment fit

Definition at line 60 of file record.py.

flight_time_estimation

str flight_time_estimation = "none"

static

do not estimate the flight time

Definition at line 49 of file record.py.

flight_time_mass_scale

flight_time_mass_scale = float("nan")

static

assume a very heavy particle for flight time calculation

Definition at line 55 of file record.py.

flight_time_reestimation

bool flight_time_reestimation = False

static

do not re-estimate the flight time

Definition at line 51 of file record.py.

generator_module

generator_module = None

staticinherited

By default, do not generate events.

Definition at line 43 of file event_generation.py.

karimaki_fit

bool karimaki_fit = False

static

use the Riemann fit instead of the Karimaki fit

Definition at line 47 of file record.py.

monte_carlo

str monte_carlo = "no"

static

do not generate new events

Definition at line 45 of file record.py.

n_events

n_events = 10000

staticinherited

By default, process 10000 events.

Definition at line 111 of file minimal.py.

n_events_to_skip

int n_events_to_skip = 0

staticinherited

By default, do not skip any events at the start of the input ROOT TFile.

Definition at line 119 of file minimal.py.

n_processes

n_processes = 0

staticinherited

By default, no parallel processing.

Definition at line 117 of file minimal.py.

pickle_crops

pickle_crops = self.output_file_name

inherited

Definition at line 72 of file run.py.

postprocess_only

bool postprocess_only = False

staticinherited

By default, browse the output TFile too.

Post-process the basf2 job output

Definition at line 29 of file mixins.py.

random_seed

random_seed = None

staticinherited

By default, the random-number seed is unassigned.

Definition at line 115 of file minimal.py.

root_input_file

root_input_file = None

staticinherited

By default, there is no input ROOT TFile.

Definition at line 113 of file minimal.py.

show_results

bool show_results = False

staticinherited

By default, do not show the browsing results.

Definition at line 62 of file mixins.py.

simulation_output

simulation_output = None

staticinherited

By default, do no store the simulation output.

Definition at line 53 of file event_generation.py.

use_alpha_in_drift_length

bool use_alpha_in_drift_length = True

static

use the alpha parameter for drift length

Definition at line 53 of file record.py.

---

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

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