ch.epfl.biop.imaris

Class StatsQuery

java.lang.Object

ch.epfl.biop.imaris.StatsQuery

public class StatsQuery
extends Object

This class is based on a Builder model to obtain selected statistics from an Imaris cStatisticValues object It allows for selecting specific item IDs, stat names, channels and timepoints. Statistics are returned in the form of a ResultsTable Multiple images are not directly supported, as we have never had a use for it. See the example uses in the source code of GetStatisticsDemo

Version:

0.1

Author:

Olivier Burri

Constructor Summary

Constructors

Constructor and Description
StatsQuery(Imaris.IDataItemPrx item) Constructor for getting selected statistics

Method Summary

Modifier and Type	Method and Description
StatsQuery	appendTo(ij.measure.ResultsTable results) Allows appending results from a previous run
ij.measure.ResultsTable	get() Heavy lifting function that performs the requested operation and returns a table It is rather naive.
StatsQuery	selectChannel(Integer channel) Allows to select the channel from which to get statistics from Careful.
StatsQuery	selectChannels(List<Integer> channels) Allows to set a list of channels from which to get statistics from Careful.
StatsQuery	selectId(Integer id) Allows for the selection of a specific ID.
StatsQuery	selectIds(List<Integer> ids) Allows to set a list of IDs from which to get statistics from
StatsQuery	selectStatistic(String name) Allows to select the name of the statistic to export.
StatsQuery	selectStatistics(List<String> names) Allows to set a list of IDs from which to get statistics from
StatsQuery	selectTime(Integer timepoint) Allows to select the timepoint of the statistics to export.
StatsQuery	selectTimes(List<Integer> timepoints) Allows to set a list of timepoints from which to get statistics from Careful.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatsQuery

public StatsQuery(Imaris.IDataItemPrx item)
           throws Imaris.Error

Constructor for getting selected statistics

Parameters:

item - the Imaris object from which we want statistics (Spots, Surfaces, ...)

Throws:

Imaris.Error - an Imaris Error Object

Method Detail

selectId

public StatsQuery selectId(Integer id)

Allows for the selection of a specific ID. Note that IDs are not necesarily continuous nor necesarily start at 0. These are the IDs as per Imaris's ID value in the GUI

Parameters:

id - the ID to recover statistics from

Returns:

selectIds

public StatsQuery selectIds(List<Integer> ids)

Allows to set a list of IDs from which to get statistics from

Parameters:

ids - the list of IDs to recover statistics from

Returns:

selectStatistic

public StatsQuery selectStatistic(String name)

Allows to select the name of the statistic to export. These are the same names as in the Imaris GUI **Minus** the channel or image (eg. do not enter "Intensity Sum" Ch1=1 Img=1, just "Intensity Sum") Use selectChannels(List) and selectChannel(Integer) to specify channels

Parameters:

name - the name of the statistic to recover as it appears in the Imaris GUI.

Returns:

selectStatistics

public StatsQuery selectStatistics(List<String> names)

Allows to set a list of IDs from which to get statistics from

Parameters:

names - the list of statistic names to recover as they appear in the Imaris GUI

Returns:

selectTime

public StatsQuery selectTime(Integer timepoint)

Allows to select the timepoint of the statistics to export. 0-based Careful. Imaris results are one-based for timepoints

Parameters:

timepoint - the timepoint

Returns:

selectTimes

public StatsQuery selectTimes(List<Integer> timepoints)

Allows to set a list of timepoints from which to get statistics from Careful. Imaris results are one-based for timepoints

Parameters:

timepoints -

Returns:

selectChannel

public StatsQuery selectChannel(Integer channel)

Allows to select the channel from which to get statistics from Careful. Imaris results are one-based for channels

Parameters:

channel -

Returns:

selectChannels

public StatsQuery selectChannels(List<Integer> channels)

Allows to set a list of channels from which to get statistics from Careful. Imaris results are one-based for channels

Parameters:

channels -

Returns:

appendTo

public StatsQuery appendTo(ij.measure.ResultsTable results)

Allows appending results from a previous run

Parameters:

results - a results table from ImageJ or from a finished StatsQuery

Returns:

get

public ij.measure.ResultsTable get()
                            throws Imaris.Error

Heavy lifting function that performs the requested operation and returns a table It is rather naive. It will go through each row of the raw Imaris statistics and see if that row matches the names, channels and timepoints that were requested. If they all match

Returns:

Throws:

Imaris.Error