Cicada  v1.4.1
Project 8 Processed-Data File Format Library
Functions | Variables
python.ReadKTOutputFile Namespace Reference

Functions

def ReadKTOutputFile (filename, var, katydid=False, objectType="TMultiTrackEventData", name="multiTrackEvents:Event")
 

Variables

 p = argparse.ArgumentParser(description=)
 
 help
 
 type
 
 nargs
 
 default
 
 action
 
 required
 
 args = p.parse_args()
 
def result = ReadKTOutputFile(args.input, args.branch, katydid=args.katydid, objectType=args.type, name=args.name)
 
 nElements = len(result[list(result.keys())[0]])
 

Detailed Description

Name: ReadKTOutputFile
Author: MG 
Date: 2018/05/10
Purpose: 
    Example of how to open and read a Katydid output file.
    Can read 

Function Documentation

◆ ReadKTOutputFile()

def python.ReadKTOutputFile.ReadKTOutputFile (   filename,
  var,
  katydid = False,
  objectType = "TMultiTrackEventData",
  name = "multiTrackEvents:Event" 
)
Read a ROOT file and returns specified content.
filename (str): name of the ROOT file
var (str/list): Variable to extract from the object
katydid (bool): Katydid (true) or Cicada (false) namespace
objectType (str): class name of the object to read
name (str:str): names of the tree and of the object to read, separated by a ":"

Definition at line 18 of file ReadKTOutputFile.py.

Variable Documentation

◆ action

action

Definition at line 106 of file ReadKTOutputFile.py.

◆ args

args = p.parse_args()

Definition at line 119 of file ReadKTOutputFile.py.

◆ default

default

Definition at line 103 of file ReadKTOutputFile.py.

◆ help

help

Definition at line 98 of file ReadKTOutputFile.py.

◆ nargs

nargs

Definition at line 102 of file ReadKTOutputFile.py.

◆ nElements

nElements = len(result[list(result.keys())[0]])

Definition at line 123 of file ReadKTOutputFile.py.

◆ p

p = argparse.ArgumentParser(description=)

Definition at line 94 of file ReadKTOutputFile.py.

◆ required

required

Definition at line 107 of file ReadKTOutputFile.py.

◆ result

def result = ReadKTOutputFile(args.input, args.branch, katydid=args.katydid, objectType=args.type, name=args.name)

Definition at line 121 of file ReadKTOutputFile.py.

◆ type

type

Definition at line 99 of file ReadKTOutputFile.py.