hep.lcd.contrib.util
Class EventScan

java.lang.Object
  |
  +--hep.lcd.util.driver.AbstractProcessor
        |
        +--hep.lcd.contrib.util.EventScan

public class EventScan

extends AbstractProcessor

EventScan is a class that will print out interesting quantities from the event. It can be used in either of two ways:

1. In the constructor of your driver, create an EventScan object, passing it the appropriate flags, then add it to the list of Processors:
   add(new EventScan(EMCLUS | HADCLUS));
2. Call the static method printAll, passing the LCDEvent and a set of flags:
   EventScan.printAll (event, EMCLUS | HADCLUS);

The possible flags are MC to print original particle information; VXD, TRACKER, EM, HAD, LUM, and MUON to print hit information; and TRACKS, EMCLUS, HADCLUS and REFINED to print reconstructed information. One can also include the FULL flag to print out the complete list of hit information instead of just the summary.

Not only is this class informative, but it might also be useful as a tutorial for extracting information from the LCDEvent header.

Version:

0.0.3

Author:

David Wagner

Source Code:

EventScan.java

Field Summary

static int	EM Flag to print EM calorimeter hit information.
static int	EMCLUS Flag to print all the reconstructed EM clusters.
static int	FULL Flag to print all the hit information for the VXD, TRACKER, EM, HAD, LUM and MUON detectors.
static int	HAD Flag to print hadron calorimeter hit information.
static int	HADCLUS Flag to print all the reconstructed HAD clusters.
static int	LUM Flag to print luminosity calorimeter hit information.
static int	MC Flag to print MC particle information.
static int	MUON Flag to print muon detector hit information.
static int	REFINED Flag to print all the "refined" clusters.
static int	TRACKER Flag to print tracking detector hit information.
static int	TRACKS Flag to print all the reconstructed tracks.
static int	VXD Flag to print vertex detector hit information.

Fields inherited from class hep.lcd.util.driver.AbstractProcessor

context

Constructor Summary

EventScan()
The default constructor sets things up to print nothing by default.

EventScan(int flags)
This constructor sets the default print flags.

Method Summary

void	printAll(LCDEvent event) This version of printAll() prints the event with the default flags.
static void	printAll(LCDEvent event, int printflags) This version of printAll() can be called by the user with the specified flags (no object need be constructed).
void	process(LCDEvent event) process is called automatically each event when installed by a driver.
void	setFlags(int flags) setFlags() can be used to change the print flags for an object.

Methods inherited from class hep.lcd.util.driver.AbstractProcessor

clearContext, getDebugLevel, getDebugStream, getHistogramLevel, getName, getParameterFile, getParameters, getParameters, getRandom, histogram, init, setContext, setDetector, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MC

public static final int MC

Flag to print MC particle information.

VXD

public static final int VXD

Flag to print vertex detector hit information. Prints the number of hits; if FULL is also specified, then prints every hit.

TRACKER

public static final int TRACKER

Flag to print tracking detector hit information. Prints the number of hits; if FULL is also specified, then prints every hit.

EM

public static final int EM

Flag to print EM calorimeter hit information. Prints the number of hits; if FULL is also specified, then prints every hit.

HAD

public static final int HAD

Flag to print hadron calorimeter hit information. Prints the number of hits; if FULL is also specified, then prints every hit.

LUM

public static final int LUM

Flag to print luminosity calorimeter hit information. Prints the number of hits; if FULL is also specified, then prints every hit.

MUON

public static final int MUON

Flag to print muon detector hit information. Prints the number of hits; if FULL is also specified, then prints every hit.

TRACKS

public static final int TRACKS

Flag to print all the reconstructed tracks.

EMCLUS

public static final int EMCLUS

Flag to print all the reconstructed EM clusters.

HADCLUS

public static final int HADCLUS

Flag to print all the reconstructed HAD clusters.

REFINED

public static final int REFINED

Flag to print all the "refined" clusters.

FULL

public static final int FULL

Flag to print all the hit information for the VXD, TRACKER, EM, HAD, LUM and MUON detectors.

Constructor Detail

EventScan

public EventScan()

The default constructor sets things up to print nothing by default. (The flags can be changed with the setFlags() method.)

See Also:

setFlags(int)

EventScan

public EventScan(int flags)

This constructor sets the default print flags. (The flags can be changed with the setFlags() method.)

See Also:

setFlags(int)

Method Detail

setFlags

public void setFlags(int flags)

setFlags() can be used to change the print flags for an object.

Parameters:

flags - bit mask of flags or'd together to indicate which detectors to print information for.

process

public void process(LCDEvent event)

process is called automatically each event when installed by a driver.

Parameters:

event - The event object.

printAll

public void printAll(LCDEvent event)

This version of printAll() prints the event with the default flags.

Parameters:

event - The event object.

printAll

public static void printAll(LCDEvent event,
                            int printflags)

This version of printAll() can be called by the user with the specified flags (no object need be constructed).

Parameters:

event - The event object.

flags - bit mask of flags or'd together to indicate which detectors to print information for.