Analysis helpers

Collaboration diagram for Analysis helpers:

Files
file	AAFPluginRailway.C
	AAF (using AliAnalysisAlien) analysis helper.
file	AAFRailway.C
	AAF analysis helper.
file	GridDownload.C
	Helper script to download results from the Grid.
file	GridRailway.C
	Grid Analysis Railway.
file	GridTerminate.C
	Worker script to run terminate part for Grid.
file	GridWatch.C
	Script to watch master jobs and automatically submit terminate jobs.
file	LiteRailway.C
	Proof-Lite analysis helper.
file	LocalRailway.C
	Local analysis helper.
file	PluginRailway.C
	Base class for helpers using the AliAnalysisAlien plugin.
file	ProofRailway.C
file	GridTerminate.C
	Worker script to run terminate part for Grid.
file	Railway.C
	Base class for analysis helpers.
file	VAFRailway.C
	AAF analysis helper.

Classes
struct	AAFPluginRailway
struct	AAFRailway
struct	GridRailway
struct	LiteRailway
struct	LocalRailway
struct	PluginRailway
struct	ProofRailway
struct	Railway
struct	VAFRailway

Functions
void	CreateFileCollection (const TString &dir="/data/alice/data/ppb/LHC12g/pass1/188359/", const TString &tN="esdTree", const TString &pa="AliESD*", Bool_t mc=false, Bool_t recursive=false))
TString	CacheFileName (const TString &name, const TString &ext, Bool_t merge=false)
Bool_t	CheckCacheFile (const TString &name, const TString &ext, Bool_t merge=false)
void	RemoveCacheFile (const TString &name, const TString &ext, Bool_t merge=false)
TObjArray *	ReadCacheFile (const TString &name, const TString &ext, bool merge=false)
TObjArray *	ReadJobIDs (const TString &name, bool merge=false)
TObjArray *	ReadStages (const TString &name, bool merge=false)
Bool_t	ParseJobIDs (const TObjArray *jobIds, TArrayI &ret)
Bool_t	ParseState (const TString &status, TString &out)
Bool_t	GetJobState (Int_t jobId, TString &out)
Bool_t	GetJobStates (const TArrayI &jobs, TObjArray &states)
Bool_t	WaitForJobs (TArrayI &jobs, TObjArray *stages, Int_t delay, Bool_t batch)
void	GridWatch (const TString &name, Bool_t batch=false, UShort_t delay=5 *60)

Detailed Description

Function Documentation

TString CacheFileName	(	const TString &	name,
		const TString &	ext,
		Bool_t	merge = false
	)

Create token name

Parameters

name	Name
ext	Extension
merge	Merge state or not

Returns

Formatted string

Definition at line 37 of file GridWatch.C.

Referenced by CheckCacheFile(), GridWatch(), and RemoveCacheFile().

Bool_t CheckCacheFile	(	const TString &	name,
		const TString &	ext,
		Bool_t	merge = false
	)

Check if we have a particular file

Parameters

name	Base name
ext	Extension
merge	Merging stage or not

Returns

true if file exits

Definition at line 54 of file GridWatch.C.

Referenced by GridWatch().

void CreateFileCollection	(	const TString &	dir = "/data/alice/data/ppb/LHC12g/pass1/188359/",
		const TString &	tN = "esdTree",
		const TString &	pa = "AliESD*",
		Bool_t	mc = false,
		Bool_t	recursive = false
	)

Create a file collection in a ROOT file

Parameters

dir	Input directory
tN	Tree name
pa	File name pattern
mc	If true, simulations
recursive	Scan recursively

Definition at line 13 of file CreateFileCollection.C.

Bool_t GetJobState	(	Int_t	jobId,
		TString &	out
	)

Get the job state

Parameters

jobId	Job status
out	Output status string

Returns

true on success

Definition at line 261 of file GridWatch.C.

Bool_t GetJobStates	(	const TArrayI &	jobs,
		TObjArray &	states
	)

Get the job states

Parameters

jobs	List of job IDs
states	On return the states

Returns

true on success

Definition at line 305 of file GridWatch.C.

Referenced by WaitForJobs().

void GridWatch	(	const TString &	name,
		Bool_t	batch = false,
		UShort_t	delay = 5*60
	)

Watch Grid for termination of main job, and submit merging jobs as needed.

Parameters

name	Name of the job
batch	If true, do not prompt
delay	Delay between updates in seconds

Definition at line 514 of file GridWatch.C.

Bool_t ParseJobIDs	(	const TObjArray *	jobIds,
		TArrayI &	ret
	)

Parse the job IDs into an array of integers

Parameters

jobIds	List of jobs
ret	Return array

Returns

true on success

Definition at line 146 of file GridWatch.C.

Referenced by GridWatch().

Bool_t ParseState	(	const TString &	status,
		TString &	out
	)

Parse string representing status and return human-readable string

Parameters

status	Return from ps command
out	Output

Returns

true on success

Definition at line 172 of file GridWatch.C.

Referenced by GetJobState(), and GetJobStates().

TObjArray* ReadCacheFile	(	const TString &	name,
		const TString &	ext,
		bool	merge = false
	)

Read one line of text from file and return tokens.

Parameters

name	Base name
ext	Extension
merge	If true append "_merge" to name

Returns

Array of tokens or null

Definition at line 87 of file GridWatch.C.

Referenced by ReadJobIDs(), and ReadStages().

TObjArray* ReadJobIDs	(	const TString &	name,
		bool	merge = false
	)

Read list of job IDs from file

Parameters

name	Base name
merge	If true append "_merge" to name

Returns

Array of job IDs or null

Definition at line 116 of file GridWatch.C.

Referenced by GridWatch().

TObjArray* ReadStages	(	const TString &	name,
		bool	merge = false
	)

Read list of job stages from file

Parameters

name	Base name
merge	If true append "_merge" to name

Returns

Array of job stages or null

Definition at line 131 of file GridWatch.C.

Referenced by GridWatch().

void RemoveCacheFile	(	const TString &	name,
		const TString &	ext,
		Bool_t	merge = false
	)

Remove a token file

Parameters

name	Base name
ext	Extension
merge	Merging stage or not

Definition at line 69 of file GridWatch.C.

Referenced by GridWatch().

Bool_t WaitForJobs	(	TArrayI &	jobs,
		TObjArray *	stages,
		Int_t	delay,
		Bool_t	batch
	)

Wait of jobs to finish

Parameters

jobs	List of jobs
stages	Stages
delay	Delay for check
batch	If true, do not prompt

Returns

true on success, false otherwise

Definition at line 435 of file GridWatch.C.

Referenced by GridWatch().