ij.measure
Class ResultsTable

java.lang.Object
  extended by ij.measure.ResultsTable

public class ResultsTable
extends java.lang.Object

This is a table for storing measurement results as columns of real numbers.


Field Summary
static int AREA
           
static int COLUMN_IN_USE
           
static int COLUMN_NOT_FOUND
           
static int MAX
           
static int MAX_COLUMNS
           
static int MEAN
           
static int MIN
           
static int MODE
           
static int PERIMETER
           
static int ROI_HEIGHT
           
static int ROI_WIDTH
           
static int ROI_X
           
static int ROI_Y
           
static int STD_DEV
           
static int TABLE_FULL
           
static int X_CENTER_OF_MASS
           
static int X_CENTROID
           
static int Y_CENTER_OF_MASS
           
static int Y_CENTROID
           
 
Constructor Summary
ResultsTable()
          Constructs an empty ResultsTable with the counter=0 and no columns.
 
Method Summary
 void addLabel(java.lang.String heading, java.lang.String label)
          Adds a label to the beginning of the current row.
 void addValue(int column, double value)
          Adds a value to the end of the given column.
 void addValue(java.lang.String column, double value)
          Adds a value to the end of the given column.
 void disableRowLabels()
          Set the row label column to null.
 float[] getColumn(int column)
          Returns a copy of the given column as a float array.
 java.lang.String getColumnHeadings()
          Returns a tab-delimited string containing the column headings.
 int getColumnIndex(java.lang.String heading)
          Returns the index of the first column with the given heading.
 int getCounter()
          Returns the current value of the measurement counter.
 int getFreeColumn(java.lang.String heading)
          Sets the heading of the the first available column and returns that column's index.
 java.lang.String getRowAsString(int row)
          Returns a tab-delimited string representing the given row, where 0<=row<=counter-1.
 float getValue(int column, int row)
          Returns the value of the given column and row, where 0<=column
 void incrementCounter()
          Increments the measurement counter by one.
 void reset()
          Clears all the columns and sets the counter to zero.
 void setHeading(int column, java.lang.String heading)
          Changes the heading of the given column.
 void setPrecision(int precision)
          Sets the number of digits to the right of decimal point.
 void setValue(int column, int row, double value)
          Sets the value of the given column and row, where where 0<=column
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_COLUMNS

public static final int MAX_COLUMNS
See Also:
Constant Field Values

COLUMN_NOT_FOUND

public static final int COLUMN_NOT_FOUND
See Also:
Constant Field Values

COLUMN_IN_USE

public static final int COLUMN_IN_USE
See Also:
Constant Field Values

TABLE_FULL

public static final int TABLE_FULL
See Also:
Constant Field Values

AREA

public static final int AREA
See Also:
Constant Field Values

MEAN

public static final int MEAN
See Also:
Constant Field Values

STD_DEV

public static final int STD_DEV
See Also:
Constant Field Values

MODE

public static final int MODE
See Also:
Constant Field Values

MIN

public static final int MIN
See Also:
Constant Field Values

MAX

public static final int MAX
See Also:
Constant Field Values

X_CENTROID

public static final int X_CENTROID
See Also:
Constant Field Values

Y_CENTROID

public static final int Y_CENTROID
See Also:
Constant Field Values

X_CENTER_OF_MASS

public static final int X_CENTER_OF_MASS
See Also:
Constant Field Values

Y_CENTER_OF_MASS

public static final int Y_CENTER_OF_MASS
See Also:
Constant Field Values

PERIMETER

public static final int PERIMETER
See Also:
Constant Field Values

ROI_X

public static final int ROI_X
See Also:
Constant Field Values

ROI_Y

public static final int ROI_Y
See Also:
Constant Field Values

ROI_WIDTH

public static final int ROI_WIDTH
See Also:
Constant Field Values

ROI_HEIGHT

public static final int ROI_HEIGHT
See Also:
Constant Field Values
Constructor Detail

ResultsTable

public ResultsTable()
Constructs an empty ResultsTable with the counter=0 and no columns.

Method Detail

incrementCounter

public void incrementCounter()
Increments the measurement counter by one.


getCounter

public int getCounter()
Returns the current value of the measurement counter.


addValue

public void addValue(int column,
                     double value)
Adds a value to the end of the given column. Counter must be >0.


addValue

public void addValue(java.lang.String column,
                     double value)
Adds a value to the end of the given column. If the column does not exist, it is created. Counter must be >0.


addLabel

public void addLabel(java.lang.String heading,
                     java.lang.String label)
Adds a label to the beginning of the current row. Counter must be >0.


disableRowLabels

public void disableRowLabels()
Set the row label column to null.


getColumn

public float[] getColumn(int column)
Returns a copy of the given column as a float array. Returns null if the column is empty.


getColumnIndex

public int getColumnIndex(java.lang.String heading)
Returns the index of the first column with the given heading. heading. If not found, returns COLUMN_NOT_FOUND.


getFreeColumn

public int getFreeColumn(java.lang.String heading)
Sets the heading of the the first available column and returns that column's index. Returns COLUMN_IN_USE if this is a duplicate heading. Returns TABLE_FULL if there are no free columns.


getValue

public float getValue(int column,
                      int row)
Returns the value of the given column and row, where 0<=column

setValue

public void setValue(int column,
                     int row,
                     double value)
Sets the value of the given column and row, where where 0<=column

getColumnHeadings

public java.lang.String getColumnHeadings()
Returns a tab-delimited string containing the column headings.


getRowAsString

public java.lang.String getRowAsString(int row)
Returns a tab-delimited string representing the given row, where 0<=row<=counter-1.


setHeading

public void setHeading(int column,
                       java.lang.String heading)
Changes the heading of the given column.


setPrecision

public void setPrecision(int precision)
Sets the number of digits to the right of decimal point.


reset

public void reset()
Clears all the columns and sets the counter to zero.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object