Module ij
Package ij.measure

Class ResultsTable

java.lang.Object
ij.measure.ResultsTable
All Implemented Interfaces:
java.lang.Cloneable

public class ResultsTable
extends java.lang.Object
implements java.lang.Cloneable
This is a table for storing measurement results and strings as columns of values. Call the static ResultsTable.getResultsTable() method to get a reference to the ResultsTable used by the Analyze/Measure command.
See Also:
Analyzer.getResultsTable()
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int ANGLE  
    static int AREA  
    static int AREA_FRACTION  
    static int ASPECT_RATIO  
    static short AUTO_FORMAT  
    static int CHANNEL  
    static int CIRCULARITY  
    static int COLUMN_IN_USE  
    static int COLUMN_NOT_FOUND  
    static int FERET  
    static int FERET_ANGLE  
    static int FERET_X  
    static int FERET_Y  
    static int FRAME  
    static int INTEGRATED_DENSITY  
    static int KURTOSIS  
    static int LAST_HEADING  
    static int MAJOR  
    static int MAX  
    static int MAX_COLUMNS
    Obsolete; use getLastColumn().
    static int MAX_THRESHOLD  
    static int MEAN  
    static int MEDIAN  
    static int MIN  
    static int MIN_FERET  
    static int MIN_THRESHOLD  
    static int MINOR  
    static int MODE  
    static int PERIMETER  
    static int RAW_INTEGRATED_DENSITY  
    static int ROI_HEIGHT  
    static int ROI_WIDTH  
    static int ROI_X  
    static int ROI_Y  
    static int ROUNDNESS  
    static int SKEWNESS  
    static int SLICE  
    static int SOLIDITY  
    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

    Constructors 
    Constructor Description
    ResultsTable()
    Constructs an empty ResultsTable with the counter=0, no columns and the precision set to 3 or the "Decimal places" value in Analyze/Set Measurements if that value is higher than 3.
    ResultsTable​(java.lang.Integer nRows)
    Constructs a ResultsTable with 'nRows' rows.
  • Method Summary

    Modifier and Type Method Description
    void addColumns()
    Obsolete; the addValue() method automatically adds columns as needed.
    void addLabel​(java.lang.String label)
    Adds a label to the beginning of the current row.
    void addLabel​(java.lang.String columnHeading, java.lang.String label)
    Deprecated.
    Replaced by setValue(String,int,String)
    void addResults()
    Adds the last row in this table to the Results window without updating it.
    void addRow()
    Adds a row to the table.
    void addValue​(int column, double value)
    Adds a numeric value to the specified column, on the last table row.
    void addValue​(java.lang.String column, double value)
    Adds a numeric value to the specified column, on the last table row.
    void addValue​(java.lang.String column, java.lang.String value)
    Adds a string value to the specified column, on the last table row.
    boolean applyMacro​(java.lang.String macro)
    Applies a macro to each row of the table; the columns are assigned variable names as given by getHeadingsAsVaribleNames().
    java.lang.Object clone()
    Duplicates this ResultsTable.
    boolean columnDeleted()  
    boolean columnExists​(int column)
    Returns true if the specified column exists and is not empty.
    boolean columnExists​(java.lang.String column)
    Returns 'true' if the specified column exists and is not emptly.
    static ResultsTable createTableFromImage​(ImageProcessor ip)
    Creates a ResultsTable from an image or image selection.
    static java.lang.String d2s​(double n, int decimalPlaces)
    This is a version of IJ.d2s() that uses scientific notation for small numbes that would otherwise display as zero.
    void deleteColumn​(java.lang.String column)
    Deletes the specified column.
    void deleteRow​(int rowIndex)
    Deletes the specified row.
    void deleteRows​(int index1, int index2)
    Deletes the specified rows.
    void disableRowLabels()
    Set the row label column to null if the column label is "Label".
    static ResultsTable getActiveTable()
    Returns the active (front most) displayed ResultsTable.
    float[] getColumn​(int column)
    Returns a copy of the given column as a float array, or null if the column is empty.
    double[] getColumn​(java.lang.String column)
    Returns a copy of the given column as a double array, or null if the column is not found.
    double[] getColumnAsDoubles​(int column)
    Returns a copy of the given column as a double array, or null if the column is empty.
    java.lang.String[] getColumnAsStrings​(java.lang.String column)
    Returns a copy of the given column as a String array, or null if the column is not found.
    Variable[] getColumnAsVariables​(java.lang.String column)
    Implements the Table.getColumn() macro function.
    java.lang.String getColumnHeading​(int column)
    Returns the heading of the specified column or null if the column is empty.
    java.lang.String getColumnHeadings()
    Returns a tab or comma 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.
    static java.lang.String getDefaultHeading​(int index)  
    static java.lang.String[] getDefaultHeadings()
    Returns the default headings ("Area","Mean","StdDev", etc.).
    int getFreeColumn​(java.lang.String heading)
    Sets the heading of the the first available column and returns that column's index.
    java.lang.String[] getHeadings()
    Returns the column headings as an array of Strings.
    java.lang.String[] getHeadingsAsVariableNames()
    Returns the column headings; headings not suitable as variable names are converted to valid variable names by replacing non-fitting characters with underscores and adding underscores.
    java.lang.String getLabel​(int row)
    Returns the label of the specified row.
    int getLastColumn()
    Returns the index of the last used column, or -1 if no columns are used.
    static ResultsTable getResultsTable()
    Returns the ResultsTable used by the Measure command.
    static ResultsTable getResultsTable​(java.lang.String title)
    Returns the ResultsTable with the specified title, or null if it does not exist,
    static TextWindow getResultsWindow()
    Obsolete.
    java.lang.String getRowAsString​(int row)
    Returns a tab or comma delimited string representing the given row, where 0
    java.lang.String getStringValue​(int column, int row)
    Returns the string value of the given column and row, where column must be less than or equal the value returned by getLastColumn() and row must be greater than or equal zero and less than the value returned by size().
    java.lang.String getStringValue​(java.lang.String column, int row)
    Returns the string value of the given column and row, where row must be greater than or equal zero and less than the value returned by size().
    ImageProcessor getTableAsImage()
    Returns the contents of this ResultsTable as a FloatProcessor.
    java.lang.String getTitle()  
    float getValue​(int column, int row)
    Deprecated.
    replaced by getValueAsDouble
    double getValue​(java.lang.String column, int row)
    Returns the value of the specified column and row, where column is the column heading and row is a number greater than or equal zero and less than value returned by size().
    double getValueAsDouble​(int column, int row)
    Returns the value of the given column and row, where column must be less than or equal the value returned by getLastColumn() and row must be greater than or equal zero and less than the value returned by size().
    void incrementCounter()
    Adds a row to the table.
    static ResultsTable open​(java.lang.String path)
    Opens a tab or comma delimited text file and returns it as a ResultsTable.
    static ResultsTable open2​(java.lang.String path)
    Opens a tab or comma delimited text file and returns it as a ResultsTable, without requiring a try/catch statement.
    void renameColumn​(java.lang.String oldName, java.lang.String newName)
    Changes the name of a column.
    void reset()  
    boolean save​(java.lang.String path)
    Saves this ResultsTable as a tab or comma delimited text file.
    boolean saveAndRename​(java.lang.String path)  
    void saveAs​(java.lang.String path)  
    void saveColumnHeaders​(boolean save)  
    static boolean selectRow​(Roi roi)
    Selects the row in the "Results" table assocuiated with the specified Roi.
    void setColumn​(java.lang.String column, Variable[] array)
    Implements the Table.setColumn() macro function.
    void setDecimalPlaces​(int column, int digits)  
    void setDefaultHeadings()
    Sets the headings used by the Measure command ("Area", "Mean", etc.).
    void setHeading​(int column, java.lang.String heading)
    Deprecated.
    Replaced by addValue(String,double) and setValue(String,int,double)
    void setLabel​(java.lang.String label, int row)
    Adds a label to the beginning of the specified row, or updates an existing lable, where 0
    void setNaNEmptyCells​(boolean NaNEmptyCells)
    Set 'true' to initially fill data arrays with NaNs instead of zeros.
    void setPrecision​(int precision)
    Sets the decimal places (digits to the right of decimal point) that are used when this table is displayed.
    void setValue​(int column, int row, double value)
    Sets the value of the given column and row, where where 0<=column<=(lastRow+1 and 0<=row<=size().
    void setValue​(int column, int row, java.lang.String value)
    Sets the string value of the given column and row, where where 0<=column<=(lastRow+1 and 0<=row<=size().
    void setValue​(java.lang.String column, int row, double value)
    Sets the value of the given column and row, where where 0<=row<size().
    void setValue​(java.lang.String column, int row, java.lang.String value)
    Sets the string value of the given column and row, where where 0<=row<size().
    void show​(java.lang.String windowTitle)
    Displays the contents of this ResultsTable in a window with the specified title, or updates an existing results window.
    void showRowIndexes​(boolean showIndexes)  
    boolean showRowNumbers()  
    void showRowNumbers​(boolean showNumbers)  
    int size()
    Returns the size of this ResultsTable.
    void sort​(java.lang.String column)
    Sorts this table on the specified column, with string support.
    java.lang.String toString()  
    void update​(int measurements, ImagePlus imp, Roi roi)  
    void updateResults()
    Updates the Results window.

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • ResultsTable

      public ResultsTable()
      Constructs an empty ResultsTable with the counter=0, no columns and the precision set to 3 or the "Decimal places" value in Analyze/Set Measurements if that value is higher than 3.
    • ResultsTable

      public ResultsTable​(java.lang.Integer nRows)
      Constructs a ResultsTable with 'nRows' rows.
  • Method Details

    • getResultsTable

      public static ResultsTable getResultsTable()
      Returns the ResultsTable used by the Measure command. This table must be displayed in the "Results" window.
    • getResultsTable

      public static ResultsTable getResultsTable​(java.lang.String title)
      Returns the ResultsTable with the specified title, or null if it does not exist,
    • getActiveTable

      public static ResultsTable getActiveTable()
      Returns the active (front most) displayed ResultsTable.
    • getResultsWindow

      public static TextWindow getResultsWindow()
      Obsolete.
    • addRow

      public void addRow()
      Adds a row to the table.
    • incrementCounter

      public void incrementCounter()
      Adds a row to the table.
    • addColumns

      public void addColumns()
      Obsolete; the addValue() method automatically adds columns as needed.
      See Also:
      addValue(String, double)
    • getCounter

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

      public int size()
      Returns the size of this ResultsTable.
    • addValue

      public void addValue​(int column, double value)
      Adds a numeric value to the specified column, on the last table row. Use addRow() to add another row to the table.
      See Also:
      addRow(), addValue(String,double), addValue(String,String), size()
    • addValue

      public void addValue​(java.lang.String column, double value)
      Adds a numeric value to the specified column, on the last table row. If the column does not exist, it is created. Use addRow() to add another row to the table.

      JavaScript example:

       rt = new ResultsTable();
       for (n=0; n
      See Also:
      addRow(), addValue(String,String), size()
    • addValue

      public void addValue​(java.lang.String column, java.lang.String value)
      Adds a string value to the specified column, on the last table row. If the column does not exist, it is created. Use addRow() to add another row to the table.
      See Also:
      addRow(), addValue(String,double), size()
    • addLabel

      public void addLabel​(java.lang.String label)
      Adds a label to the beginning of the current row.
    • addLabel

      public void addLabel​(java.lang.String columnHeading, java.lang.String label)
      Deprecated.
      Replaced by setValue(String,int,String)
    • setLabel

      public void setLabel​(java.lang.String label, int row)
      Adds a label to the beginning of the specified row, or updates an existing lable, where 0show() to update the window displaying the table.
    • disableRowLabels

      public void disableRowLabels()
      Set the row label column to null if the column label is "Label".
    • getColumn

      public double[] getColumn​(java.lang.String column)
      Returns a copy of the given column as a double array, or null if the column is not found.
    • getColumnAsStrings

      public java.lang.String[] getColumnAsStrings​(java.lang.String column)
      Returns a copy of the given column as a String array, or null if the column is not found.
    • getColumn

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

      public double[] getColumnAsDoubles​(int column)
      Returns a copy of the given column as a double array, or null if the column is empty.
    • getTableAsImage

      public ImageProcessor getTableAsImage()
      Returns the contents of this ResultsTable as a FloatProcessor.
    • createTableFromImage

      public static ResultsTable createTableFromImage​(ImageProcessor ip)
      Creates a ResultsTable from an image or image selection.
    • columnExists

      public boolean columnExists​(int column)
      Returns true if the specified column exists and is not 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.
    • getValueAsDouble

      public double getValueAsDouble​(int column, int row)
      Returns the value of the given column and row, where column must be less than or equal the value returned by getLastColumn() and row must be greater than or equal zero and less than the value returned by size().
    • getValue

      public float getValue​(int column, int row)
      Deprecated.
      replaced by getValueAsDouble
    • getValue

      public double getValue​(java.lang.String column, int row)
      Returns the value of the specified column and row, where column is the column heading and row is a number greater than or equal zero and less than value returned by size(). Throws an IllegalArgumentException if this ResultsTable does not have a column with the specified heading.
    • columnExists

      public boolean columnExists​(java.lang.String column)
      Returns 'true' if the specified column exists and is not emptly.
    • getStringValue

      public java.lang.String getStringValue​(java.lang.String column, int row)
      Returns the string value of the given column and row, where row must be greater than or equal zero and less than the value returned by size().
    • getStringValue

      public java.lang.String getStringValue​(int column, int row)
      Returns the string value of the given column and row, where column must be less than or equal the value returned by getLastColumn() and row must be greater than or equal zero and less than the value returned by size().
    • getLabel

      public java.lang.String getLabel​(int row)
      Returns the label of the specified row. Returns null if the row does not have a label.
    • setValue

      public void setValue​(java.lang.String column, int row, double value)
      Sets the value of the given column and row, where where 0<=row<size(). If the specified column does not exist, it is created. When adding columns, show() must be called to update the window that displays the table.
    • setValue

      public void setValue​(int column, int row, double value)
      Sets the value of the given column and row, where where 0<=column<=(lastRow+1 and 0<=row<=size().
    • setValue

      public void setValue​(java.lang.String column, int row, java.lang.String value)
      Sets the string value of the given column and row, where where 0<=row<size(). If the specified column does not exist, it is created. When adding columns, show() must be called to update the window that displays the table.
    • setValue

      public void setValue​(int column, int row, java.lang.String value)
      Sets the string value of the given column and row, where where 0<=column<=(lastRow+1 and 0<=row<=size().
    • getColumnHeadings

      public java.lang.String getColumnHeadings()
      Returns a tab or comma delimited string containing the column headings.
    • getHeadings

      public java.lang.String[] getHeadings()
      Returns the column headings as an array of Strings.
    • getColumnHeading

      public java.lang.String getColumnHeading​(int column)
      Returns the heading of the specified column or null if the column is empty.
    • getRowAsString

      public java.lang.String getRowAsString​(int row)
      Returns a tab or comma delimited string representing the given row, where 0
    • getColumnAsVariables

      public Variable[] getColumnAsVariables​(java.lang.String column)
      Implements the Table.getColumn() macro function.
    • setColumn

      public void setColumn​(java.lang.String column, Variable[] array)
      Implements the Table.setColumn() macro function.
    • setHeading

      public void setHeading​(int column, java.lang.String heading)
      Deprecated.
      Replaced by addValue(String,double) and setValue(String,int,double)
    • setDefaultHeadings

      public void setDefaultHeadings()
      Sets the headings used by the Measure command ("Area", "Mean", etc.).
    • setPrecision

      public void setPrecision​(int precision)
      Sets the decimal places (digits to the right of decimal point) that are used when this table is displayed.
    • setDecimalPlaces

      public void setDecimalPlaces​(int column, int digits)
    • setNaNEmptyCells

      public void setNaNEmptyCells​(boolean NaNEmptyCells)
      Set 'true' to initially fill data arrays with NaNs instead of zeros.
    • showRowNumbers

      public void showRowNumbers​(boolean showNumbers)
    • showRowNumbers

      public boolean showRowNumbers()
    • showRowIndexes

      public void showRowIndexes​(boolean showIndexes)
    • saveColumnHeaders

      public void saveColumnHeaders​(boolean save)
    • d2s

      public static java.lang.String d2s​(double n, int decimalPlaces)
      This is a version of IJ.d2s() that uses scientific notation for small numbes that would otherwise display as zero.
    • deleteRow

      public void deleteRow​(int rowIndex)
      Deletes the specified row.
    • deleteRows

      public void deleteRows​(int index1, int index2)
      Deletes the specified rows.
    • deleteColumn

      public void deleteColumn​(java.lang.String column)
      Deletes the specified column.
    • renameColumn

      public void renameColumn​(java.lang.String oldName, java.lang.String newName)
      Changes the name of a column.
    • reset

      public void reset()
    • getLastColumn

      public int getLastColumn()
      Returns the index of the last used column, or -1 if no columns are used.
    • addResults

      public void addResults()
      Adds the last row in this table to the Results window without updating it.
    • updateResults

      public void updateResults()
      Updates the Results window.
    • show

      public void show​(java.lang.String windowTitle)
      Displays the contents of this ResultsTable in a window with the specified title, or updates an existing results window. Opens a new window if there is no open text window with this title. The title must be "Results" if this table was obtained using ResultsTable.getResultsTable() or Analyzer.getResultsTable .
    • update

      public void update​(int measurements, ImagePlus imp, Roi roi)
    • open2

      public static ResultsTable open2​(java.lang.String path)
      Opens a tab or comma delimited text file and returns it as a ResultsTable, without requiring a try/catch statement. Displays a file open dialog if 'path' is empty or null.
    • open

      public static ResultsTable open​(java.lang.String path) throws java.io.IOException
      Opens a tab or comma delimited text file and returns it as a ResultsTable. Displays a file open dialog if 'path' is empty or null.
      Throws:
      java.io.IOException
      See Also:
      open2(String)
    • save

      public boolean save​(java.lang.String path)
      Saves this ResultsTable as a tab or comma delimited text file. The table is saved as a CSV (comma-separated values) file if 'path' ends with ".csv". Displays a file save dialog if 'path' is empty or null. Does nothing if the table is empty. Displays an error message and returns 'false' if there is an error.
    • saveAndRename

      public boolean saveAndRename​(java.lang.String path)
    • saveAs

      public void saveAs​(java.lang.String path) throws java.io.IOException
      Throws:
      java.io.IOException
    • getDefaultHeadings

      public static java.lang.String[] getDefaultHeadings()
      Returns the default headings ("Area","Mean","StdDev", etc.).
    • getDefaultHeading

      public static java.lang.String getDefaultHeading​(int index)
    • clone

      public java.lang.Object clone()
      Duplicates this ResultsTable.
      Overrides:
      clone in class java.lang.Object
    • toString

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

      public boolean applyMacro​(java.lang.String macro)
      Applies a macro to each row of the table; the columns are assigned variable names as given by getHeadingsAsVaribleNames(). New variables starting with an uppercase letter create a new column with this name. The variable 'row' (the row index) is pre-defined. Except for the row label (if existing), currently only supports numeric values, no Strings.
      Returns:
      false in case of a macro error
    • getHeadingsAsVariableNames

      public java.lang.String[] getHeadingsAsVariableNames()
      Returns the column headings; headings not suitable as variable names are converted to valid variable names by replacing non-fitting characters with underscores and adding underscores. To make unique names, underscores+numbers are added as required.
    • getTitle

      public java.lang.String getTitle()
    • columnDeleted

      public boolean columnDeleted()
    • selectRow

      public static boolean selectRow​(Roi roi)
      Selects the row in the "Results" table assocuiated with the specified Roi. The row number is obtained from the roi name..
    • sort

      public void sort​(java.lang.String column)
      Sorts this table on the specified column, with string support. Author: 'mountain_man', 8 April 2019