Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
material_mapping_optimisation Namespace Reference

Functions

def runMaterialMappingNoTrack
 
def runMaterialMappingVariance
 
def surfaceExperiment
 

Variables

tuple parser argparse.ArgumentParser()
 
tuple args parser.parse_args()
 
tuple pathExp os.path.join(args.outputPath, "Mapping")
 
tuple pathDB os.path.join(pathExp, "Database")
 
tuple pathResult os.path.join(pathExp, "Result")
 
tuple matDeco
 
tuple matMapDeco
 
tuple binDict matMapDeco.binningMap()
 
tuple binPipes_child dict()
 
tuple resultPipes_child dict()
 
tuple scorePipes_child dict()
 
tuple binPipes_parent dict()
 
tuple resultPipes_parent dict()
 
tuple scorePipes_parent dict()
 
tuple expJob dict()
 
tuple OptiJob dict()
 
 target surfaceExperiment,
 
tuple binMap dict()
 
 flush True,
 
list scores resultPipes_parent[job]
 
list score scores[key]
 
tuple resultBinMap dict()
 
tuple rMap
 
 outputDir args.outputPath,
 
 inputDir args.inputPath,
 
string mapName "optimised-material-map"
 
 format JsonFormat.Json,
 
 mapVolume False,
 
 s rMap,
 
tuple deadline time.time()
 
tuple timeout max(deadline - time.time(), 0)
 

Function Documentation

def material_mapping_optimisation.runMaterialMappingNoTrack (   trackingGeometry,
  decorators,
  outputDir,
  inputDir,
  mapName = "material-map",
  mapSurface = True,
  mapVolume = True,
  format = JsonFormat.Json,
  readCachedSurfaceInformation = False,
  s = None 
)
Implementation of the material mapping that doesn't write the material tracks.
Used to create the material map that will then be used to compute the material variance.

trackingGeometry : The tracking geometry
decorators : The decorators for the tracking geometry
outputDir : Output directory for the material map
inputDir : Input directory containing the Material track
mapName : Name of the material map
mapSurface : Is material being mapped onto surfaces ?
mapVolume : Is material being mapped onto volumes ?
format : Json format used to write the material map (json, cbor, ...)
readCachedSurfaceInformation : If set to true it will be assumed that the surface has already been associated with each material interaction in the input file.

Definition at line 52 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 52 of file material_mapping_optimisation.py

References runMaterialMappingVariance().

Referenced by runMaterialMappingVariance().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

def material_mapping_optimisation.runMaterialMappingVariance (   binMap,
  events,
  job,
  inputPath,
  pathExp,
  pipeResult,
  readCachedSurfaceInformation = False 
)
Run the material mapping and compute the variance for each bin of each surface
Return a dict with the GeometryId value of the surface as a key that stores
a list of pairs corresponding to the variance and number of tracks associated with each bin of the surface

binMap : Map containing the binning for each surface
events : Number of event to use in the mapping
job : ID of the job
inputPath : Directory containing the input geantino track and the json geometry
pathExp : Material mapping optimisation path
pipeResult : Pipe to send back the score to the main python instance
readCachedSurfaceInformation : Are surface information stored in the material track. Switch to true if the mapping was already performed to improve the speed.

Definition at line 150 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 150 of file material_mapping_optimisation.py

References acts.examples.odd.getOpenDataDetector(), common.getOpenDataDetectorDirectory(), print(), runMaterialMappingNoTrack(), and str.

Referenced by runMaterialMappingNoTrack().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

def material_mapping_optimisation.surfaceExperiment (   key,
  nbJobs,
  pathDB,
  pathResult,
  pipeBin,
  pipeResult,
  doPloting 
)
This function create an experiment for a given single surface
Due to how Orion is implemented only one DB can exist per job, this thus need to be call using pythons multiprocessing to circumvent the issue.

key : Id of the surface corresponding to this experiment
nbJobs : Total number of jobs to be executed simultaneously
pathDB : Path to the databases
pathResult : Path to write the result of the optimisation
pipeBin : Pipe use to send the experiment binning to the main python instance
pipeResult : Pipe to receive the result of the optimisation
doPloting : true if we want to plot the result of the optimisation and obtain the optimal material map

Definition at line 321 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 321 of file material_mapping_optimisation.py

References print(), and str.

+ Here is the call graph for this function:

Variable Documentation

tuple material_mapping_optimisation.args parser.parse_args()

Definition at line 473 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 473 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.binDict matMapDeco.binningMap()

Definition at line 498 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 498 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.binMap dict()

Definition at line 538 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 538 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.binPipes_child dict()

Definition at line 504 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 504 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.binPipes_parent dict()

Definition at line 508 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 508 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.deadline time.time()

Definition at line 630 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 630 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.expJob dict()

Definition at line 512 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 512 of file material_mapping_optimisation.py

material_mapping_optimisation.format JsonFormat.Json,

Definition at line 616 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 616 of file material_mapping_optimisation.py

Referenced by acts._adapter._make_config_adapter(), PHG4InttDetector.AddGeometryNode(), PHG4TpcEndCapDetector.AddLayer(), BEmcProfile.BEmcProfile(), Acts::Test.BOOST_FIXTURE_TEST_CASE(), generate_files_AA_dag.chmod_px(), generate_run_files_300evts_AA_MDC2.chmod_px(), generate_particle_data_table.clang_format(), TPCFEETestRecov1.Clustering(), TpcPrototypeUnpacker.Clustering(), PHG4TpcEndCapDetector.ConstructElectronics(), PHG4InttDetector.ConstructIntt(), PHG4Prototype2InnerHcalDetector.ConstructScintillatorBox(), PHG4Prototype2OuterHcalDetector.ConstructScintillatorBox(), PHG4Prototype2OuterHcalDetector.ConstructScintillatorBoxHiEta(), PHG4Prototype2InnerHcalDetector.ConstructScintillatorBoxHiEta(), PHG4Prototype3InnerHcalDetector.ConstructScintillatorBoxHiEta(), PHG4TpcEndCapDetector.ConstructWagonWheel(), PHG4MvtxSupport.CreateCableBundle(), daqBuffer.daqBuffer(), plotUtil.Draw_1Dhist(), plot_DataSimComp.Draw_1Dhist_datasimcomp(), plot_DataSimComp.Draw_1Dhist_datasimcomp_v2(), INTTVtxZ.Draw_1Dhist_fitGaussian(), centProxy.Draw_1Dhist_wPercentile(), RecoPV_optimization.Draw_1Dhist_wTF1(), plotUtil.Draw_1DhistsComp(), plot_DataSimComp.Draw_2Dhist_datasimcomp(), RecoPV_optimization.get2DTable(), Pi0MassAnalysis.Init(), PHPythia8.Init(), PHG4DetectorGroupSubsystem.InitializeParameters(), TPCFEETestRecov1.InitRun(), TpcPrototypeUnpacker.InitRun(), check_include_guards.line_fmt(), AnnularFieldSim.load3dBfield(), plot-woods-saxon.main(), generic_plotter.main(), quick_view.main(), check_include_guards.main(), global-time-converter.main(), check_license.main(), Optuna_tuning.main(), RecoPV_optimization.main(), makeCondorJobs.makeCondorJob(), TrackerEventDisplay.makeJsonFile(), PHG4ScoringManager.makeScoringHistograms(), release.markdown_changelog(), daqBuffer.nextEvent(), Fun4AllDstOutputManager.outfile_open_first_write(), plotUtil.plot_Stack(), testing::internal.PrintCharAndCodeTo(), RecoInfoExport.process_event(), CaloCalibration.process_event(), HFMLTriggerInterface.process_event(), TPCMLDataInterface.process_event(), TPCFEETestRecov1.process_event(), TpcPrototypeUnpacker.process_event(), processGeometry(), runMaterialMapping(), daqBuffer.setEventFormat(), TPCHitTrackDisplay.SimulationOut(), strptime(), remote_msg_buffer.sync(), TPCEventDisplay(), TPCEventDisplay_Clusters(), TPCEventDisplay_Hits(), TPCEventDisplay_Updated(), TPCEventDisplay_Updated_BCO(), and InttSurveyMapv1.v_LoadFromCDBTTree().

material_mapping_optimisation.inputDir args.inputPath,

Definition at line 614 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 614 of file material_mapping_optimisation.py

Referenced by Acts::Python.addHepMC3(), Acts::Python.addInput(), main(), and runRecCKFTracks().

string material_mapping_optimisation.mapName "optimised-material-map"

Definition at line 615 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 615 of file material_mapping_optimisation.py

material_mapping_optimisation.mapVolume False,

Definition at line 617 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 617 of file material_mapping_optimisation.py

Referenced by runMaterialMapping().

tuple material_mapping_optimisation.matDeco
Initial value:
1 acts.IMaterialDecorator.fromFile(
2  str(os.path.join(args.inputPath, "geometry-map.json"))
3  )

Definition at line 487 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 487 of file material_mapping_optimisation.py

Referenced by ActsExamples::Geometry.build(), and MakeActsGeometry.build().

tuple material_mapping_optimisation.matMapDeco
Initial value:
1 acts.MappingMaterialDecorator(
2  tGeometry=trackingGeometry, level=acts.logging.WARNING
3  )

Definition at line 495 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 495 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.OptiJob dict()

Definition at line 513 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 513 of file material_mapping_optimisation.py

material_mapping_optimisation.outputDir args.outputPath,

Definition at line 613 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 613 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.parser argparse.ArgumentParser()

Definition at line 452 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 452 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.pathDB os.path.join(pathExp, "Database")

Definition at line 477 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 477 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.pathExp os.path.join(args.outputPath, "Mapping")

Definition at line 476 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 476 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.pathResult os.path.join(pathExp, "Result")

Definition at line 478 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 478 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.resultBinMap dict()

Definition at line 592 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 592 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.resultPipes_child dict()

Definition at line 505 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 505 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.resultPipes_parent dict()

Definition at line 509 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 509 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.rMap
Initial value:
2  events=args.topNumberOfEvents, numThreads=1, logLevel=acts.logging.INFO
3  )

Definition at line 603 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 603 of file material_mapping_optimisation.py

material_mapping_optimisation.s rMap,

Definition at line 618 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 618 of file material_mapping_optimisation.py

list material_mapping_optimisation.score scores[key]

Definition at line 574 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 574 of file material_mapping_optimisation.py

Referenced by PHG4ScoringManager.makeScoringHistograms(), and Mat_map().

tuple material_mapping_optimisation.scorePipes_child dict()

Definition at line 506 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 506 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.scorePipes_parent dict()

Definition at line 510 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 510 of file material_mapping_optimisation.py

list material_mapping_optimisation.scores resultPipes_parent[job]

Definition at line 566 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 566 of file material_mapping_optimisation.py

tuple material_mapping_optimisation.timeout max(deadline - time.time(), 0)

Definition at line 633 of file material_mapping_optimisation.py.

View newest version in sPHENIX GitHub at line 633 of file material_mapping_optimisation.py