io.scif

Interface Writer

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, HasFormat, org.scijava.plugin.HasPluginInfo, HasSource, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Versioned

All Known Subinterfaces:

TypedWriter<M>

All Known Implementing Classes:

AbstractWriter, APNGFormat.Writer, AVIFormat.Writer, DefaultWriter, EPSFormat.Writer, ICSFormat.Writer, ImageIOFormat.Writer, JPEG2000Format.Writer, JPEGFormat.Writer, LegacyQTFormat.Writer, NativeQTFormat.Writer, TIFFFormat.Writer

public interface Writer
extends HasFormat, HasSource

Interface for all SCIFIO writers.

Writer components are used to save Plane objects (output from the Reader.openPlane(int, long) methods) to a destination image location, via the savePlane(int, long, io.scif.Plane) methods.

Author:

Mark Hiner

See Also:

Plane, Reader.openPlane(int, long)

Method Summary

Modifier and Type	Method and Description
boolean	canDoStacks()
CodecOptions	getCodecOptions()
ColorModel	getColorModel() Gets the color model.
String	getCompression()
String[]	getCompressionTypes() Gets the available compression types.
int	getFramesPerSecond()
org.scijava.io.handle.DataHandle<org.scijava.io.location.Location>	getHandle() Retrieves a reference to the output source that will be written to during savePlane(int, long, io.scif.Plane) calls.
Metadata	getMetadata() Gets the Metadata that will be used when saving planes.
int[]	getPixelTypes(String codec) Gets the supported pixel types for the given codec.
int	getValidBits()
boolean	isInitialized(int imageIndex, long planeIndex)
void	isSupportedCompression(String compress) Checks if the given compression type is supported.
boolean	isSupportedType(int type, String codec) Checks if the given pixel type is supported.
void	savePlane(int imageIndex, long planeIndex, Plane plane) Saves the provided plane to the specified image and plane index of this Writer's destination image.
void	savePlane(int imageIndex, long planeIndex, Plane plane, net.imglib2.Interval bounds) Saves the specified tile (sub-region) of the provided plane to the specified image and plane index of this Writer's destination image.
void	setColorModel(ColorModel cm) Sets the color model.
void	setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle) Sets the source that will be written to during savePlane(int, long, io.scif.Plane) calls.
void	setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle, int imageIndex) As setDest(DataHandle), with specification for source image index.
void	setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle, int imageIndex, SCIFIOConfig config) As setDest(DataHandle, int), with specification for new configuration options.
void	setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle, SCIFIOConfig config) As setDest(DataHandle), with specification for new configuration options.
void	setDest(org.scijava.io.location.Location location) Sets the source that will be written to during savePlane(int, long, io.scif.Plane) calls.
void	setDest(org.scijava.io.location.Location location, int imageIndex) As setDest(Location) with specification for source image index.
void	setDest(org.scijava.io.location.Location location, int imageIndex, SCIFIOConfig config) As setDest(Location, int) with specification for new configuration options.
void	setDest(org.scijava.io.location.Location location, SCIFIOConfig config) As setDest(Location) with specification for new configuration options.
void	setMetadata(Metadata meta) Provides this Writer with a Metadata object to use when interpreting Planes during calls to savePlane(int, long, io.scif.Plane).
boolean	writeSequential()

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface io.scif.HasSource

close, close

Method Detail

savePlane

void savePlane(int imageIndex,
               long planeIndex,
               Plane plane)
        throws FormatException,
               IOException

Saves the provided plane to the specified image and plane index of this Writer's destination image.

Parameters:

imageIndex - the image index within the dataset.

planeIndex - the plane index within the image.

plane - the pixels save

Throws:

FormatException - if one of the parameters is invalid.

IOException - if there was a problem writing to the file.

savePlane

void savePlane(int imageIndex,
               long planeIndex,
               Plane plane,
               net.imglib2.Interval bounds)
        throws FormatException,
               IOException

Saves the specified tile (sub-region) of the provided plane to the specified image and plane index of this Writer's destination image.

Parameters:

imageIndex - the image index within the dataset.

planeIndex - the plane index within the image.

plane - the pixels save

bounds - bounds of the planar axes.

Throws:

FormatException - if one of the parameters is invalid.

IOException - if there was a problem writing to the file.

canDoStacks

boolean canDoStacks()

Returns:

True if this Writer can save multiple images to a single file.

setMetadata

void setMetadata(Metadata meta)
          throws FormatException

Provides this Writer with a Metadata object to use when interpreting Planes during calls to savePlane(int, long, io.scif.Plane).

NB: This method has accepts a general Metadata so that this signature can appear in the base interface for all Writers, but behavior if provided with a Metadata instance not associated with this Writer is undefined and should throw an exception.

Parameters:

meta - The Metadata to associate with this Writer.

Throws:

IllegalArgumentException - If the provided Metadata type is not compatible with this Writer.

FormatException

getMetadata

Metadata getMetadata()

Gets the Metadata that will be used when saving planes.

Returns:

The Metadata associated with this Writer.

setDest

void setDest(org.scijava.io.location.Location location)
      throws FormatException,
             IOException

Sets the source that will be written to during savePlane(int, long, io.scif.Plane) calls. NB: resets any configuration on this writer.

Parameters:

location - The Location to where the image source will be written.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle)
      throws FormatException,
             IOException

Sets the source that will be written to during savePlane(int, long, io.scif.Plane) calls. NB: resets any configuration on this writer.

Parameters:

handle - The image source to write to.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.location.Location location,
             int imageIndex)
      throws FormatException,
             IOException

As setDest(Location) with specification for source image index.

Parameters:

location - The Location of an image source to be written.

imageIndex - The index within the source that will be written.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle,
             int imageIndex)
      throws FormatException,
             IOException

As setDest(DataHandle), with specification for source image index.

Parameters:

handle - The image source to write to.

imageIndex - The index within the source that will be written.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.location.Location location,
             SCIFIOConfig config)
      throws FormatException,
             IOException

As setDest(Location) with specification for new configuration options.

Parameters:

location - The Location of an image source to be written.

config - Configuration information to use for this write.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle,
             SCIFIOConfig config)
      throws FormatException,
             IOException

As setDest(DataHandle), with specification for new configuration options.

Parameters:

handle - The image source to write to.

config - Configuration information to use for this write.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.location.Location location,
             int imageIndex,
             SCIFIOConfig config)
      throws FormatException,
             IOException

As setDest(Location, int) with specification for new configuration options.

Parameters:

location - The Location of an image source to be written.

imageIndex - The index within the source that will be written.

config - Configuration information to use for this write.

Throws:

FormatException

IOException

setDest

void setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle,
             int imageIndex,
             SCIFIOConfig config)
      throws FormatException,
             IOException

As setDest(DataHandle, int), with specification for new configuration options.

Parameters:

handle - The image source to write to.

imageIndex - The index within the source that will be written.

config - Configuration information to use for this write.

Throws:

FormatException

IOException

getHandle

org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> getHandle()

Retrieves a reference to the output source that will be written to during savePlane(int, long, io.scif.Plane) calls.

Returns:

The DataHandle} associated with this Writer.

setColorModel

void setColorModel(ColorModel cm)

Sets the color model.

NB: the color model should be set before the output destination.

getColorModel

ColorModel getColorModel()

Gets the color model.

getCompressionTypes

String[] getCompressionTypes()

Gets the available compression types.

getPixelTypes

int[] getPixelTypes(String codec)

Gets the supported pixel types for the given codec.

isSupportedType

boolean isSupportedType(int type,
                        String codec)

Checks if the given pixel type is supported.

isSupportedCompression

void isSupportedCompression(String compress)
                     throws FormatException

Checks if the given compression type is supported.

Throws:

FormatException

isInitialized

boolean isInitialized(int imageIndex,
                      long planeIndex)

Returns:

True iff this writer is prepared to write the given plane of the given image index.

getCompression

String getCompression()

Returns:

The current compression being used by the writer, or null if not set.

getFramesPerSecond

int getFramesPerSecond()

Returns:

The current frames per second being used by the writer.

getCodecOptions

CodecOptions getCodecOptions()

Returns:

CodecOptions used by this writer, if applicable.

writeSequential

boolean writeSequential()

Returns:

True if this writer should output planes sequentially.

getValidBits

int getValidBits()

Returns:

Number of valid bits per pixel.