Package loci.plugins.in

Class ImportProcess

java.lang.Object

loci.plugins.in.ImportProcess

All Implemented Interfaces:

StatusReporter

public class ImportProcess
extends Object
implements StatusReporter

Manages the import preparation process. After calling execute(), the process will be ready to feed to an ImagePlusReader to read in the actual ImagePlus objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected Location	idLoc
protected String	idName
protected loci.formats.meta.IMetadata	meta

Constructor Summary

Constructors

Constructor	Description
ImportProcess()
ImportProcess(ImporterOptions options)

Method Summary

Modifier and Type	Method	Description
void	addStatusListener(StatusListener l)
void	cancel()	Cancels the import process.
boolean	execute()	Performs the import preparation process, notifying status listeners at each step.
loci.formats.IFormatReader	getBaseReader()	Valid only after ImportStep.READER.
int	getCBegin(int s)
int	getCCount(int s)	Valid only after ImportStep.SERIES.
int	getCEnd(int s)	Valid only after ImportStep.STACK.
loci.formats.ChannelFiller	getChannelFiller()	Valid only after ImportStep.STACK.
loci.formats.ChannelSeparator	getChannelSeparator()	Valid only after ImportStep.STACK.
Region	getCropRegion(int s)	Valid only after ImportStep.STACK.
int	getCStep(int s)
String	getCurrentFile()	Valid only after ImportStep.STACK.
loci.formats.DimensionSwapper	getDimensionSwapper()	Valid only after ImportStep.STACK.
loci.formats.FileStitcher	getFileStitcher()	Valid only after ImportStep.STACK.
Location	getIdLocation()	Valid only after ImportStep.READER.
String	getIdName()	Valid only after ImportStep.READER.
loci.formats.ImageReader	getImageReader()	Valid only after ImportStep.READER.
long	getMemoryUsage()	Gets a projection of required memory in bytes.
loci.formats.MinMaxCalculator	getMinMaxCalculator()	Valid only after ImportStep.STACK.
loci.formats.meta.IMetadata	getOMEMetadata()	Valid only after ImportStep.READER.
String	getOMEXML()	Valid only after ImportStep.READER.
ImporterOptions	getOptions()
ImporterMetadata	getOriginalMetadata()	Valid only after ImportStep.METADATA.
ImageProcessorReader	getReader()	Valid only after ImportStep.STACK.
int	getSeriesCount()	Valid only after ImportStep.STACK.
String	getSeriesLabel(int s)	Valid only after ImportStep.STACK.
String	getStackOrder()	Valid only after ImportStep.STACK.
int	getTBegin(int s)
int	getTCount(int s)	Valid only after ImportStep.SERIES.
int	getTEnd(int s)	Valid only after ImportStep.STACK.
int	getTStep(int s)
VirtualReader	getVirtualReader()	Valid only after ImportStep.STACK.
int	getZBegin(int s)
int	getZCount(int s)	Valid only after ImportStep.SERIES.
int	getZEnd(int s)	Valid only after ImportStep.STACK.
int	getZStep(int s)
boolean	isWindowless()
void	notifyListeners(StatusEvent e)
void	removeStatusListener(StatusListener l)
void	setSeriesList(String seriesList)
boolean	wasCanceled()	Gets whether the import process was canceled.

Methods inherited from class java.lang.Object

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

Field Details

idName

protected String idName

idLoc

protected Location idLoc

meta

protected loci.formats.meta.IMetadata meta

Constructor Details

ImportProcess

public ImportProcess()
              throws IOException

Throws:

IOException

ImportProcess

public ImportProcess(ImporterOptions options)

Method Details

execute

public boolean execute()
                throws loci.formats.FormatException,
IOException

Performs the import preparation process, notifying status listeners at each step.

Returns:

true if the preparation process completed successfully.

Throws:

loci.formats.FormatException

IOException

cancel

public void cancel()

Cancels the import process.

wasCanceled

public boolean wasCanceled()

Gets whether the import process was canceled.

getOptions

public ImporterOptions getOptions()

isWindowless

public boolean isWindowless()

setSeriesList

public void setSeriesList(String seriesList)

getBaseReader

public loci.formats.IFormatReader getBaseReader()

Valid only after ImportStep.READER.

getImageReader

public loci.formats.ImageReader getImageReader()

Valid only after ImportStep.READER.

getIdName

public String getIdName()

Valid only after ImportStep.READER.

getIdLocation

public Location getIdLocation()

Valid only after ImportStep.READER.

getOMEMetadata

public loci.formats.meta.IMetadata getOMEMetadata()

Valid only after ImportStep.READER.

getOMEXML

public String getOMEXML()

Valid only after ImportStep.READER.

getFileStitcher

public loci.formats.FileStitcher getFileStitcher()

Valid only after ImportStep.STACK.

getChannelFiller

public loci.formats.ChannelFiller getChannelFiller()

Valid only after ImportStep.STACK.

getChannelSeparator

public loci.formats.ChannelSeparator getChannelSeparator()

Valid only after ImportStep.STACK.

getDimensionSwapper

public loci.formats.DimensionSwapper getDimensionSwapper()

Valid only after ImportStep.STACK.

getMinMaxCalculator

public loci.formats.MinMaxCalculator getMinMaxCalculator()

Valid only after ImportStep.STACK.

getVirtualReader

public VirtualReader getVirtualReader()

Valid only after ImportStep.STACK.

getReader

public ImageProcessorReader getReader()

Valid only after ImportStep.STACK.

getCurrentFile

public String getCurrentFile()

Valid only after ImportStep.STACK.

getSeriesCount

public int getSeriesCount()

Valid only after ImportStep.STACK.

getSeriesLabel

public String getSeriesLabel(int s)

Valid only after ImportStep.STACK.

getStackOrder

public String getStackOrder()

Valid only after ImportStep.STACK.

getCBegin

public int getCBegin(int s)

getCEnd

public int getCEnd(int s)

Valid only after ImportStep.STACK.

getCStep

public int getCStep(int s)

getZBegin

public int getZBegin(int s)

getZEnd

public int getZEnd(int s)

Valid only after ImportStep.STACK.

getZStep

public int getZStep(int s)

getTBegin

public int getTBegin(int s)

getTEnd

public int getTEnd(int s)

Valid only after ImportStep.STACK.

getTStep

public int getTStep(int s)

getCropRegion

public Region getCropRegion(int s)

Valid only after ImportStep.STACK.

getCCount

public int getCCount(int s)

Valid only after ImportStep.SERIES.

getZCount

public int getZCount(int s)

Valid only after ImportStep.SERIES.

getTCount

public int getTCount(int s)

Valid only after ImportStep.SERIES.

getMemoryUsage

public long getMemoryUsage()

Gets a projection of required memory in bytes. Valid only after ImportStep.SERIES.

getOriginalMetadata

public ImporterMetadata getOriginalMetadata()

Valid only after ImportStep.METADATA.

addStatusListener

public void addStatusListener(StatusListener l)

Specified by:

addStatusListener in interface StatusReporter

removeStatusListener

public void removeStatusListener(StatusListener l)

Specified by:

removeStatusListener in interface StatusReporter

notifyListeners

public void notifyListeners(StatusEvent e)

Specified by:

notifyListeners in interface StatusReporter