public class Loader extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Loader.FilePosition
Deprecated.
|
Constructor and Description |
---|
Loader() |
Modifier and Type | Method and Description |
---|---|
static boolean |
canDiscardImageFile(java.lang.String path)
Returns
true if the specified path describes a file type (from extension) which
is well known to
not be an image file. |
static void |
checkOpening(int resolution,
int sizeX,
int sizeY,
int sizeC,
int sizeZ,
int sizeT,
DataType dataType,
java.lang.String messageSuffix)
Check if we have enough resource to open the image defined by the given size information and
wanted resolution.
|
static void |
checkOpening(ome.xml.meta.OMEXMLMetadata meta,
int series,
int resolution,
int sizeZ,
int sizeT,
java.lang.String messageSuffix)
Check if we have enough resource to open the image defined by the given metadata information, series index and
wanted resolution.
|
static void |
checkOpening(ome.xml.meta.OMEXMLMetadata meta,
int series,
int resolution,
java.lang.String messageSuffix)
Check if we have enough resource to open the image defined by the given metadata information, series index and
wanted resolution.
|
static long |
checkOpeningPlane(int resolution,
int sizeX,
int sizeY,
java.lang.String messageSuffix)
Check if we can open the given image plane resolution (XY size < 2^31).
|
static java.util.List<java.lang.String> |
cleanNonImageFile(java.util.List<java.lang.String> paths)
Remove invalid image files from the list of files
|
static FileImporter |
getFileImporter(java.util.List<FileImporter> importers,
java.lang.String path,
boolean useFirstFound)
Returns the appropriate file importer for the specified file.
|
static FileImporter |
getFileImporter(java.lang.String path,
boolean useFirstFound)
Returns the appropriate file importer for the specified file.
|
static java.util.List<FileImporter> |
getFileImporters()
Returns all available resource (non image) importer which take file as input.
|
static java.util.Map<FileImporter,java.util.List<java.lang.String>> |
getFileImporters(java.util.List<FileImporter> importers,
java.util.List<java.lang.String> paths,
boolean useFirstFound)
Returns a Map containing the appropriate file importer for the specified file.
|
static java.util.List<FileImporter> |
getFileImporters(java.util.List<FileImporter> importers,
java.lang.String path)
Returns all file importer which can open the specified file.
|
static java.util.Map<FileImporter,java.util.List<java.lang.String>> |
getFileImporters(java.util.List<java.lang.String> paths,
boolean useFirstFound)
Returns a Map containing the appropriate file importer for the specified file.
|
static java.util.List<FileImporter> |
getFileImporters(java.lang.String path)
Returns all file importer which can open the specified file.
|
static java.util.List<Loader.FilePosition> |
getFilePositions(java.util.List<java.lang.String> paths,
boolean dimOrder)
Deprecated.
|
static java.util.List<Loader.FilePosition> |
getFilePositions(java.util.List<java.lang.String> paths,
boolean dimOrder,
FileFrame loadingFrame)
Deprecated.
|
static java.util.List<Importer> |
getImporters()
Returns all available resource importer.
|
static loci.formats.ome.OMEXMLMetadataImpl |
getMetaData(java.io.File file)
Deprecated.
Use
getOMEXMLMetaData(String) instead. |
static loci.formats.ome.OMEXMLMetadataImpl |
getMetaData(SequenceFileImporter importer,
java.lang.String path)
Deprecated.
Use
getOMEXMLMetaData(SequenceFileImporter, String) instead. |
static loci.formats.ome.OMEXMLMetadataImpl |
getMetaData(java.lang.String path)
Deprecated.
Use
getOMEXMLMetaData(String) instead |
static ome.xml.meta.OMEXMLMetadata |
getOMEXMLMetaData(SequenceFileImporter importer,
java.lang.String path)
Loads and returns metadata of the specified image file with given importer.
|
static ome.xml.meta.OMEXMLMetadata |
getOMEXMLMetaData(java.lang.String path)
Loads and returns metadata of the specified image file.
|
static loci.formats.IFormatReader |
getReader(java.lang.String path)
Deprecated.
Use
getSequenceFileImporters(String) instead. |
static SequenceFileImporter |
getSequenceFileImporter(java.util.List<SequenceFileImporter> importers,
java.lang.String path)
Deprecated.
|
static <T extends SequenceFileImporter> |
getSequenceFileImporter(java.util.List<T> importers,
java.lang.String path,
boolean useFirstFound)
Returns the appropriate sequence file importer for the specified path.
|
static SequenceFileImporter |
getSequenceFileImporter(java.lang.String path)
Deprecated.
|
static SequenceFileImporter |
getSequenceFileImporter(java.lang.String path,
boolean useFirstFound)
Returns the appropriate sequence file importer for the specified file path.
|
static java.util.List<SequenceFileImporter> |
getSequenceFileImporters()
Returns all available sequence importer which take file as input.
|
static java.util.Map<SequenceFileImporter,java.util.List<java.lang.String>> |
getSequenceFileImporters(java.util.List<java.lang.String> paths,
boolean useFirstFound)
Returns a Map containing the appropriate sequence file importer for the specified list of file path.
|
static <T extends SequenceFileImporter> |
getSequenceFileImporters(java.util.List<T> importers,
java.util.List<java.lang.String> paths,
boolean useFirstFound)
Returns a Map containing the appropriate sequence file importer for the specified list of file path.
|
static <T extends SequenceFileImporter> |
getSequenceFileImporters(java.util.List<T> importers,
java.lang.String path)
Returns all sequence file importer which can open the specified path.
|
static java.util.Map<SequenceFileImporter,java.util.List<java.lang.String>> |
getSequenceFileImporters(SequenceFileImporter defaultImporter,
java.util.List<java.lang.String> paths,
boolean grouped,
boolean useFirstFound)
Returns a Map containing the appropriate sequence file importer for the specified file.
|
static java.util.List<SequenceFileImporter> |
getSequenceFileImporters(java.lang.String path)
Returns all sequence file importer which can open the specified file path.
|
static java.util.List<SequenceIdImporter> |
getSequenceIdImporters()
Returns all available sequence importer which take path as input.
|
static java.util.List<SequenceImporter> |
getSequenceImporters()
Returns all available sequence importer (different from
SequenceIdImporter or SequenceFileImporter ). |
static java.lang.String |
getSequenceName(Sequence sequence,
java.lang.String path,
boolean multiSerie,
int series) |
static java.util.List<java.lang.String> |
getSupportedFiles(SequenceFileImporter importer,
java.util.List<java.lang.String> paths)
Returns path which are supported by the specified imported for the given list of paths.
|
static int[] |
groupSeries(ome.xml.meta.OMEXMLMetadata meta)
Try to group series with similar images properties (XYZC dimension) starting from first image and return the list of grouped series index.
|
static Sequence |
internalLoadSingle(SequenceIdImporter importer,
ome.xml.meta.OMEXMLMetadata metadata,
int series,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean forceVolatile,
FileFrame loadingFrame)
Internal use only !
|
static boolean |
isImageFile(java.lang.String path)
Deprecated.
Use
isSupportedImageFile(String) instead. |
static boolean |
isSupportedImageFile(java.lang.String path)
Returns true if the specified file is a supported image file.
|
static void |
load(java.io.File file)
Deprecated.
Use
load(String, boolean) instead. |
static void |
load(java.io.File[] files,
boolean separate,
boolean autoOrder,
boolean showProgress)
Deprecated.
Use
load(List, boolean, boolean, boolean) instead. |
static void |
load(java.io.File file,
boolean showProgress)
Deprecated.
Use
load(String, boolean) instead. |
static void |
load(FileImporter importer,
java.util.List<java.lang.String> paths,
boolean showProgress)
Load the specified files with the given
FileImporter . |
static void |
load(java.util.List<java.io.File> files)
Deprecated.
Use
load(List, boolean, boolean, boolean) instead. |
static void |
load(java.util.List<java.io.File> files,
boolean separate)
Deprecated.
Use
load(List, boolean, boolean, boolean) instead. |
static void |
load(java.util.List<java.io.File> files,
boolean separate,
boolean showProgress)
Deprecated.
Use
load(List, boolean, boolean, boolean) instead. |
static void |
load(java.util.List<java.lang.String> paths,
boolean separate,
boolean autoOrder,
boolean showProgress)
Load the specified files (asynchronous process) by using automatically the appropriate
FileImporter or SequenceFileImporter . |
static void |
load(java.util.List<java.lang.String> paths,
boolean forceVolatile,
boolean separate,
boolean autoOrder,
boolean showProgress)
Load the specified files (asynchronous process) by using automatically the appropriate
FileImporter or SequenceFileImporter . |
static void |
load(java.util.List<java.lang.String> paths,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean directory,
boolean addToRecent,
boolean showProgress)
Load the specified image file list (try to group them as much as possible).
|
static void |
load(SequenceFileImporter importer,
java.util.List<java.lang.String> paths,
boolean separate,
boolean autoOrder,
boolean showProgress)
Load the specified image files with the given
SequenceFileImporter . |
static void |
load(SequenceFileImporter importer,
java.lang.String path,
int series,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean separate,
boolean addToRecent,
boolean showProgress)
Load the specified image file with the given
SequenceFileImporter . |
static void |
load(SequenceFileImporter importer,
java.lang.String path,
int series,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean forceVolatile,
boolean separate,
boolean addToRecent,
boolean showProgress)
Load the specified image file with the given
SequenceFileImporter . |
static void |
load(SequenceFileSticher.SequenceFileGroup group,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean directory,
boolean addToRecent,
boolean showProgress)
Load the specified image file group (built using SequenceFileSticher class).
|
static void |
load(java.lang.String path,
boolean showProgress)
Load the specified file (asynchronous process) by using automatically the appropriate
FileImporter or
SequenceFileImporter . |
static IcyBufferedImage |
loadImage(java.io.File file)
Deprecated.
Use
loadImage(String) instead. |
static IcyBufferedImage |
loadImage(java.io.File file,
int z,
int t)
Deprecated.
Use
loadImage(String, int, int) instead. |
static IcyBufferedImage |
loadImage(loci.formats.IFormatReader reader)
Deprecated.
Use
IcyBufferedImage.createFrom(IFormatReader, int, int) with Z and T
parameters set to 0. |
static IcyBufferedImage |
loadImage(loci.formats.IFormatReader reader,
int z,
int t)
Deprecated.
Use
IcyBufferedImage.createFrom(IFormatReader, int, int) instead. |
static IcyBufferedImage |
loadImage(SequenceFileImporter importer,
java.lang.String path,
int series,
int z,
int t)
Load and return the image at given position from the specified file path.
|
static IcyBufferedImage |
loadImage(java.lang.String path)
Load and return a single image from the specified file path.
|
static IcyBufferedImage |
loadImage(java.lang.String path,
int z,
int t)
Deprecated.
Use
loadImage(String, int, int, int) instead. |
static IcyBufferedImage |
loadImage(java.lang.String path,
int series,
int z,
int t)
Load and return the image at given position from the specified file path.
|
static Sequence |
loadSequence(java.io.File file)
Deprecated.
Use
loadSequence(File, int, boolean) instead. |
static Sequence |
loadSequence(java.io.File[] files,
int series,
boolean showProgress)
Deprecated.
|
static Sequence |
loadSequence(java.io.File file,
boolean showProgress)
Deprecated.
Use
loadSequence(File, int, boolean) instead. |
static Sequence |
loadSequence(java.io.File file,
int series,
boolean showProgress)
Deprecated.
Use
loadSequence(String, int, boolean) instead. |
static Sequence |
loadSequence(java.util.List<?> files)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(java.util.List<?> files,
boolean showProgress)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(java.util.List<?> files,
boolean display,
boolean addToRecent)
Deprecated.
|
static Sequence |
loadSequence(java.util.List<java.lang.String> paths,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean directory,
boolean addToRecent,
boolean showProgress)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(java.util.List<java.lang.String> paths,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean forceVolatile,
boolean directory,
boolean addToRecent,
boolean showProgress)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(SequenceFileImporter importer,
java.util.List<java.lang.String> paths,
boolean showProgress)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(SequenceFileImporter importer,
java.util.List<java.lang.String> paths,
boolean addToRecent,
boolean showProgress)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(SequenceFileImporter importer,
java.util.List<java.lang.String> paths,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean forceVolatile,
boolean directory,
boolean addToRecent,
boolean showProgress)
Load a sequence from the specified list of file and returns it.
|
static Sequence |
loadSequence(SequenceFileImporter importer,
java.lang.String path,
int series,
boolean showProgress)
Load a sequence from the specified file.
|
static Sequence |
loadSequence(SequenceFileImporter importer,
java.lang.String path,
int series,
boolean addToRecent,
boolean showProgress)
Loads the specified image file and return it as a Sequence, it can return
null
if an error occured. |
static Sequence |
loadSequence(SequenceFileImporter importer,
java.lang.String path,
int series,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean addToRecent,
boolean showProgress)
Loads the specified image file and return it as a Sequence, it can return
null
if an error occured. |
static Sequence |
loadSequence(SequenceFileImporter importer,
java.lang.String path,
int series,
int resolution,
java.awt.Rectangle region,
int minZ,
int maxZ,
int minT,
int maxT,
int channel,
boolean forceVolatile,
boolean addToRecent,
boolean showProgress)
Loads the specified image file and return it as a Sequence, it can return
null
if an error occured. |
static Sequence |
loadSequence(java.lang.String path,
int series,
boolean showProgress)
Load a sequence from the specified file.
|
static Sequence[] |
loadSequences(java.io.File[] files,
int[] series,
boolean separate,
boolean autoOrder,
boolean showProgress)
Deprecated.
|
static Sequence[] |
loadSequences(java.io.File[] files,
int series,
boolean separate,
boolean autoOrder,
boolean showProgress)
Deprecated.
|
static Sequence[] |
loadSequences(java.io.File file,
int[] series,
boolean showProgress)
Deprecated.
Use
loadSequence(File, int, boolean) instead. |
static java.util.List<Sequence> |
loadSequences(java.io.File file,
java.util.List<java.lang.Integer> series)
Deprecated.
Use
loadSequences(File, int[], boolean) instead. |
static java.util.List<Sequence> |
loadSequences(java.io.File file,
java.util.List<java.lang.Integer> series,
boolean showProgress)
Deprecated.
Use
loadSequences(File, int[], boolean) instead. |
static java.util.List<Sequence> |
loadSequences(java.io.File file,
java.util.List<java.lang.Integer> series,
boolean display,
boolean addToRecent)
Deprecated.
Use
loadSequences(File, int[], boolean) instead. |
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
boolean separate)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
boolean separate,
boolean showProgress)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
boolean separate,
boolean display,
boolean addToRecent)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
java.util.List<java.lang.Integer> series)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
java.util.List<java.lang.Integer> series,
boolean separate)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
java.util.List<java.lang.Integer> series,
boolean separate,
boolean showProgress)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.io.File> files,
java.util.List<java.lang.Integer> series,
boolean separate,
boolean autoOrder,
boolean showProgress)
Deprecated.
|
static java.util.List<Sequence> |
loadSequences(java.util.List<java.lang.String> paths,
int series,
boolean separate,
boolean autoOrder,
boolean addToRecent,
boolean showProgress)
Loads a list of sequence from the specified list of file and returns them.
|
static java.util.List<Sequence> |
loadSequences(SequenceFileImporter importer,
java.util.List<java.lang.String> paths,
int series,
boolean separate,
boolean autoOrder,
boolean addToRecent,
boolean showProgress)
Load a list of sequence from the specified list of file with the given
SequenceFileImporter and returns them. |
static java.util.List<Sequence> |
loadSequences(SequenceFileImporter importer,
java.util.List<java.lang.String> paths,
int series,
boolean forceVolatile,
boolean separate,
boolean autoOrder,
boolean addToRecent,
boolean showProgress)
Load a list of sequence from the specified list of file with the given
SequenceFileImporter and returns them. |
static IcyBufferedImage |
loadThumbnail(SequenceFileImporter importer,
java.lang.String path,
int series)
Returns a thumbnail of the specified image file path.
|
static IcyBufferedImage |
loadThumbnail(java.lang.String path,
int series)
Returns a thumbnail of the specified image file path.
|
static FileImporter |
selectFileImporter(java.util.List<FileImporter> importers,
java.lang.String path)
Display a dialog to let the user select the appropriate file importer for the specified file.
|
static <T extends SequenceFileImporter> |
selectSequenceFileImporter(java.util.List<T> importers,
java.lang.String path)
Display a dialog to let the user select the appropriate sequence file importer for the given file path.
|
static int |
selectSerie(SequenceFileImporter importer,
java.lang.String path,
loci.formats.ome.OMEXMLMetadataImpl meta,
int defaultSerie)
Deprecated.
|
static int |
selectSerie(SequenceFileImporter importer,
java.lang.String path,
ome.xml.meta.OMEXMLMetadata meta,
int defaultSerie)
Display the Series Selection frame for the given image and return the selected series (single selection).
|
static int[] |
selectSeries(SequenceFileImporter importer,
java.lang.String path,
loci.formats.ome.OMEXMLMetadataImpl meta,
int defaultSerie,
boolean singleSelection)
Display the Series Selection frame for the given image and returns selected series(s).
|
static int[] |
selectSeries(SequenceFileImporter importer,
java.lang.String path,
ome.xml.meta.OMEXMLMetadata meta,
int defaultSerie,
boolean singleSelection)
Display the Series Selection frame for the given image and returns selected series(s).
|
static int[] |
selectSeries(SequenceIdImporter importer,
java.lang.String path,
ome.xml.meta.OMEXMLMetadata meta,
int defaultSerie,
boolean singleSelection)
Display the Series Selection frame for the given image and returns selected series(s).
|
static void |
setupSequence(Sequence sequence,
SequenceIdImporter importer,
boolean multiSerie,
int series,
java.awt.Rectangle region,
int resolution,
int sizeZ,
int sizeT,
int sizeC,
int minZ,
int maxZ,
int minT,
int maxT,
int channel)
Setup the specified sequence object given the different opening informations
|
public Loader()
public static java.util.List<Importer> getImporters()
public static java.util.List<FileImporter> getFileImporters()
public static java.util.Map<FileImporter,java.util.List<java.lang.String>> getFileImporters(java.util.List<FileImporter> importers, java.util.List<java.lang.String> paths, boolean useFirstFound)
importers
- the base list of importer we want to test to open file.paths
- the list of file we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match for a file.public static java.util.Map<FileImporter,java.util.List<java.lang.String>> getFileImporters(java.util.List<java.lang.String> paths, boolean useFirstFound)
paths
- the list of file we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match for a file.public static java.util.List<FileImporter> getFileImporters(java.util.List<FileImporter> importers, java.lang.String path)
public static java.util.List<FileImporter> getFileImporters(java.lang.String path)
public static FileImporter getFileImporter(java.util.List<FileImporter> importers, java.lang.String path, boolean useFirstFound)
null
if no importer can open the file.importers
- the base list of importer we want to test to open file.path
- the file we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match.getFileImporters(List, String)
public static FileImporter getFileImporter(java.lang.String path, boolean useFirstFound)
null
if no importer can open the file.path
- the file we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match.getFileImporters(String)
public static FileImporter selectFileImporter(java.util.List<FileImporter> importers, java.lang.String path)
public static java.util.List<SequenceImporter> getSequenceImporters()
SequenceIdImporter
or SequenceFileImporter
).public static java.util.List<SequenceIdImporter> getSequenceIdImporters()
getSequenceFileImporters()
instead.getSequenceFileImporters()
public static java.util.List<SequenceFileImporter> getSequenceFileImporters()
getSequenceIdImporters()
public static <T extends SequenceFileImporter> java.util.Map<T,java.util.List<java.lang.String>> getSequenceFileImporters(java.util.List<T> importers, java.util.List<java.lang.String> paths, boolean useFirstFound)
importers
- the base list of importer we want to test to open file.paths
- the list of path we want to find importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match for a path.public static java.util.Map<SequenceFileImporter,java.util.List<java.lang.String>> getSequenceFileImporters(SequenceFileImporter defaultImporter, java.util.List<java.lang.String> paths, boolean grouped, boolean useFirstFound)
paths
- the list of file we want to retrieve importer for.grouped
- if set to true
then we want to group the files so we only need to find the first appropriate importer
and don't test for other files (only 1 importer will be returned for all files).useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when severals importers match for a file.public static java.util.Map<SequenceFileImporter,java.util.List<java.lang.String>> getSequenceFileImporters(java.util.List<java.lang.String> paths, boolean useFirstFound)
paths
- the list of path we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match for a file.public static <T extends SequenceFileImporter> java.util.List<T> getSequenceFileImporters(java.util.List<T> importers, java.lang.String path)
public static java.util.List<SequenceFileImporter> getSequenceFileImporters(java.lang.String path)
public static <T extends SequenceFileImporter> T getSequenceFileImporter(java.util.List<T> importers, java.lang.String path, boolean useFirstFound)
null
if no importer can open the specified path.importers
- the base list of importer we want to test to open file path.path
- the path we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match.getSequenceFileImporters(List, String)
public static SequenceFileImporter getSequenceFileImporter(java.lang.String path, boolean useFirstFound)
null
if no importer can open the specified file path.path
- the file path we want to retrieve importer for.useFirstFound
- if set to true
then the first matching importer is automatically selected
otherwise a dialog appears to let the user to choose the correct importer when
severals importers match.getSequenceFileImporters(String)
public static <T extends SequenceFileImporter> T selectSequenceFileImporter(java.util.List<T> importers, java.lang.String path)
@Deprecated public static SequenceFileImporter getSequenceFileImporter(java.util.List<SequenceFileImporter> importers, java.lang.String path)
getSequenceFileImporter(List, String, boolean)
@Deprecated public static SequenceFileImporter getSequenceFileImporter(java.lang.String path)
getSequenceFileImporter(String, boolean)
public static boolean canDiscardImageFile(java.lang.String path)
true
if the specified path describes a file type (from extension) which
is well known to
not be an image file.public static boolean isSupportedImageFile(java.lang.String path)
@Deprecated public static boolean isImageFile(java.lang.String path)
isSupportedImageFile(String)
instead.public static java.util.List<java.lang.String> getSupportedFiles(SequenceFileImporter importer, java.util.List<java.lang.String> paths)
public static long checkOpeningPlane(int resolution, int sizeX, int sizeY, java.lang.String messageSuffix) throws java.lang.UnsupportedOperationException
resolution
- wanted image resolution: a value of 0
means full resolution of the
original image while value 1
correspond to the resolution / 2.resolution / 2^value
sizeX
- width of the image region we want to loadsizeY
- height of the image region we want to loadmessageSuffix
- message suffix for the exception if wantedjava.lang.UnsupportedOperationException
- if the XY plane size is >= 2^31 pixelspublic static void checkOpening(int resolution, int sizeX, int sizeY, int sizeC, int sizeZ, int sizeT, DataType dataType, java.lang.String messageSuffix) throws java.lang.UnsupportedOperationException, java.lang.OutOfMemoryError
resolution
- wanted image resolution: a value of 0
means full resolution of the
original image while value 1
correspond to the resolution / 2.resolution / 2^value
sizeX
- width of the image region we want to loadsizeY
- height of the image region we want to loadsizeC
- number of channel we want to loadsizeZ
- number of slice we want to load (can be different from original image sizeZ)sizeT
- number of frame we want to load (can be different from original image sizeT)dataType
- pixel data type of the image we want to loadmessageSuffix
- message suffix for the exception if wantedjava.lang.UnsupportedOperationException
- if the XY plane size is >= 2^31 pixelsjava.lang.OutOfMemoryError
- if there is not enough memory to open the imagepublic static void checkOpening(ome.xml.meta.OMEXMLMetadata meta, int series, int resolution, int sizeZ, int sizeT, java.lang.String messageSuffix) throws java.lang.UnsupportedOperationException, java.lang.OutOfMemoryError
meta
- metadata of the imageseries
- series indexresolution
- wanted image resolution: a value of 0
means full resolution of the
original image while value
1
correspond to the resolution / 2.resolution / 2^value
sizeZ
- number of slice we want to load (can be different from original image sizeZ)sizeT
- number of frame we want to load (can be different from original image sizeT)messageSuffix
- message suffix for the exception if wantedjava.lang.UnsupportedOperationException
- if the XY plane size is >= 2^31 pixelsjava.lang.OutOfMemoryError
- if there is not enough memory to open the imagepublic static void checkOpening(ome.xml.meta.OMEXMLMetadata meta, int series, int resolution, java.lang.String messageSuffix) throws java.lang.UnsupportedOperationException, java.lang.OutOfMemoryError
meta
- metadata of the imageseries
- series indexresolution
- wanted image resolution: a value of 0
means full resolution of the
original image while value
1
correspond to the resolution / 2.resolution / 2^value
messageSuffix
- message suffix for the exception if wantedjava.lang.UnsupportedOperationException
- if the XY plane size is >= 2^31 pixelsjava.lang.OutOfMemoryError
- if there is not enough memory to open the image@Deprecated public static loci.formats.IFormatReader getReader(java.lang.String path) throws loci.formats.FormatException, java.io.IOException
getSequenceFileImporters(String)
instead.loci.formats.FormatException
java.io.IOException
public static ome.xml.meta.OMEXMLMetadata getOMEXMLMetaData(SequenceFileImporter importer, java.lang.String path) throws UnsupportedFormatException, java.io.IOException
null
if the specified file is not a valid or supported) image
file.UnsupportedFormatException
java.io.IOException
public static ome.xml.meta.OMEXMLMetadata getOMEXMLMetaData(java.lang.String path) throws UnsupportedFormatException, java.io.IOException
null
if the specified file is not a valid or supported) image
file.UnsupportedFormatException
java.io.IOException
@Deprecated public static loci.formats.ome.OMEXMLMetadataImpl getMetaData(SequenceFileImporter importer, java.lang.String path) throws UnsupportedFormatException, java.io.IOException
getOMEXMLMetaData(SequenceFileImporter, String)
instead.UnsupportedFormatException
java.io.IOException
@Deprecated public static loci.formats.ome.OMEXMLMetadataImpl getMetaData(java.lang.String path) throws UnsupportedFormatException, java.io.IOException
getOMEXMLMetaData(String)
insteadjava.io.IOException
UnsupportedFormatException
@Deprecated public static loci.formats.ome.OMEXMLMetadataImpl getMetaData(java.io.File file) throws UnsupportedFormatException, java.io.IOException
getOMEXMLMetaData(String)
instead.UnsupportedFormatException
java.io.IOException
public static IcyBufferedImage loadThumbnail(SequenceFileImporter importer, java.lang.String path, int series) throws UnsupportedFormatException, java.io.IOException
null
if the specified file is not a valid or supported image file.importer
- Importer used to open and load the thumbnail from the image file.path
- image file path.series
- Series index we want to retrieve thumbnail from (for multi series image).UnsupportedFormatException
java.io.IOException
public static IcyBufferedImage loadThumbnail(java.lang.String path, int series) throws UnsupportedFormatException, java.io.IOException
path
- image file path.series
- Series index we want to retrieve thumbnail from (for multi series image).UnsupportedFormatException
java.io.IOException
@Deprecated public static IcyBufferedImage loadImage(loci.formats.IFormatReader reader, int z, int t) throws loci.formats.FormatException, java.io.IOException
IcyBufferedImage.createFrom(IFormatReader, int, int)
instead.loci.formats.FormatException
java.io.IOException
@Deprecated public static IcyBufferedImage loadImage(loci.formats.IFormatReader reader) throws loci.formats.FormatException, java.io.IOException
IcyBufferedImage.createFrom(IFormatReader, int, int)
with Z and T
parameters set to 0.loci.formats.FormatException
java.io.IOException
@Deprecated public static IcyBufferedImage loadImage(java.io.File file, int z, int t) throws loci.formats.FormatException, java.io.IOException
loadImage(String, int, int)
instead.loci.formats.FormatException
java.io.IOException
@Deprecated public static IcyBufferedImage loadImage(java.io.File file) throws UnsupportedFormatException, java.io.IOException
loadImage(String)
instead.UnsupportedFormatException
java.io.IOException
@Deprecated public static IcyBufferedImage loadImage(java.lang.String path, int z, int t) throws loci.formats.FormatException, java.io.IOException
loadImage(String, int, int, int)
instead.loci.formats.FormatException
java.io.IOException
public static IcyBufferedImage loadImage(SequenceFileImporter importer, java.lang.String path, int series, int z, int t) throws UnsupportedFormatException, java.io.IOException
importer
- Importer used to open and load the image file.path
- image file path.series
- Series index we want to retrieve image from (for multi series image).z
- Z position of the image to open.t
- T position of the image to open.java.io.IOException
UnsupportedFormatException
public static IcyBufferedImage loadImage(java.lang.String path, int series, int z, int t) throws UnsupportedFormatException, java.io.IOException
getSequenceFileImporter(String, boolean)
method and
directly work through the returned ImageProvider
interface.path
- image file path.series
- Series index we want to retrieve image from (for multi series image).z
- Z position of the image to open.t
- T position of the image to open.java.io.IOException
UnsupportedFormatException
public static IcyBufferedImage loadImage(java.lang.String path) throws UnsupportedFormatException, java.io.IOException
UnsupportedFormatException
java.io.IOException
@Deprecated public static Sequence[] loadSequences(java.io.File[] files, int[] series, boolean separate, boolean autoOrder, boolean showProgress)
loadSequences(File[], int, boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, java.util.List<java.lang.Integer> series, boolean separate, boolean autoOrder, boolean showProgress)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, java.util.List<java.lang.Integer> series, boolean separate, boolean showProgress)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, java.util.List<java.lang.Integer> series, boolean separate)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, java.util.List<java.lang.Integer> series)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, boolean separate, boolean showProgress)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, boolean separate)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.util.List<java.io.File> files, boolean separate, boolean display, boolean addToRecent)
loadSequences(File[], int[], boolean, boolean, boolean)
instead.@Deprecated public static Sequence[] loadSequences(java.io.File file, int[] series, boolean showProgress)
loadSequence(File, int, boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.io.File file, java.util.List<java.lang.Integer> series, boolean showProgress)
loadSequences(File, int[], boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.io.File file, java.util.List<java.lang.Integer> series)
loadSequences(File, int[], boolean)
instead.@Deprecated public static java.util.List<Sequence> loadSequences(java.io.File file, java.util.List<java.lang.Integer> series, boolean display, boolean addToRecent)
loadSequences(File, int[], boolean)
instead.@Deprecated public static Sequence loadSequence(java.io.File file, boolean showProgress)
loadSequence(File, int, boolean)
instead.@Deprecated public static Sequence loadSequence(java.io.File file)
loadSequence(File, int, boolean)
instead.@Deprecated public static Sequence[] loadSequences(java.io.File[] files, int series, boolean separate, boolean autoOrder, boolean showProgress)
loadSequences(List, int, boolean, boolean, boolean, boolean)
instead.@Deprecated public static Sequence loadSequence(java.io.File[] files, int series, boolean showProgress)
files
- List of image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).showProgress
- Show progression of loading process.@Deprecated public static Sequence loadSequence(java.io.File file, int series, boolean showProgress)
loadSequence(String, int, boolean)
instead.public static java.util.List<Sequence> loadSequences(SequenceFileImporter importer, java.util.List<java.lang.String> paths, int series, boolean forceVolatile, boolean separate, boolean autoOrder, boolean addToRecent, boolean showProgress)
SequenceFileImporter
and returns them.null
.importer
- Importer used to open and load image files.null
the loader will search for a compatible importer and if
several importers match the user will have to select the appropriate one from a
selection dialog.paths
- List of image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).forceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).separate
- Force image to be loaded in separate sequence.autoOrder
- Try to order image in sequence from their filenameaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression of loading process.public static java.util.List<Sequence> loadSequences(SequenceFileImporter importer, java.util.List<java.lang.String> paths, int series, boolean separate, boolean autoOrder, boolean addToRecent, boolean showProgress)
SequenceFileImporter
and returns them.null
.importer
- Importer used to open and load image files.null
the loader will search for a compatible importer and if
several importers match the user will have to select the appropriate one from a
selection dialog.paths
- List of image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).separate
- Force image to be loaded in separate sequence.autoOrder
- Try to order image in sequence from their filenameaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression of loading process.public static java.util.List<Sequence> loadSequences(java.util.List<java.lang.String> paths, int series, boolean separate, boolean autoOrder, boolean addToRecent, boolean showProgress)
paths
- List of image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).separate
- Force image to be loaded in separate sequence.autoOrder
- Try to order image in sequence from their filenameaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression of loading process.public static Sequence loadSequence(SequenceFileImporter importer, java.util.List<java.lang.String> paths, boolean addToRecent, boolean showProgress)
importer
- Importer used to load the image file (can be null for automatic selection).paths
- List of image file to load.addToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression of loading process.getSequenceFileImporter(String, boolean)
public static Sequence loadSequence(SequenceFileImporter importer, java.util.List<java.lang.String> paths, boolean showProgress)
importer
- Importer used to load the image file (can be null for automatic selection).paths
- List of image file to load.showProgress
- Show progression of loading process.getSequenceFileImporter(String, boolean)
@Deprecated public static Sequence loadSequence(java.util.List<?> files, boolean display, boolean addToRecent)
loadSequence(SequenceFileImporter, List, boolean, boolean)
insteadpublic static Sequence loadSequence(java.util.List<?> files, boolean showProgress)
files
- List of image file to load (can be String or File object).showProgress
- Show progression of loading process.public static Sequence loadSequence(java.util.List<?> files)
files
- List of image file to load (can be String or File object).public static Sequence loadSequence(SequenceFileImporter importer, java.lang.String path, int series, boolean addToRecent, boolean showProgress)
null
if an error occured.importer
- Importer used to load the image file.null
the loader will search for a compatible importer and if
several importers
match the user will have to select the appropriate one from a selection dialog if
showProgress
parameter is set to true
otherwise the first
compatible importer will be automatically used.path
- Image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).addToRecent
- If set to true the path will be traced in recent opened sequence.showProgress
- Show progression of loading process.public static Sequence loadSequence(SequenceFileImporter importer, java.lang.String path, int series, boolean showProgress)
importer
- Importer used to load the image file.null
the loader will search for a compatible importer and if
several importers
match the user will have to select the appropriate one from a selection dialog if
showProgress
parameter is set to true
otherwise the first
compatible importer will be automatically used.path
- Image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).showProgress
- Show progression of loading process.public static Sequence loadSequence(java.lang.String path, int series, boolean showProgress)
showProgress
parameter is set to true
otherwise the first
compatible importer is automatically used.path
- Image file to load.series
- Series index to load (for multi series sequence), set to 0 if unsure (default).showProgress
- Show progression of loading process.@Deprecated public static void load(java.util.List<java.io.File> files)
load(List, boolean, boolean, boolean)
instead.@Deprecated public static void load(java.util.List<java.io.File> files, boolean separate)
load(List, boolean, boolean, boolean)
instead.@Deprecated public static void load(java.util.List<java.io.File> files, boolean separate, boolean showProgress)
load(List, boolean, boolean, boolean)
instead.@Deprecated public static void load(java.io.File file)
load(String, boolean)
instead.@Deprecated public static void load(java.io.File[] files, boolean separate, boolean autoOrder, boolean showProgress)
load(List, boolean, boolean, boolean)
instead.@Deprecated public static void load(java.io.File file, boolean showProgress)
load(String, boolean)
instead.public static void load(FileImporter importer, java.util.List<java.lang.String> paths, boolean showProgress)
FileImporter
.importer
- Importer used to open and load files.null
the loader will search for a compatible importer and if
several importers match the user will have to select the appropriate one from a
selection dialog.paths
- list of file to loadshowProgress
- Show progression in loading processpublic static void load(SequenceFileImporter importer, java.lang.String path, int series, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean forceVolatile, boolean separate, boolean addToRecent, boolean showProgress)
SequenceFileImporter
.importer
- Importer used to load the image file.null
the loader will search for a compatible importer and if
several importers match the user will have to select the appropriate one from a selection dialog if
showProgress
parameter is set to true
otherwise the first
compatible importer will be automatically used.path
- image file to loadseries
- Series index to load (for multi series sequence), set to 0 if unsure (default).resolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).forceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).separate
- Force image to be loaded in separate sequence if possible (disable stitching if any)addToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processpublic static void load(SequenceFileImporter importer, java.lang.String path, int series, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean separate, boolean addToRecent, boolean showProgress)
SequenceFileImporter
.importer
- Importer used to load the image file.null
the loader will search for a compatible importer and if
several importers match the user will have to select the appropriate one from a selection dialog if
showProgress
parameter is set to true
otherwise the first
compatible importer will be automatically used.path
- image file to loadseries
- Series index to load (for multi series sequence), set to 0 if unsure (default).resolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).separate
- Force image to be loaded in separate sequence if possible (disable stitching if any)addToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processpublic static void load(java.util.List<java.lang.String> paths, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean directory, boolean addToRecent, boolean showProgress)
paths
- list of file we want to group to build a to loadresolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).directory
- specify is the source is a single complete directoryaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processpublic static void load(SequenceFileSticher.SequenceFileGroup group, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean directory, boolean addToRecent, boolean showProgress)
group
- Sequence file group built using SequenceFileSticher
.resolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).directory
- specify is the source is a single complete directoryaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processpublic static void load(SequenceFileImporter importer, java.util.List<java.lang.String> paths, boolean separate, boolean autoOrder, boolean showProgress)
SequenceFileImporter
.importer
- Importer used to open and load image files.null
the loader will search for a compatible importer and if
several importers match the user will have to select the appropriate one from a
selection dialog.paths
- list of image file to loadseparate
- Force image to be loaded in separate sequenceautoOrder
- Try to order image in sequence from their filenameshowProgress
- Show progression in loading processpublic static void load(java.util.List<java.lang.String> paths, boolean forceVolatile, boolean separate, boolean autoOrder, boolean showProgress)
FileImporter
or SequenceFileImporter
. If several importers match to open the
file the user will have to select the appropriate one from a selection dialog.false
the loader try to set image in the same
sequence.true
each image is loaded in a separate sequence.paths
- list of file to loadforceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).separate
- Force image to be loaded in separate sequence (image files only)autoOrder
- Try to order image in sequence from their filename (image files only)showProgress
- Show progression in loading processpublic static void load(java.util.List<java.lang.String> paths, boolean separate, boolean autoOrder, boolean showProgress)
FileImporter
or SequenceFileImporter
. If several importers match to open the
file the user will have to select the appropriate one from a selection dialog.false
the loader try to set image in the same
sequence.true
each image is loaded in a separate sequence.paths
- list of file to loadseparate
- Force image to be loaded in separate sequence (image files only)autoOrder
- Try to order image in sequence from their filename (image files only)showProgress
- Show progression in loading processpublic static void load(java.lang.String path, boolean showProgress)
FileImporter
or
SequenceFileImporter
. If several importers match to open the
file the user will have to select the appropriate one from a selection dialog.path
- file to loadshowProgress
- Show progression of loading process.public static Sequence loadSequence(SequenceFileImporter importer, java.lang.String path, int series, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean forceVolatile, boolean addToRecent, boolean showProgress)
null
if an error occured.importer
- Importer used to load the image file.null
the loader will search for a compatible importer and if
several importers
match the user will have to select the appropriate one from a selection dialog if
showProgress
parameter is set to true
otherwise the first
compatible importer will be automatically used.path
- image file to loadseries
- Series index to load (for multi series sequence), set to 0 if unsure (default).resolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve (in full image resolution).null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).forceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).addToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processpublic static Sequence loadSequence(SequenceFileImporter importer, java.lang.String path, int series, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean addToRecent, boolean showProgress)
null
if an error occured.importer
- Importer used to load the image file.null
the loader will search for a compatible importer and if
several importers
match the user will have to select the appropriate one from a selection dialog if
showProgress
parameter is set to true
otherwise the first
compatible importer will be automatically used.path
- image file to loadseries
- Series index to load (for multi series sequence), set to 0 if unsure (default).resolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve (in full image resolution).null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).addToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processpublic static Sequence loadSequence(SequenceFileImporter importer, java.util.List<java.lang.String> paths, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean forceVolatile, boolean directory, boolean addToRecent, boolean showProgress)
importer
- Importer used to load the image files.null
the loader will take the first compatible importer found.paths
- list of file where to load image fromresolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).forceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).directory
- specify is the source is a single complete directoryaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processgetSequenceFileImporter(String, boolean)
public static Sequence loadSequence(java.util.List<java.lang.String> paths, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean forceVolatile, boolean directory, boolean addToRecent, boolean showProgress)
paths
- list of file where to load image fromresolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).forceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).directory
- specify is the source is a single complete directoryaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processgetSequenceFileImporter(String, boolean)
public static Sequence loadSequence(java.util.List<java.lang.String> paths, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean directory, boolean addToRecent, boolean showProgress)
paths
- list of file where to load image fromresolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve.null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).directory
- specify is the source is a single complete directoryaddToRecent
- If set to true the files list will be traced in recent opened sequence.showProgress
- Show progression in loading processgetSequenceFileImporter(String, boolean)
public static Sequence internalLoadSingle(SequenceIdImporter importer, ome.xml.meta.OMEXMLMetadata metadata, int series, int resolution, java.awt.Rectangle region, int minZ, int maxZ, int minT, int maxT, int channel, boolean forceVolatile, FileFrame loadingFrame) throws java.io.IOException, UnsupportedFormatException, java.lang.OutOfMemoryError
null
then it has 100 steps allocated to the
loading of current path.importer
- Opened importer used to load the image file (cannot be null
here)metadata
- Metadata of the imageseries
- Series index to load (for multi series sequence), set to 0 if unsure (default).resolution
- Wanted resolution level for the image (use 0 if unsure), useful for large imageimage.resolution / (2^resolution)
region
- The 2D region of the image we want to retrieve (in full image resolution).null
then the whole XY plane of the image is returned.minZ
- the minimum Z position of the image (slice) we want retrieve (inclusive).maxZ
- the maximum Z position of the image (slice) we want retrieve (inclusive).minT
- the minimum T position of the image (frame) we want retrieve (inclusive).maxT
- the maximum T position of the image (frame) we want retrieve (inclusive).channel
- C position of the image (channel) we want retrieve (-1 means all channel).forceVolatile
- If set to true
then image data is forced to volatile (see IcyBufferedImage.isVolatile()
).loadingFrame
- the loading frame used to display progress of the operation (can be null).null
java.io.IOException
UnsupportedFormatException
java.lang.OutOfMemoryError
public static java.lang.String getSequenceName(Sequence sequence, java.lang.String path, boolean multiSerie, int series)
public static void setupSequence(Sequence sequence, SequenceIdImporter importer, boolean multiSerie, int series, java.awt.Rectangle region, int resolution, int sizeZ, int sizeT, int sizeC, int minZ, int maxZ, int minT, int maxT, int channel)
sequence
- sequence to adjust propertiesimporter
- image pathmultiSerie
- true
if this Sequence comes from a multi series datasetseries
- series indexregion
- Rectangle region we want to load from original image (full resolution)resolution
- Resolution level to opensizeZ
- original image sizeZsizeT
- original image sizeTsizeC
- original image sizeCminZ
- minimum Z slice wantedmaxZ
- maximum Z slice wantedminT
- minimum T frame wantedmaxT
- maximum T frame wantedchannel
- channel we want to load (-1 for all)public static int[] selectSeries(SequenceIdImporter importer, java.lang.String path, ome.xml.meta.OMEXMLMetadata meta, int defaultSerie, boolean singleSelection) throws UnsupportedFormatException, java.io.IOException
UnsupportedFormatException
java.io.IOException
public static int[] groupSeries(ome.xml.meta.OMEXMLMetadata meta)
public static int[] selectSeries(SequenceFileImporter importer, java.lang.String path, ome.xml.meta.OMEXMLMetadata meta, int defaultSerie, boolean singleSelection) throws UnsupportedFormatException, java.io.IOException
UnsupportedFormatException
java.io.IOException
public static int[] selectSeries(SequenceFileImporter importer, java.lang.String path, loci.formats.ome.OMEXMLMetadataImpl meta, int defaultSerie, boolean singleSelection) throws UnsupportedFormatException, java.io.IOException
UnsupportedFormatException
java.io.IOException
public static int selectSerie(SequenceFileImporter importer, java.lang.String path, ome.xml.meta.OMEXMLMetadata meta, int defaultSerie) throws UnsupportedFormatException, java.io.IOException
-1
if user canceled series selection.UnsupportedFormatException
java.io.IOException
@Deprecated public static int selectSerie(SequenceFileImporter importer, java.lang.String path, loci.formats.ome.OMEXMLMetadataImpl meta, int defaultSerie) throws UnsupportedFormatException, java.io.IOException
selectSerie(SequenceFileImporter, String, OMEXMLMetadata, int)
insteadUnsupportedFormatException
java.io.IOException
public static java.util.List<java.lang.String> cleanNonImageFile(java.util.List<java.lang.String> paths)
@Deprecated public static java.util.List<Loader.FilePosition> getFilePositions(java.util.List<java.lang.String> paths, boolean dimOrder, FileFrame loadingFrame)
SequenceFileSticher.groupAllFiles(SequenceFileImporter, Collection, boolean, FileFrame)
instead@Deprecated public static java.util.List<Loader.FilePosition> getFilePositions(java.util.List<java.lang.String> paths, boolean dimOrder)
SequenceFileSticher.groupAllFiles(SequenceFileImporter, Collection, boolean, FileFrame)
instead