Discovering input files and naming the artefacts derived from them. More...

#include <FileSet.hpp>

Classes
struct	GateGroups
	The events files grouped into the units the beam gates are fitted on. More...

Static Public Member Functions
static TString	CompassBinPath (const FileSpec &s)
	Path to a CoMPASS binary subfile.
static std::vector< TString >	DiscoverRunSuffixes (Int_t run)
	Subfile suffixes present on disk for a CoMPASS run.
static TString	SolBinPath (const FileSpec &s)
	Path to a SOLARIS .sol subfile.
static std::vector< TString >	DiscoverSolRunSuffixes (Int_t run)
	Subfile suffixes present on disk for a SOLARIS run.
static std::vector< TString >	DiscoverProcessedRunSuffixes (Int_t run)
	Subfile suffixes for which processed output already exists.
static std::vector< FileSpec >	BuildFileSpecs ()
	Every raw input subfile for the configured runs.
static std::vector< FileSpec >	BuildProcessedFileSpecs ()
	Every subfile that already has processed output.
static std::vector< FileSpec >	BuildRawOrProcessedFileSpecs ()
	The union of raw and processed subfiles, without duplicates.
static TString	EventsName (const FileSpec &s)
	Filename of the built-events ROOT file for a subfile.
static TString	FileLabel (const FileSpec &s)
	Human-readable label identifying a subfile.
static FileSpec	ResolveFileSpec (const TString &file_label)
	Recover the FileSpec behind a label from FileLabel().
static GateGroups	GroupEventsForGating ()
	Build the gate groups; see GateGroups.
static Long64_t	SampleStride (Long64_t n_total, Long64_t max_points)
	Stride that visits at most `max_points` of `n_total` entries.

Detailed Description

Discovering input files and naming the artefacts derived from them.

All-static. Every name here is derived rather than stored, so a stage can reconstruct the path to any other stage's output from a FileSpec alone.

Definition at line 51 of file FileSet.hpp.

Member Function Documentation

◆ BuildFileSpecs()

std::vector< FileSpec > FileSet::BuildFileSpecs ( )

static

Every raw input subfile for the configured runs.

Returns: One FileSpec per subfile, over the runs selected by RUNS and N_CHUNKS in the dataset configuration.

Definition at line 266 of file FileSet.cpp.

Referenced by BuildRawOrProcessedFileSpecs(), and ResolveFileSpec().

◆ BuildProcessedFileSpecs()

std::vector< FileSpec > FileSet::BuildProcessedFileSpecs ( )

static

Every subfile that already has processed output.

Definition at line 270 of file FileSet.cpp.

Referenced by BuildRawOrProcessedFileSpecs(), GroupEventsForGating(), and CalibrateBeam::Run().

◆ BuildRawOrProcessedFileSpecs()

std::vector< FileSpec > FileSet::BuildRawOrProcessedFileSpecs ( )

static

The union of raw and processed subfiles, without duplicates.

Lets a stage run over everything available whether or not a given subfile has been preprocessed yet.

Returns: Raw specs first, then any processed spec not already among them.

Definition at line 274 of file FileSet.cpp.

◆ CompassBinPath()

TString FileSet::CompassBinPath ( const FileSpec & s )

static

Path to a CoMPASS binary subfile.

Parameters

s	Run and subfile.

Definition at line 6 of file FileSet.cpp.

Referenced by EnsureRunHeaderFused(), and RunFusedPipelineForFile().

◆ DiscoverProcessedRunSuffixes()

std::vector< TString > FileSet::DiscoverProcessedRunSuffixes ( Int_t run )

static

Subfile suffixes for which processed output already exists.

Parameters

run	Run number.

Definition at line 235 of file FileSet.cpp.

◆ DiscoverRunSuffixes()

std::vector< TString > FileSet::DiscoverRunSuffixes ( Int_t run )

static

Subfile suffixes present on disk for a CoMPASS run.

Parameters

run	Run number.

Returns: The suffixes found, empty if the run has no files.

Definition at line 138 of file FileSet.cpp.

◆ DiscoverSolRunSuffixes()

std::vector< TString > FileSet::DiscoverSolRunSuffixes ( Int_t run )

static

Subfile suffixes present on disk for a SOLARIS run.

Parameters

run	Run number.

Definition at line 144 of file FileSet.cpp.

Referenced by EnsureRunHeaderFused().

◆ EventsName()

TString FileSet::EventsName ( const FileSpec & s )

static

Filename of the built-events ROOT file for a subfile.

Definition at line 292 of file FileSet.cpp.

Referenced by CalibrateBeam::AggregateRidgeRatiosForRun(), CollectAnchorSamplesOneSubfile(), DiscoverProcessedRunSuffixes(), FindBeamGateStrips(), FindStripCentroidAlignment(), GroupEventsForGating(), RunFusedPipelineForFile(), SaveDynamicRangeOverlay(), and WriteCalibrationToEvents().

◆ FileLabel()

TString FileSet::FileLabel ( const FileSpec & s )

static

Human-readable label identifying a subfile.

run<N><suffix>, prefixed with the active file tag when the dataset sets one. Used in plot names, log lines, and as the key ResolveFileSpec() reverses.

Definition at line 299 of file FileSet.cpp.

Referenced by CalibrateBeam::CalibrateBeamOneSubfile(), GroupEventsForGating(), ResolveFileSpec(), and RunFusedPipelineForFile().

◆ GroupEventsForGating()

FileSet::GateGroups FileSet::GroupEventsForGating ( )

static

Build the gate groups; see GateGroups.

Definition at line 306 of file FileSet.cpp.

Referenced by StripSumScatter::Prepare().

◆ ResolveFileSpec()

FileSpec FileSet::ResolveFileSpec ( const TString & file_label )

static

Recover the FileSpec behind a label from FileLabel().

Parameters

file_label Label to resolve.

Returns: The matching spec, or one with run == -1 and an empty suffix if no configured subfile produces that label. Check run before use.

Definition at line 342 of file FileSet.cpp.

Referenced by CalibrateBeam::Run().

◆ SampleStride()

Long64_t FileSet::SampleStride	(	Long64_t	n_total,
		Long64_t	max_points )

static

Stride that visits at most max_points of n_total entries.

For scatter plots, where drawing every entry costs time and renders as a solid block anyway.

Parameters

n_total	Entries available.
max_points	Cap on entries to visit; 0 or less means no cap.

Returns: The stride, never below 1.

Definition at line 333 of file FileSet.cpp.

◆ SolBinPath()

TString FileSet::SolBinPath ( const FileSpec & s )

static

Path to a SOLARIS .sol subfile.

Parameters

s	Run and subfile.

Definition at line 11 of file FileSet.cpp.

Referenced by EnsureRunHeaderFused(), RunFusedPipelineForFile(), and SplitWorker().

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

tooling/include/FileSet.hpp
tooling/src/FileSet.cpp

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ BuildFileSpecs()

◆ BuildProcessedFileSpecs()

◆ BuildRawOrProcessedFileSpecs()

◆ CompassBinPath()

◆ DiscoverProcessedRunSuffixes()

◆ DiscoverRunSuffixes()

◆ DiscoverSolRunSuffixes()

◆ EventsName()

◆ FileLabel()

◆ GroupEventsForGating()

◆ ResolveFileSpec()

◆ SampleStride()

◆ SolBinPath()