Package com.xinapse.apps.cardiac

Class SelectableCardiacAnalysis

java.lang.Object

com.xinapse.apps.cardiac.SelectableCardiacAnalysis

All Implemented Interfaces:

CardiacAnalysis

public abstract class SelectableCardiacAnalysis
extends Object
implements CardiacAnalysis

An interface implemented by classes that can perform cardiac analysis.

Nested Class Summary

Nested classes/interfaces inherited from interface com.xinapse.apps.cardiac.CardiacAnalysis

CardiacAnalysis.SpecifierPanel

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	contiguousTimes	True if time points are contiguous in the input image(s).
protected final Integer	nTimePoints	The number of time points in the input image(s).
protected final boolean	pdfReport	True if a PDF report has been requested (command-line program only).
protected final boolean	verbose	True if verbose reporting is turned on.

Fields inherited from interface com.xinapse.apps.cardiac.CardiacAnalysis

NAME

Constructor Summary

Constructors

Constructor	Description
SelectableCardiacAnalysis()	Creates a new SelectableCardiacAnalysis.
SelectableCardiacAnalysis(boolean contiguousTimes, Integer nTimePoints, boolean pdfReport, boolean verbose)	Creates a new SelectableCardiacAnalysis.

Method Summary

Modifier and Type	Method	Description
void	addInfo(List<String> info)	Add common information for inclusion in a Report.
static CardiacAnalysis	getInstance()	Returns an instance of this CardiacAnalysis.
abstract CardiacAnalysis.SpecifierPanel	getSpecifierPanel(com.xinapse.apps.cardiac.CardiacFrame parentFrame, String preferencesNodeName)	Returns a CardiacAnalysis.SpecifierPanel that can be used to select and specify a SelectableCardiacAnalysis.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xinapse.apps.cardiac.CardiacAnalysis

doAnalysis, getAnalysisDescription, getAnalysisName, reportAnalysis

Field Details

contiguousTimes

protected final boolean contiguousTimes

True if time points are contiguous in the input image(s).

nTimePoints

protected final Integer nTimePoints

The number of time points in the input image(s).

pdfReport

protected final boolean pdfReport

True if a PDF report has been requested (command-line program only).

verbose

protected final boolean verbose

True if verbose reporting is turned on.

Constructor Details

SelectableCardiacAnalysis

public SelectableCardiacAnalysis()

Creates a new SelectableCardiacAnalysis.

SelectableCardiacAnalysis

public SelectableCardiacAnalysis(boolean contiguousTimes,
 Integer nTimePoints,
 boolean pdfReport,
 boolean verbose)

Creates a new SelectableCardiacAnalysis.

Parameters:

contiguousTimes - if time points are contiguous in the input image(s).

nTimePoints - the number of time points in the input image(s).

pdfReport - true if a PDF report has been requested.

verbose - whether verbose reporting is turned on.

Method Details

getInstance

public static CardiacAnalysis getInstance()

Returns an instance of this CardiacAnalysis.

Must be overridden.

Returns:

an instance of the CardiacAnalysis.

getSpecifierPanel

public abstract CardiacAnalysis.SpecifierPanel getSpecifierPanel(com.xinapse.apps.cardiac.CardiacFrame parentFrame,
 String preferencesNodeName)

Returns a CardiacAnalysis.SpecifierPanel that can be used to select and specify a SelectableCardiacAnalysis.

Parameters:

parentFrame - the parent frame in which the panel will be embedded.

preferencesNodeName - the Preferences node name used if the panel has its initial settings set from user preferences, or its settings are save to user Preferences.

Returns:

a CardiacAnalysis.SpecifierPanel that can be used to select and specify a SelectableCardiacAnalysis.

addInfo

public void addInfo(List<String> info)

Add common information for inclusion in a Report.

Parameters:

info - the List of information to which to add the common information,