|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectloci.formats.FormatHandler
loci.formats.FormatReader
loci.formats.in.PrairieReader
public class PrairieReader
PrairieReader is the file format reader for Prairie Technologies' TIFF variant.
Field Summary |
---|
Fields inherited from class loci.formats.FormatReader |
---|
collectMetadata, core, filterMetadata, group, in, metadata, metadataStore, normalizeData, saveOriginalMetadata, series, THUMBNAIL_DIMENSION |
Fields inherited from class loci.formats.FormatHandler |
---|
currentId, debug, debugLevel, format, statusListeners, suffixes |
Fields inherited from interface loci.formats.IFormatReader |
---|
CAN_GROUP, CANNOT_GROUP, MUST_GROUP |
Constructor Summary | |
---|---|
PrairieReader()
Constructs a new Prairie TIFF reader. |
Method Summary | |
---|---|
void |
close()
Closes currently open file(s) and frees allocated memory. |
void |
close(boolean fileOnly)
Closes the currently open file. |
int |
fileGroupOption(String id)
Returns an int indicating that we cannot, must, or might group the files in a given dataset. |
String[] |
getUsedFiles()
Returns an array of filenames needed to open this dataset. |
protected void |
initFile(String id)
Initializes the given file (parsing header information, etc.). |
boolean |
isThisType(byte[] block)
Checks if the given block is a valid header for this file format. |
boolean |
isThisType(String name,
boolean open)
Checks if a file matches the type of this format handler. |
byte[] |
openBytes(int no,
byte[] buf)
Obtains the specified image from the current file into a pre-allocated byte array of (sizeX * sizeY * bytesPerPixel). |
Methods inherited from class loci.formats.FormatHandler |
---|
addStatusListener, debug, getFormat, getStatusListeners, getSuffixes, isThisType, removeStatusListener, setDebug, setDebugLevel, setId, status, status, status, trace, trace |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface loci.formats.IFormatHandler |
---|
getFormat, getSuffixes, isThisType, setId |
Methods inherited from interface loci.formats.StatusReporter |
---|
addStatusListener, getStatusListeners, removeStatusListener |
Constructor Detail |
---|
public PrairieReader()
Method Detail |
---|
public boolean isThisType(byte[] block)
IFormatReader
public int fileGroupOption(String id) throws FormatException, IOException
IFormatReader
fileGroupOption
in interface IFormatReader
fileGroupOption
in class FormatReader
FormatException
IOException
public String[] getUsedFiles()
IFormatReader
getUsedFiles
in interface IFormatReader
getUsedFiles
in class FormatReader
public byte[] openBytes(int no, byte[] buf) throws FormatException, IOException
IFormatReader
no
- the image index within the file.buf
- a pre-allocated buffer.
buf
for convenience.
FormatException
- if there was a problem parsing the metadata of the
file.
IOException
- if there was a problem reading the file.public void close(boolean fileOnly) throws IOException
IFormatReader
IFormatHandler.close()
.
close
in interface IFormatReader
close
in class FormatReader
IOException
public boolean isThisType(String name, boolean open)
FormatHandler
isThisType
in interface IFormatHandler
isThisType
in class FormatHandler
open
- If true, and the file extension is insufficient to determine
the file type, the (existing) file is opened for further analysis.
Does nothing in the default implementation.public void close() throws IOException
IFormatHandler
close
in interface IFormatHandler
close
in class FormatReader
IOException
protected void initFile(String id) throws FormatException, IOException
FormatReader
initFile
in class FormatReader
FormatException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |