|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFormatWriter
Interface for all biological file format writers.
Method Summary | |
---|---|
boolean |
canDoStacks()
Reports whether the writer can save multiple images to a single file. |
boolean |
canDoStacks(String id)
Deprecated. Replaced by canDoStacks() |
ColorModel |
getColorModel()
Gets the color model. |
String[] |
getCompressionTypes()
Gets the available compression types. |
int |
getFramesPerSecond()
Gets the frames per second to use when writing. |
MetadataRetrieve |
getMetadataRetrieve()
Retrieves the current metadata retrieval object for this writer. |
int[] |
getPixelTypes()
Gets the supported pixel types. |
int[] |
getPixelTypes(String id)
Deprecated. Replaced by getPixelTypes() |
boolean |
isSupportedType(int type)
Checks if the given pixel type is supported. |
boolean |
isSupportedType(String id,
int type)
Deprecated. Replaced by isSupportedType(int type) |
void |
save(String id,
Image image,
boolean last)
Deprecated. Replaced by saveImage(Image, boolean) |
void |
saveBytes(byte[] bytes,
boolean last)
Saves the given byte array to the current file. |
void |
saveBytes(byte[] bytes,
int series,
boolean lastInSeries,
boolean last)
Saves the given byte array to the given series in the current file. |
void |
saveImage(Image image,
boolean last)
Saves the given image to the current file. |
void |
saveImage(Image image,
int series,
boolean lastInSeries,
boolean last)
Saves the given image to the given series in the current file. |
void |
setColorModel(ColorModel cm)
Sets the color model. |
void |
setCompression(String compress)
Sets the current compression type. |
void |
setFramesPerSecond(int rate)
Sets the frames per second to use when writing. |
void |
setMetadataRetrieve(MetadataRetrieve r)
Sets the metadata retrieval object from which to retrieve standardized metadata. |
Methods inherited from interface loci.formats.IFormatHandler |
---|
close, getFormat, getSuffixes, isThisType, isThisType, setId, setId |
Methods inherited from interface loci.formats.StatusReporter |
---|
addStatusListener, getStatusListeners, removeStatusListener |
Method Detail |
---|
void saveImage(Image image, boolean last) throws FormatException, IOException
FormatException
IOException
void saveImage(Image image, int series, boolean lastInSeries, boolean last) throws FormatException, IOException
FormatException
IOException
void saveBytes(byte[] bytes, boolean last) throws FormatException, IOException
FormatException
IOException
void saveBytes(byte[] bytes, int series, boolean lastInSeries, boolean last) throws FormatException, IOException
FormatException
IOException
boolean canDoStacks()
void setMetadataRetrieve(MetadataRetrieve r)
MetadataRetrieve getMetadataRetrieve()
null
metadata retrieval object.
void setColorModel(ColorModel cm)
ColorModel getColorModel()
void setFramesPerSecond(int rate)
int getFramesPerSecond()
String[] getCompressionTypes()
int[] getPixelTypes()
boolean isSupportedType(int type)
void setCompression(String compress) throws FormatException
FormatException
boolean canDoStacks(String id) throws FormatException
canDoStacks()
FormatException
int[] getPixelTypes(String id) throws FormatException, IOException
getPixelTypes()
FormatException
IOException
boolean isSupportedType(String id, int type) throws FormatException, IOException
isSupportedType(int type)
FormatException
IOException
void save(String id, Image image, boolean last) throws FormatException, IOException
saveImage(Image, boolean)
FormatException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |