|
||||||||||
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.ImageIOReader
public abstract class ImageIOReader
ImageIOReader is the superclass for file format readers that use the javax.imageio package.
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 | |
---|---|
ImageIOReader(String name,
String suffix)
Constructs a new ImageIOReader. |
|
ImageIOReader(String name,
String[] suffixes)
Constructs a new ImageIOReader. |
Method Summary | |
---|---|
void |
close()
Closes currently open file(s) and frees allocated memory. |
void |
close(boolean fileOnly)
Closes the currently open file. |
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. |
byte[] |
openBytes(int no,
byte[] buf)
Obtains the specified image from the current file into a pre-allocated byte array of (sizeX * sizeY * bytesPerPixel). |
BufferedImage |
openImage(int no)
Obtains the specified image from the current file. |
Methods inherited from class loci.formats.FormatHandler |
---|
addStatusListener, debug, getFormat, getStatusListeners, getSuffixes, isThisType, 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, isThisType, setId |
Methods inherited from interface loci.formats.StatusReporter |
---|
addStatusListener, getStatusListeners, removeStatusListener |
Constructor Detail |
---|
public ImageIOReader(String name, String suffix)
public ImageIOReader(String name, String[] suffixes)
Method Detail |
---|
public boolean isThisType(byte[] block)
IFormatReader
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 BufferedImage openImage(int no) throws FormatException, IOException
IFormatReader
openImage
in interface IFormatReader
openImage
in class FormatReader
FormatException
IOException
public void close(boolean fileOnly) throws IOException
IFormatReader
IFormatHandler.close()
.
close
in interface IFormatReader
close
in class FormatReader
IOException
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 |