Package com.xinapse.apps.active

Interface ROICalculation

All Known Implementing Classes:

SelectableROICalculation

public interface ROICalculation

An interface implemented by classes that can perform analysis on propagated ROIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ROICalculation.SpecifierPanel	A JPanel that can be used to specify ROI calculation parameters.

Method Summary

Modifier and Type	Method	Description
void	doCalc(com.xinapse.apps.active.ROIPropagateFrame parentFrame, ROI[][][] rois, ReadableImage[] inputImages, int nCols, int nRows, float pixelXSize, float pixelYSize)	Perform the calculation on the image/ROIs.
String	getCalculationDescription()	Returns a String describing this ROI calculation.
String	getCalculationName()	Returns the name of the calculation.

Method Details

getCalculationName

String getCalculationName()

Returns the name of the calculation.

Returns:

the name of the ROI calculation.

getCalculationDescription

String getCalculationDescription()

Returns a String describing this ROI calculation.

Returns:

a String describing this ROI calculation.

doCalc

void doCalc(com.xinapse.apps.active.ROIPropagateFrame parentFrame,
 ROI[][][] rois,
 ReadableImage[] inputImages,
 int nCols,
 int nRows,
 float pixelXSize,
 float pixelYSize)
     throws InvalidArgumentException

Perform the calculation on the image/ROIs.

Parameters:

parentFrame - if non-null, the ROIPropagateFrame from which the calculation was invoked.

rois - the array of (already propagated and sorted) ROIs. The first index of the array refers to the slice number; the second to the time point and the third is for the ROI at that time point.

inputImages - an array of input images. If there is more than one the this could be one for every slice location, or one for every time point.

nCols - the number of columns in the image.

nRows - the number of rows in the image.

pixelXSize - the width of an image pixel, in mm.

pixelYSize - the height of an image pixel, in mm.

Throws:

InvalidArgumentException - if any of the arguments is invalid.