icy.file

Class SequenceFileSticher

java.lang.Object

icy.file.SequenceFileSticher

public class SequenceFileSticher
extends java.lang.Object

This class is an utility class aim to help in grouping a list of file path representing image to form a complete and valid Sequence.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SequenceFileSticher.FilePosition Class used to build a FilePosition from an path
static class	SequenceFileSticher.SequenceAbsolutePosition
static class	SequenceFileSticher.SequenceFileGroup
static class	SequenceFileSticher.SequenceIdent
static class	SequenceFileSticher.SequenceIndexPosition
static class	SequenceFileSticher.SequencePosition
static class	SequenceFileSticher.SequenceType

Constructor Summary

Constructors

Constructor and Description
SequenceFileSticher()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Collection<SequenceFileSticher.SequenceFileGroup>	groupAllFiles(SequenceFileImporter importer, java.util.Collection<java.lang.String> paths, boolean findPosition, FileFrame loadingFrame) Same as groupFiles(SequenceFileImporter, Collection, boolean, FileFrame) except it does several groups if all image file path cannot be grouped to form a single Sequence.
static SequenceFileSticher.SequenceFileGroup	groupFiles(SequenceFileImporter importer, java.util.Collection<java.lang.String> paths, boolean findPosition, FileFrame loadingFrame) Take a list of image file path as input and try to group them to form a unique Sequence.

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceFileSticher

public SequenceFileSticher()

Method Detail

groupAllFiles

public static java.util.Collection<SequenceFileSticher.SequenceFileGroup> groupAllFiles(SequenceFileImporter importer,
                                                                        java.util.Collection<java.lang.String> paths,
                                                                        boolean findPosition,
                                                                        FileFrame loadingFrame)

Same as groupFiles(SequenceFileImporter, Collection, boolean, FileFrame) except it does several groups if all image file path cannot be grouped to form a single Sequence.
The grouping is done using the path name information (recognizing and parsing specific patterns in the path) and assume file shares the same properties (dimensions).
The method returns a set of SequenceFileSticher.SequenceFileGroup where each group define a Sequence.

Parameters:

importer - SequenceFileImporter to use to open image.
If set to null the method automatically try to find a compatible SequenceFileImporter.

paths - image file paths we want to group

findPosition - if true we try to determine the X, Y, Z, T and C image position otherwise a simple ascending T ordering is done

loadingFrame - Loading dialog if any to show progress

See Also:

groupFiles(SequenceFileImporter, Collection, boolean, FileFrame)

groupFiles

public static SequenceFileSticher.SequenceFileGroup groupFiles(SequenceFileImporter importer,
                                               java.util.Collection<java.lang.String> paths,
                                               boolean findPosition,
                                               FileFrame loadingFrame)

Take a list of image file path as input and try to group them to form a unique Sequence.
The grouping is done using the path name information (recognizing and parsing specific patterns in the path) and assume file shares the same properties (dimensions).
The method returns the "biggest" group found, use groupAllFiles(SequenceFileImporter, Collection, boolean, FileFrame) to retrieve all possible groups.

Parameters:

importer - SequenceFileImporter to use to open image.
If set to null the method automatically try to find a compatible SequenceFileImporter

paths - image file paths we want to group

findPosition - if true we try to determine the X, Y, Z, T and C image position otherwise a simple ascending T ordering is done

loadingFrame - Loading dialog if any to show progress

See Also:

groupAllFiles(SequenceFileImporter, Collection, boolean, FileFrame)