AIDA API
Version 3.3

hep.aida
Interface ITuple


public interface ITuple

User level interface to a Tuple. The following types are supported with corresponding types in different bindings (Java, C++, Python):

 aid typename     returned type-name,     Java class          C++ type                Python type         bits
                  case-insensitive on 
                  booking 
 ------------     -------------------     -----------------   ------------------      --------------      ------
 boolean          "bool"                  boolean.class       bool                    BooleanType         1 
 float            "float"                 float.class         float                   FlotaType           32 
 double           "double"                double.class        double                  FloatType           64 
 byte             "byte"                  byte.class          unsigned char           IntType             8 
 short            "short"                 short.class         short                   IntType             16 
 int              "int"                   int.class           int                     IntType             32 
 long             "long"                  long.class          AIDA::int64 (*)         LongType            64 
 char             "char"                  char.class          char                    StringTypes         8 
 String           "string"                java.lang.String    std::string             StringTypes         ? 
 ITuple           "tuple"                 hep.aida.ITuple     AIDA::ITuple*           ITuple              ? 
 ITupleEntry      "object"                MyClass.class       AIDA::ITupleEntry*      ITupleEntry         (**) 

      (*) for C++ we map AIDA::int64 to some type supported by the compiler, see Types.h.
     (**) should we change it into void* for AIDA version 4.0 
 

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

Method Summary
 void addRow()
          Add the current row to the ITuple.
 IAnnotation annotation()
          Get the IAnnotation corresponding to this ITuple.
 IBaseTupleColumn column(int column)
          Return a IBaseTupleColumn knowing its index.
 IBaseTupleColumn column(String name)
          Return a IBaseTupleColumn knowing its name.
 Object columnDefaultValue(int column)
          Get the column default.
 double columnMax(int column)
          Get the maximum value of a given column (if it can be converted to a double).
 double columnMean(int column)
          Get the mean value of a given column (if it can be converted to a double).
 double columnMin(int column)
          Get the minimum value of a given column (if it can be converted to a double).
 String columnName(int column)
          Get the name of a column from its index.
 String[] columnNames()
          Get the names of all the columns.
 double columnRms(int column)
          Get the RMS of a given column (if it can be converted to a double).
 int columns()
          Get the number of columns in the ITuple
 Class columnType(int column)
          Get the type of a give column.
 Class[] columnTypes()
          Get the types of all the columns.
 double evaluateMax(IEvaluator evaluator)
          Get the maximum of an evaulation.
 double evaluateMax(IEvaluator evaluator, IFilter filter)
          Get the maximum of an evaulation.
 double evaluateMin(IEvaluator evaluator)
          Get the minimum of an evaulation.
 double evaluateMin(IEvaluator evaluator, IFilter filter)
          Get the minimum of an evaulation.
 void fill(double[] values)
          Fill all the columns at once with doubles.
 void fill(float[] values)
          Fill all the columns at once with floats.
 void fill(int column, boolean value)
          Fill a given column with a boolean.
 void fill(int column, byte value)
          Fill a given column with a byte.
 void fill(int column, char value)
          Fill a given column with a char.
 void fill(int column, double value)
          Fill a given column with a double.
 void fill(int column, float value)
          Fill a given column with a float.
 void fill(int column, int value)
          Fill a given column with an integer.
 void fill(int column, long value)
          Fill a given column with a long.
 void fill(int column, Object value)
          Fill a given column with an object.
 void fill(int column, short value)
          Fill a given column with a short.
 void fill(int column, String value)
          Fill a given column with a string.
 int findColumn(String name)
          Get the index within the ITuple of a given column.
 ITuple findTuple(int column)
          Return method for tuple variables of type ITuple for a given column.
 boolean getBoolean(int column)
          Deprecated. Use the ITupleColumn#value() method.
 byte getByte(int column)
          Deprecated. Use the ITupleColumn#value() method.
 char getChar(int column)
          Deprecated. Use the ITupleColumn#value() method.
 double getDouble(int column)
          Deprecated. Use the ITupleColumn#value() method.
 float getFloat(int column)
          Deprecated. Use the ITupleColumn#value() method.
 int getInt(int column)
          Deprecated. Use the ITupleColumn#value() method.
 long getLong(int column)
          Deprecated. Use the ITupleColumn#value() method.
 Object getObject(int column)
          Deprecated. Use the ITupleColumn#value() method.
 short getShort(int column)
          Deprecated. Use the ITupleColumn#value() method.
 String getString(int column)
          Deprecated. Use the ITupleColumn#value() method.
 ITuple getTuple(int column)
          Deprecated. Please use method ITuple#findTuple(int).
 boolean next()
          Positions the cursor at the next row.
 void project(ICloud1D cloud, IEvaluator evaluatorX)
          Fill an ICloud1D from the tuple.
 void project(ICloud1D cloud, IEvaluator evaluatorX, IEvaluator weight)
          Fill an ICloud1D from the tuple.
 void project(ICloud1D cloud, IEvaluator evaluatorX, IFilter filter)
          Fill an ICloud1D from the tuple.
 void project(ICloud1D cloud, IEvaluator evaluatorX, IFilter filter, IEvaluator weight)
          Fill an ICloud1D from the tuple.
 void project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY)
          Fill an ICloud2D from the tuple.
 void project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator weight)
          Fill an ICloud2D from the tuple.
 void project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter)
          Fill an ICloud2D from the tuple.
 void project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter, IEvaluator weight)
          Fill an ICloud2D from the tuple.
 void project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ)
          Fill an ICloud3D from the tuple.
 void project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IEvaluator weight)
          Fill an ICloud3D from the tuple.
 void project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter)
          Fill an ICloud3D from the tuple.
 void project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter, IEvaluator weight)
          Fill an ICloud3D from the tuple.
 void project(IHistogram1D histogram, IEvaluator evaluatorX)
          Fill an IHistogram1D from the tuple.
 void project(IHistogram1D histogram, IEvaluator evaluatorX, IEvaluator weight)
          Fill an IHistogram1D from the tuple.
 void project(IHistogram1D histogram, IEvaluator evaluatorX, IFilter filter)
          Fill an IHistogram1D from the tuple.
 void project(IHistogram1D histogram, IEvaluator evaluatorX, IFilter filter, IEvaluator weight)
          Fill an IHistogram1D from the tuple.
 void project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY)
          Fill an IHistogram2D from the tuple.
 void project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator weight)
          Fill an IHistogram2D from the tuple.
 void project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter)
          Fill an IHistogram2D from the tuple.
 void project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter, IEvaluator weight)
          Fill an IHistogram2D from the tuple.
 void project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ)
          Fill an IHistogram3D from the tuple.
 void project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IEvaluator weight)
          Fill an IHistogram3D from the tuple.
 void project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter)
          Fill an IHistogram3D from the tuple.
 void project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter, IEvaluator weight)
          Fill an IHistogram3D from the tuple.
 void project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY)
          Fill an IProfile1D from the tuple.
 void project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator weight)
          Fill an IProfile1D from the tuple.
 void project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter)
          Fill an IProfile1D from the tuple.
 void project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter, IEvaluator weight)
          Fill an IProfile1D from the tuple.
 void project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ)
          Fill an IProfile2D from the tuple.
 void project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IEvaluator weight)
          Fill an IProfile2D from the tuple.
 void project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter)
          Fill an IProfile2D from the tuple.
 void project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter, IEvaluator weight)
          Fill an IProfile2D from the tuple.
 void reset()
          Reset the ITuple.
 void resetRow()
          Clear the current(not yet added) row.
 int rows()
          Get the number of rows currently filled in the ITuple.
 void setRow(int rowIndex)
          Position the cursor at a give row.
 void setTitle(String title)
          Set the title of the ITuple.
 void skip(int rows)
          Skips a given number of rows.
 void start()
          Positions the read cursor immediately before the first row.
 String title()
          Get the title of this ITuple.
 

Method Detail

title

public String title()
Get the title of this ITuple.

Returns:
The ITuple's title.

setTitle

public void setTitle(String title)
              throws IllegalArgumentException
Set the title of the ITuple.

Parameters:
title - The new ITuple's title.
Throws:
IllegalArgumentEception - If title cannot be changed.
IllegalArgumentException

annotation

public IAnnotation annotation()
Get the IAnnotation corresponding to this ITuple.

Returns:
The ITuple's IAnnotation.

fill

public void fill(int column,
                 double value)
          throws IllegalArgumentException
Fill a given column with a double. If the value is NaN the entry will be recorded but it will not contribue to the column's statistics.

Parameters:
column - The column's index within the ITuple.
value - The double.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 float value)
          throws IllegalArgumentException
Fill a given column with a float. If the value is NaN the entry will be recorded but it will not contribue to the column's statistics.

Parameters:
column - The column's index within the ITuple.
value - The float.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 int value)
          throws IllegalArgumentException
Fill a given column with an integer.

Parameters:
column - The column's index within the ITuple.
value - The integer.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 short value)
          throws IllegalArgumentException
Fill a given column with a short.

Parameters:
column - The column's index within the ITuple.
value - The short.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 long value)
          throws IllegalArgumentException
Fill a given column with a long.

Parameters:
column - The column's index within the ITuple.
value - The long.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 char value)
          throws IllegalArgumentException
Fill a given column with a char.

Parameters:
column - The column's index within the ITuple.
value - The char.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 byte value)
          throws IllegalArgumentException
Fill a given column with a byte.

Parameters:
column - The column's index within the ITuple.
value - The byte.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 boolean value)
          throws IllegalArgumentException
Fill a given column with a boolean.

Parameters:
column - The column's index within the ITuple.
value - The boolean.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 String value)
          throws IllegalArgumentException
Fill a given column with a string.

Parameters:
column - The column's index within the ITuple.
value - The string.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int column,
                 Object value)
          throws IllegalArgumentException
Fill a given column with an object.

Parameters:
column - The column's index within the ITuple.
value - The object.
Throws:
IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(double[] values)
          throws IllegalArgumentException
Fill all the columns at once with doubles.

Parameters:
values - The array of doubles.
Throws:
IllegalArgumentException - If any column is not of type double or if the array has the wrong dimension.

fill

public void fill(float[] values)
          throws IllegalArgumentException
Fill all the columns at once with floats.

Parameters:
values - The array of floats.
Throws:
IllegalArgumentException - If any column is not of type float or if the array has the wrong dimension.

addRow

public void addRow()
            throws OutOfStorageException
Add the current row to the ITuple. This method should be called after fill has been called for the columns; unfilled columns will be filled with their default value.

Throws:
OutOfStorageException - When the ITuple runs out of storage space.

resetRow

public void resetRow()
Clear the current(not yet added) row.


reset

public void reset()
Reset the ITuple. All the rows are reset. The ITuple is as just created.


rows

public int rows()
Get the number of rows currently filled in the ITuple.

Returns:
The number of rows. -1 if empty or if it cannot be determined.

start

public void start()
Positions the read cursor immediately before the first row.


skip

public void skip(int rows)
          throws IllegalArgumentException
Skips a given number of rows.

Parameters:
rows - The number of rows to skip.
Throws:
IllegalArgumentException - If rows is less than zero or if it is not possible to perform the jump.

next

public boolean next()
Positions the cursor at the next row.

Returns:
false if there is no next row.

setRow

public void setRow(int rowIndex)
            throws IllegalArgumentException
Position the cursor at a give row.

Parameters:
rowIndex - The row where the cursor has to be positioned.
Throws:
IllegalArgumentException - If the cursor cannot be positioned at the give row.

findColumn

public int findColumn(String name)
               throws IllegalArgumentException
Get the index within the ITuple of a given column.

Parameters:
name - The colum's name.
Returns:
The corresponding column's index. Note: in C++ -1 may be returned if the column does not exist.
Throws:
IllegalArgumentExcepion - If the column does not exist.
IllegalArgumentException

column

public IBaseTupleColumn column(String name)
                        throws IllegalArgumentException
Return a IBaseTupleColumn knowing its name.

Parameters:
name - The colum's name.
Returns:
The IBaseTupleColumn. In C++, return 0 if not found.
Throws:
IllegalArgumentException

column

public IBaseTupleColumn column(int column)
                        throws IllegalArgumentException
Return a IBaseTupleColumn knowing its index.

Parameters:
column - The column's index within the ITuple.
Returns:
The IBaseTupleColumn. In C++, return 0 if not found.
Throws:
IllegalArgumentException

getDouble

public double getDouble(int column)
                 throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the double stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The double.
Throws:
ClassCastException - If there is a mismatch of types.

getFloat

public float getFloat(int column)
               throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the float stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The float.
Throws:
ClassCastException - If there is a mismatch of types.

getInt

public int getInt(int column)
           throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the integer stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The integer.
Throws:
ClassCastException - If there is a mismatch of types.

getShort

public short getShort(int column)
               throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the short stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The short.
Throws:
ClassCastException - If there is a mismatch of types.

getLong

public long getLong(int column)
             throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the long stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The long.
Throws:
ClassCastException - If there is a mismatch of types.

getChar

public char getChar(int column)
             throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the character stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The character.
Throws:
ClassCastException - If there is a mismatch of types.

getByte

public byte getByte(int column)
             throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the byte stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The byte.
Throws:
ClassCastException - If there is a mismatch of types.

getBoolean

public boolean getBoolean(int column)
                   throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the boolean stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The boolean.
Throws:
ClassCastException - If there is a mismatch of types.

getString

public String getString(int column)
                 throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the string stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The string.
Throws:
ClassCastException - If there is a mismatch of types.

getObject

public Object getObject(int column)
                 throws ClassCastException
Deprecated. Use the ITupleColumn#value() method.

Get the object stored in a given column at the current cursor's position.

Parameters:
column - The column's index within the ITuple.
Returns:
The object.
Throws:
ClassCastException - If there is a mismatch of types.

getTuple

public ITuple getTuple(int column)
Deprecated. Please use method ITuple#findTuple(int).

Return method for tuple variables of type ITuple for a given column. This method can be used in order to fill a tuple variable in the master tuple.

Parameters:
column - The column's index.
Returns:
The ITuple representing the structure of this column.

findTuple

public ITuple findTuple(int column)
Return method for tuple variables of type ITuple for a given column. This method can be used in order to fill a tuple variable in the master tuple.

Parameters:
column - The column's index.
Returns:
The ITuple representing the structure of this column.

columns

public int columns()
Get the number of columns in the ITuple

Returns:
The number of columns.

columnName

public String columnName(int column)
                  throws IllegalArgumentException
Get the name of a column from its index.

Parameters:
column - The column's index.
Returns:
The column's name.
Throws:
IllegalArgumentException - For a wrong column's index.

columnNames

public String[] columnNames()
Get the names of all the columns.

Returns:
The column names.

columnType

public Class columnType(int column)
                 throws IllegalArgumentException
Get the type of a give column.

Parameters:
column - The column's index.
Returns:
The column's Class.
Throws:
IllegalArgumentException - For a wrong column's index.

columnDefaultValue

public Object columnDefaultValue(int column)
                          throws IllegalArgumentException
Get the column default. For primitive types (int, double, ...) their respective class is returned (Int, Double, ...)

Parameters:
column - The column's index.
Returns:
The column's default.
Throws:
IllegalArgumentException - For a wrong column's index.

columnTypes

public Class[] columnTypes()
Get the types of all the columns.

Returns:
The column Classes.

columnMin

public double columnMin(int column)
                 throws IllegalArgumentException
Get the minimum value of a given column (if it can be converted to a double).

Parameters:
column - The column's index.
Returns:
The column's minimum value. In Java Double.NaN might be returned.
Throws:
IllegalArgumentException - For a wrong column's index.

columnMax

public double columnMax(int column)
                 throws IllegalArgumentException
Get the maximum value of a given column (if it can be converted to a double).

Parameters:
column - The column's index.
Returns:
The column's maximum value. In Java Double.NaN might be returned.
Throws:
IllegalArgumentException - For a wrong column's index.

columnMean

public double columnMean(int column)
                  throws IllegalArgumentException
Get the mean value of a given column (if it can be converted to a double).

Parameters:
column - The column's index.
Returns:
The column's mean value. In Java Double.NaN might be returned.
Throws:
IllegalArgumentException - For a wrong column's index.

columnRms

public double columnRms(int column)
                 throws IllegalArgumentException
Get the RMS of a given column (if it can be converted to a double).

Parameters:
column - The column's index.
Returns:
The column's RMS. In Java Double.NaN might be returned.
Throws:
IllegalArgumentException - For a wrong column's index.

evaluateMin

public double evaluateMin(IEvaluator evaluator)
                   throws IllegalArgumentException
Get the minimum of an evaulation. Usefull to guess histogram booking.

Parameters:
evaluator - The evaluator used to compute the value to take min.
Throws:
IllegalArgumentException - If something goes wrong.

evaluateMin

public double evaluateMin(IEvaluator evaluator,
                          IFilter filter)
                   throws IllegalArgumentException
Get the minimum of an evaulation. Usefull to guess histogram booking.

Parameters:
evaluator - The evaluator used to compute the value to take min.
filter - The filter object used to accept or not the current row.
Throws:
IllegalArgumentException - If something goes wrong.

evaluateMax

public double evaluateMax(IEvaluator evaluator)
                   throws IllegalArgumentException
Get the maximum of an evaulation. Usefull to guess histogram booking.

Parameters:
evaluator - The evaluator used to compute the value to take max.
Throws:
IllegalArgumentException - If something goes wrong.

evaluateMax

public double evaluateMax(IEvaluator evaluator,
                          IFilter filter)
                   throws IllegalArgumentException
Get the maximum of an evaulation. Usefull to guess histogram booking.

Parameters:
evaluator - The evaluator used to compute the value to take max.
filter - The filter object used to accept or not the current row.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluatorX)
             throws IllegalArgumentException
Fill an IHistogram1D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluatorX,
                    IFilter filter)
             throws IllegalArgumentException
Fill an IHistogram1D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IHistogram1D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluatorX,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IHistogram1D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY)
             throws IllegalArgumentException
Fill an IHistogram2D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter)
             throws IllegalArgumentException
Fill an IHistogram2D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IHistogram2D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IHistogram2D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ)
             throws IllegalArgumentException
Fill an IHistogram3D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter)
             throws IllegalArgumentException
Fill an IHistogram3D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IHistogram3D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IHistogram3D from the tuple.

Parameters:
histogram - The histogram to fill.
evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluatorX)
             throws IllegalArgumentException
Fill an ICloud1D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluatorX,
                    IFilter filter)
             throws IllegalArgumentException
Fill an ICloud1D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an ICloud1D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluatorX,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an ICloud1D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY)
             throws IllegalArgumentException
Fill an ICloud2D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter)
             throws IllegalArgumentException
Fill an ICloud2D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an ICloud2D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an ICloud2D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ)
             throws IllegalArgumentException
Fill an ICloud3D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter)
             throws IllegalArgumentException
Fill an ICloud3D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an ICloud3D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an ICloud3D from the tuple.

Parameters:
cloud - The cloud to fill.
evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY)
             throws IllegalArgumentException
Fill an IProfile1D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter)
             throws IllegalArgumentException
Fill an IProfile1D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IProfile1D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IProfile1D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ)
             throws IllegalArgumentException
Fill an IProfile2D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter)
             throws IllegalArgumentException
Fill an IProfile2D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IProfile2D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter,
                    IEvaluator weight)
             throws IllegalArgumentException
Fill an IProfile2D from the tuple.

Parameters:
profile - The profile to fill.
evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.
evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.
evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.
filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.
weight - The evaluator which determines the weight which is used during the filling.
Throws:
IllegalArgumentException - If something goes wrong.

AIDA API
Version 3.3

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