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 name, String title, String columns) Creates an NTuple
ITuple	create(String name, String title, String[] columnNames, Class[] columnType) Creates an NTuple
ITuple	create(String name, String title, String[] columnNames, Class[] columnType, String options) Creates an NTuple
ITuple	create(String name, String title, String columns, String options) Creates an NTuple
ITuple	createChained(String name, String title, ITuple[] set) Creates a logical chain of ITuples.
ITuple	createChained(String name, 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 name, ITuple tuple, IFilter filter) Creates a new reduced tuple (less rows) from an existing one by applying a filter.
ITuple	createFiltered(String name, 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 name,
                     String title,
                     String[] columnNames,
                     Class[] columnType)

Creates an NTuple

Parameters:

name - The persistency name of the n-tuple

title - The title of the n-tuple

columnNames - The names of the columns

columnType - The types of the columns

create

public ITuple create(String name,
                     String title,
                     String[] columnNames,
                     Class[] columnType,
                     String options)

Creates an NTuple

Parameters:

name - The persistency name of the n-tuple

title - The title of the n-tuple

columnNames - The names of the columns

columnType - The types of the columns

options - NTuple options (currently undefined)

create

public ITuple create(String name,
                     String title,
                     String columns)

Creates an NTuple

Parameters:

name - The persistency name of the n-tuple

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"

create

public ITuple create(String name,
                     String title,
                     String columns,
                     String options)

Creates an NTuple

Parameters:

name - The persistency name of the n-tuple

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)

createChained

public ITuple createChained(String name,
                            String title,
                            ITuple[] set)

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:

name - The persistency name of the new n-tuple

title - The title of the new n-tuple

set - The array of ITuples to chain

createChained

public ITuple createChained(String name,
                            String title,
                            String[] set)

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:

name - The persistency name of the new n-tuple

title - The title of the new n-tuple

set - The array of the names of the ITuples to chain

createFiltered

public ITuple createFiltered(String name,
                             ITuple tuple,
                             IFilter filter)

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:

name - The persistency name of the new n-tuple

tuple - Original n-tuple

filter - IFilter to be used

createFiltered

public ITuple createFiltered(String name,
                             ITuple tuple,
                             IFilter filter,
                             String[] columns)

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:

name - The persistency name of the new n-tuple

tuple - Original n-tuple

filter - IFilter to be used

columns - Names of columns to for a new n-tuple

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.