FreeHEP API
Version 3.2.1

hep.aida
Interface ITupleFactory


public interface ITupleFactory

A factory for creating ITuples.

Author:
The AIDA team (http://aida.freehep.org/)

Method Summary
 ITuple create(String path, String title, String columns)
          Creates an NTuple
 ITuple create(String path, String title, String[] columnNames, Class[] columnType)
          Creates an NTuple
 ITuple create(String path, String title, String[] columnNames, Class[] columnType, String options)
          Creates an NTuple
 ITuple create(String path, String title, String columns, String options)
          Creates an NTuple
 ITuple createChained(String path, String title, ITuple[] set)
          Creates a logical chain of ITuples.
 ITuple createChained(String path, String title, String[] set)
          Creates a logical chain of ITuples.
 IEvaluator createEvaluator(String expression)
          Create IEvaluator object given its expression.
 IFilter createFilter(String expression)
          Creates IFilter object given a string defining of the "cut" expression.
 IFilter createFilter(String expression, int rowsToProcess)
          Creates a filter object given a string defining the "cut" expression.
 IFilter createFilter(String expression, int rowsToProcess, int startingRow)
          Creates a filter object given a string defining the "cut" expression.
 ITuple createFiltered(String path, ITuple tuple, IFilter filter)
          Creates a new reduced tuple (less rows) from an existing one by applying a filter.
 ITuple createFiltered(String path, ITuple tuple, IFilter filter, String[] columns)
          Creates a new reduced tuple (less rows) from an existing one by applying a filter.
 

Method Detail

create

public ITuple create(String path,
                     String title,
                     String[] columnNames,
                     Class[] columnType)
              throws IllegalArgumentException
Creates an NTuple

Parameters:
path - The path of the created ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the n-tuple
columnNames - The names of the columns
columnType - The types of the columns
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

create

public ITuple create(String path,
                     String title,
                     String[] columnNames,
                     Class[] columnType,
                     String options)
              throws IllegalArgumentException
Creates an NTuple

Parameters:
path - The path of the created ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the n-tuple
columnNames - The names of the columns
columnType - The types of the columns
options - NTuple options (currently undefined)
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

create

public ITuple create(String path,
                     String title,
                     String columns)
              throws IllegalArgumentException
Creates an NTuple

Parameters:
path - The path of the created ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the n-tuple
columns - The names and types of the columns e.g. "float px, py, pz, float energy, int charge"
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

create

public ITuple create(String path,
                     String title,
                     String columns,
                     String options)
              throws IllegalArgumentException
Creates an NTuple

Parameters:
path - The path of the created ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the n-tuple
columns - The names and types of the columns e.g. "float px, py, pz, float energy, int charge"
options - NTuple options (currently undefined)
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createChained

public ITuple createChained(String path,
                            String title,
                            ITuple[] set)
                     throws IllegalArgumentException
Creates a logical chain of ITuples. All ITuples in the set must have the same structure. Chained ITuple can not be filled. Original n-tuple data is not copied.

Parameters:
path - The path of the chained ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the new n-tuple
set - The array of ITuples to chain
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createChained

public ITuple createChained(String path,
                            String title,
                            String[] set)
                     throws IllegalArgumentException
Creates a logical chain of ITuples. All ITuples in the set must have the same structure. Chained ITuple can not be filled. Original n-tuple data is not copied.

Parameters:
path - The path of the chained ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
title - The title of the new n-tuple
set - The array of the names of the ITuples to chain
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createFiltered

public ITuple createFiltered(String path,
                             ITuple tuple,
                             IFilter filter)
                      throws IllegalArgumentException
Creates a new reduced tuple (less rows) from an existing one by applying a filter. Data is explicitly copied to a new n-tuple.

Parameters:
path - The path of the filtered ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
tuple - Original n-tuple
filter - IFilter to be used
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createFiltered

public ITuple createFiltered(String path,
                             ITuple tuple,
                             IFilter filter,
                             String[] columns)
                      throws IllegalArgumentException
Creates a new reduced tuple (less rows) from an existing one by applying a filter. Only subset of the variables (columns) is copied. Data is explicitly copied to a new n-tuple.

Parameters:
path - The path of the filtered ITuple. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
tuple - Original n-tuple
filter - IFilter to be used
columns - Names of columns to for a new n-tuple
Throws:
IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.

createFilter

public IFilter createFilter(String expression)
Creates IFilter object given a string defining of the "cut" expression.

Parameters:
expression - String defining of the "cut" expression.

createFilter

public IFilter createFilter(String expression,
                            int rowsToProcess)
Creates a filter object given a string defining the "cut" expression. Filter processes only subset of data.

Parameters:
expression - String defining of the "cut" expression.
rowsToProcess - How many rows to process

createFilter

public IFilter createFilter(String expression,
                            int rowsToProcess,
                            int startingRow)
Creates a filter object given a string defining the "cut" expression. Filter processes only subset of data.

Parameters:
expression - String defining of the "cut" expression.
rowsToProcess - How many rows to process
startingRow - Row number where to start

createEvaluator

public IEvaluator createEvaluator(String expression)
Create IEvaluator object given its expression.

Parameters:
expression - String defining of the evaluator expression.

FreeHEP API
Version 3.2.1

Copyright © 2000-2003 AIDA Team, All Rights Reserved.