EvioToLcio (HPS Java 4.3-SNAPSHOT API)

java.lang.Object
- org.hps.evio.EvioToLcio

```
public final class EvioToLcio
extends Object
```
This class converts EVIO to LCIO, performing an LCSim job in the same session. The processed events are then (optionally) written to disk using an LCIOWriter.
To run this class from the command line:
java -cp hps-distribution-bin.jar EvioToLcio [options] [evioFiles]
The available arguments can be printed using:
java -cp hps-distribution-bin.jar EvioToLcio -h
Extra arguments are treated as paths to EVIO files.
This class attempts to automatically configure itself for Test Run or Engineering Run based on the run numbers in the EVIO file. It will use an appropriate default detector unless one is given on the command line, and it will also use the correct event builder. It will not handle jobs correctly with files from both the Test and Engineering Run, so don't do this!
The run number in the conditions system can be initialized in one of three ways.
1. user specified run number in which case the conditions system is frozen for the rest of the job
2. run number from an EVIO PRESTART event
3. run number from a header bank in a physics event
In the case where a file has no PRESTART event and there are header banks present, the "-m" command line option can be used to buffer a number of EVIO events. If there is a head bank found while adding these events to queue, the conditions system will be initialized from it.
Author:

Jeremy McCormick , Sho Uemura

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`detectorName` The detector name for conditions.
`private LCSimEventBuilder`	`eventBuilder` The LCSim event builder used to convert from EVIO.
`private Long`	`eventPrintInterval`
`private List<String>`	`evioFileList`
`private JobManager`	`jobManager`
`private String`	`lcioFileName`
`private static Logger`	`LOGGER` Setup logging for this class.
`private int`	`maxBufferSize`
`private int`	`maxEvents`
`private int`	`nEvents` The run number for conditions.
`private static org.apache.commons.cli.Options`	`OPTIONS` The command line options which will be defined in the constructor.
`private boolean`	`printXml`
`private Integer`	`runNumber`
`private int`	`skipEvents`
`private InputStream`	`steeringStream`
`private boolean`	`useMemoryMapping`
`private org.lcsim.lcio.LCIOWriter`	`writer`

Constructor Summary

Constructors
Constructor and Description

EvioToLcio()
The default constructor, which defines command line arguments and sets the default log level.

Constructors
Constructor and Description
`EvioToLcio()` The default constructor, which defines command line arguments and sets the default log level.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`bufferEvents(org.jlab.coda.jevio.EvioReader reader, EvioEventQueue eventQueue, int maxBufferSize)` Buffer up to `maxBufferSize` events in the `eventQueue`.
`private void`	`checkConditions(int runNumber, boolean freeze)` Check if the conditions system and event builder need to be initialized or updated given a run number.
`static void`	`main(String[] args)` Run the EVIO to LCIO converter from the command line.
`void`	`parse(String[] args)`
`private void`	`printUsage()` Print the CLI usage and exit.
`void`	`run()` This method will execute the EVIO to LCIO conversion and optionally process the events with LCSim Drivers from a steering file.
`private void`	`setupEventBuilder(int runNumber)` Setup the LCSimEventBuilder based on the current detector name and run number.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOGGER
```
private static Logger LOGGER
```
    Setup logging for this class.
  - detectorName
```
private String detectorName
```
    The detector name for conditions.
  - eventBuilder
```
private LCSimEventBuilder eventBuilder
```
    The LCSim event builder used to convert from EVIO.
  - OPTIONS
```
private static org.apache.commons.cli.Options OPTIONS
```
    The command line options which will be defined in the constructor.
  - nEvents
```
private int nEvents
```
    The run number for conditions.
  - maxEvents
```
private int maxEvents
```
  - skipEvents
```
private int skipEvents
```
  - maxBufferSize
```
private int maxBufferSize
```
  - eventPrintInterval
```
private Long eventPrintInterval
```
  - runNumber
```
private Integer runNumber
```
  - evioFileList
```
private List<String> evioFileList
```
  - printXml
```
private boolean printXml
```
  - useMemoryMapping
```
private boolean useMemoryMapping
```
  - jobManager
```
private JobManager jobManager
```
  - lcioFileName
```
private String lcioFileName
```
  - writer
```
private org.lcsim.lcio.LCIOWriter writer
```
  - steeringStream
```
private InputStream steeringStream
```
- Constructor Detail
  - EvioToLcio
```
public EvioToLcio()
```
    The default constructor, which defines command line arguments and sets the default log level.
- Method Detail
  - main
```
public static void main(String[] args)
```
    Run the EVIO to LCIO converter from the command line.
    
    Parameters:
    
    args - The command line arguments.
  - bufferEvents
```
private void bufferEvents(org.jlab.coda.jevio.EvioReader reader,
                          EvioEventQueue eventQueue,
                          int maxBufferSize)
```
    Buffer up to maxBufferSize events in the eventQueue. This method will also initialize the conditions system using a run number if a header bank is found.
    
    Parameters:
    
    reader - the EVIO reader
    
    eventQueue - the event queue
    
    maxBufferSize - the maximum number of records to buffer
  - checkConditions
```
private void checkConditions(int runNumber,
                             boolean freeze)
```
    Check if the conditions system and event builder need to be initialized or updated given a run number.
    
    Parameters:
    
    runNumber - The run number.
    
    freeze - True to freeze conditions system after it is setup.
  - printUsage
```
private void printUsage()
```
    Print the CLI usage and exit.
  - parse
```
public void parse(String[] args)
```
  - run
```
public void run()
```
    This method will execute the EVIO to LCIO conversion and optionally process the events with LCSim Drivers from a steering file. Then the resultant LCIO events will be written to disk if this option is enabled in the command line arguments.
  - setupEventBuilder
```
private void setupEventBuilder(int runNumber)
```
    Setup the LCSimEventBuilder based on the current detector name and run number.
    
    Parameters:
    
    detectorName - The detector name to be assigned to the event builder.
    
    runNumber - The run number which determines which event builder to use.

Class EvioToLcio

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

detectorName

eventBuilder

OPTIONS

nEvents

maxEvents

skipEvents

maxBufferSize

eventPrintInterval

runNumber

evioFileList

printXml

useMemoryMapping

jobManager

lcioFileName

writer

steeringStream

Constructor Detail

EvioToLcio

Method Detail

main

bufferEvents

checkConditions

printUsage

parse

run

setupEventBuilder