ImportProcess (Bio-Formats API)

java.lang.Object
- loci.plugins.in.ImportProcess

All Implemented Interfaces:

loci.common.StatusReporter
```
public class ImportProcess
extends java.lang.Object
implements loci.common.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 and Description
`private IFormatReader`	`baseReader`
`private boolean`	`cancel` Whether the process has been canceled.
`private ChannelFiller`	`channelFiller`
`private ChannelSeparator`	`channelSeparator`
`private DimensionSwapper`	`dimensionSwapper`
`private FileStitcher`	`fileStitcher`
`protected loci.common.Location`	`idLoc`
`protected java.lang.String`	`idName`
`private ImageReader`	`imageReader`
`private java.util.List<loci.common.StatusListener>`	`listeners`
`protected IMetadata`	`meta`
`private ImporterMetadata`	`metadata`
`private MinMaxCalculator`	`minMaxCalculator`
`private java.lang.String`	`omeXML`
`private ImporterOptions`	`options` Associated importer options.
`private ImageProcessorReader`	`reader`
`private java.lang.String[]`	`seriesLabels` A descriptive label for each series.
`private ImportStep`	`step` Current step in the import preparation process.
`private TileStitcher`	`tileStitcher`
`private VirtualReader`	`virtualReader`

Constructor Summary

Constructors
Constructor and Description

ImportProcess()

ImportProcess(ImporterOptions options)

Constructors
Constructor and Description
`ImportProcess()`
`ImportProcess(ImporterOptions options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStatusListener(loci.common.StatusListener l)`
`private void`	`assertStep(ImportStep importStep)`
`void`	`cancel()` Cancels the import process.
`private void`	`computeNameAndLocation()` Initializes the idName and idLoc derived values.
`private void`	`computeSeriesLabels(IFormatReader r)`
`private void`	`createBaseReader()` Initializes an `IFormatReader` according to the current configuration.
`boolean`	`execute()` Performs the import preparation process, notifying status listeners at each step.
`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`.
`ChannelFiller`	`getChannelFiller()` Valid only after `ImportStep.STACK`.
`ChannelSeparator`	`getChannelSeparator()` Valid only after `ImportStep.STACK`.
`loci.common.Region`	`getCropRegion(int s)` Valid only after `ImportStep.STACK`.
`int`	`getCStep(int s)`
`java.lang.String`	`getCurrentFile()` Valid only after `ImportStep.STACK`.
`DimensionSwapper`	`getDimensionSwapper()` Valid only after `ImportStep.STACK`.
`FileStitcher`	`getFileStitcher()` Valid only after `ImportStep.STACK`.
`loci.common.Location`	`getIdLocation()` Valid only after `ImportStep.READER`.
`java.lang.String`	`getIdName()` Valid only after `ImportStep.READER`.
`ImageReader`	`getImageReader()` Valid only after `ImportStep.READER`.
`long`	`getMemoryUsage()` Gets a projection of required memory in bytes.
`MinMaxCalculator`	`getMinMaxCalculator()` Valid only after `ImportStep.STACK`.
`IMetadata`	`getOMEMetadata()` Valid only after `ImportStep.READER`.
`java.lang.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`.
`java.lang.String`	`getSeriesLabel(int s)` Valid only after `ImportStep.STACK`.
`java.lang.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)`
`private void`	`initializeColors()` Performed following ImportStep.COLORS notification.
`private void`	`initializeCrop()` Performed following ImportStep.CROP notification.
`private void`	`initializeDimOrder()` Performed following ImportStep.DIM_ORDER notification.
`private void`	`initializeFile()` Performed following ImportStep.FILE notification.
`private void`	`initializeMetadata()` Performed following ImportStep.METADATA notification.
`private void`	`initializeRange()` Performed following ImportStep.RANGE notification.
`private void`	`initializeReader()` Performed following ImportStep.READER notification.
`private void`	`initializeSeries()` Performed following ImportStep.SERIES notification.
`private void`	`initializeStack()` Performed following ImportStep.STACK notification.
`boolean`	`isWindowless()`
`void`	`notifyListeners(loci.common.StatusEvent e)`
`void`	`removeStatusListener(loci.common.StatusListener l)`
`private void`	`saveDefaults()` Performed following ImportStep.FILE notification.
`private void`	`setId()` HACK: This method mainly exists to prompt the user for a missing LuraWave license code, in the case of LWF-compressed Flex.
`void`	`setSeriesList(java.lang.String seriesList)`
`private void`	`step(ImportStep step)`
`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 Detail

listeners

private java.util.List<loci.common.StatusListener> listeners

options
```
private ImporterOptions options
```
Associated importer options.

step
```
private ImportStep step
```
Current step in the import preparation process.

baseReader
```
private IFormatReader baseReader
```

imageReader
```
private ImageReader imageReader
```

fileStitcher
```
private FileStitcher fileStitcher
```

channelFiller
```
private ChannelFiller channelFiller
```

channelSeparator

private ChannelSeparator channelSeparator

dimensionSwapper

private DimensionSwapper dimensionSwapper

minMaxCalculator

private MinMaxCalculator minMaxCalculator

tileStitcher
```
private TileStitcher tileStitcher
```

virtualReader
```
private VirtualReader virtualReader
```

reader
```
private ImageProcessorReader reader
```

cancel
```
private boolean cancel
```
Whether the process has been canceled.

idName
```
protected java.lang.String idName
```

idLoc
```
protected loci.common.Location idLoc
```

meta
```
protected IMetadata meta
```

omeXML
```
private java.lang.String omeXML
```

metadata
```
private ImporterMetadata metadata
```

seriesLabels
```
private java.lang.String[] seriesLabels
```
A descriptive label for each series.

Constructor Detail

ImportProcess

public ImportProcess()
              throws java.io.IOException

Throws:: java.io.IOException

ImportProcess

public ImportProcess(ImporterOptions options)

Method Detail
- execute
```
public boolean execute()
                throws FormatException,
                       java.io.IOException
```
  Performs the import preparation process, notifying status listeners at each step.
  
  Returns:
  
  true if the preparation process completed successfully.
  
  Throws:
  
  FormatException
  
  java.io.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(java.lang.String seriesList)
```
- getBaseReader
```
public IFormatReader getBaseReader()
```
  Valid only after ImportStep.READER.
- getImageReader
```
public ImageReader getImageReader()
```
  Valid only after ImportStep.READER.
- getIdName
```
public java.lang.String getIdName()
```
  Valid only after ImportStep.READER.
- getIdLocation
```
public loci.common.Location getIdLocation()
```
  Valid only after ImportStep.READER.
- getOMEMetadata
```
public IMetadata getOMEMetadata()
```
  Valid only after ImportStep.READER.
- getOMEXML
```
public java.lang.String getOMEXML()
```
  Valid only after ImportStep.READER.
- getFileStitcher
```
public FileStitcher getFileStitcher()
```
  Valid only after ImportStep.STACK.
- getChannelFiller
```
public ChannelFiller getChannelFiller()
```
  Valid only after ImportStep.STACK.
- getChannelSeparator
```
public ChannelSeparator getChannelSeparator()
```
  Valid only after ImportStep.STACK.
- getDimensionSwapper
```
public DimensionSwapper getDimensionSwapper()
```
  Valid only after ImportStep.STACK.
- getMinMaxCalculator
```
public 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 java.lang.String getCurrentFile()
```
  Valid only after ImportStep.STACK.
- getSeriesCount
```
public int getSeriesCount()
```
  Valid only after ImportStep.STACK.
- getSeriesLabel
```
public java.lang.String getSeriesLabel(int s)
```
  Valid only after ImportStep.STACK.
- getStackOrder
```
public java.lang.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 loci.common.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(loci.common.StatusListener l)
```
  Specified by:
  
  addStatusListener in interface loci.common.StatusReporter
- removeStatusListener
```
public void removeStatusListener(loci.common.StatusListener l)
```
  Specified by:
  
  removeStatusListener in interface loci.common.StatusReporter
- notifyListeners
```
public void notifyListeners(loci.common.StatusEvent e)
```
  Specified by:
  
  notifyListeners in interface loci.common.StatusReporter
- initializeReader
```
private void initializeReader()
                       throws FormatException,
                              java.io.IOException
```
  Performed following ImportStep.READER notification.
  
  Throws:
  
  FormatException
  
  java.io.IOException
- initializeFile
```
private void initializeFile()
                     throws FormatException,
                            java.io.IOException
```
  Performed following ImportStep.FILE notification.
  
  Throws:
  
  FormatException
  
  java.io.IOException
- initializeStack
```
private void initializeStack()
                      throws FormatException,
                             java.io.IOException
```
  Performed following ImportStep.STACK notification.
  
  Throws:
  
  FormatException
  
  java.io.IOException
- initializeSeries
```
private void initializeSeries()
```
  Performed following ImportStep.SERIES notification.
- initializeDimOrder
```
private void initializeDimOrder()
```
  Performed following ImportStep.DIM_ORDER notification.
- initializeRange
```
private void initializeRange()
```
  Performed following ImportStep.RANGE notification.
- initializeCrop
```
private void initializeCrop()
```
  Performed following ImportStep.CROP notification.
- initializeColors
```
private void initializeColors()
```
  Performed following ImportStep.COLORS notification.
- initializeMetadata
```
private void initializeMetadata()
```
  Performed following ImportStep.METADATA notification.
- computeNameAndLocation
```
private void computeNameAndLocation()
```
  Initializes the idName and idLoc derived values.
- createBaseReader
```
private void createBaseReader()
                       throws FormatException,
                              java.io.IOException
```
  Initializes an IFormatReader according to the current configuration.
  
  Throws:
  
  FormatException
  
  java.io.IOException
- saveDefaults
```
private void saveDefaults()
```
  Performed following ImportStep.FILE notification.
- setId
```
private void setId()
            throws FormatException,
                   java.io.IOException
```
  HACK: This method mainly exists to prompt the user for a missing LuraWave license code, in the case of LWF-compressed Flex.
  
  Throws:
  
  FormatException
  
  java.io.IOException
  
  See Also:
  
  ImagePlusReader.readProcessors(ImportProcess, int, Region, boolean)
- computeSeriesLabels
```
private void computeSeriesLabels(IFormatReader r)
```
- step
```
private void step(ImportStep step)
```
- assertStep
```
private void assertStep(ImportStep importStep)
```

Class ImportProcess

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

listeners

options

step

baseReader

imageReader

fileStitcher

channelFiller

channelSeparator

dimensionSwapper

minMaxCalculator

tileStitcher

virtualReader

reader

cancel

idName

idLoc

meta

omeXML

metadata

seriesLabels

Constructor Detail

ImportProcess

ImportProcess

Method Detail

execute

cancel

wasCanceled

getOptions

isWindowless

setSeriesList

getBaseReader

getImageReader

getIdName

getIdLocation

getOMEMetadata

getOMEXML

getFileStitcher

getChannelFiller

getChannelSeparator

getDimensionSwapper

getMinMaxCalculator

getVirtualReader

getReader

getCurrentFile

getSeriesCount

getSeriesLabel

getStackOrder

getCBegin

getCEnd

getCStep

getZBegin

getZEnd

getZStep

getTBegin

getTEnd

getTStep

getCropRegion

getCCount

getZCount

getTCount

getMemoryUsage

getOriginalMetadata

addStatusListener

removeStatusListener

notifyListeners

initializeReader

initializeFile

initializeStack

initializeSeries

initializeDimOrder

initializeRange

initializeCrop

initializeColors

initializeMetadata