io.scif.formats

Class ICSFormat.Writer

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractWriter<ICSFormat.Metadata>

io.scif.formats.ICSFormat.Writer

All Implemented Interfaces:

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

Enclosing class:

ICSFormat

public static class ICSFormat.Writer
extends AbstractWriter<ICSFormat.Metadata>

SCIFIO file format writer for ICS version 1 and 2 files.

Constructor Summary

Constructors

Constructor and Description
Writer()

Method Summary

Modifier and Type	Method and Description
boolean	canDoStacks()
void	close(int imageIndex)
int[]	getPixelTypes(String codec) Gets the supported pixel types for the given codec.
protected void	initialize(int imageIndex, long planeIndex, net.imglib2.Interval bounds) Ensures this writer is prepared to write the given plane of the given image.
protected String[]	makeCompressionTypes()
void	setDest(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> out, int imageIndex, SCIFIOConfig config) As Writer.setDest(DataHandle, int), with specification for new configuration options.
void	writePlane(int imageIndex, long planeIndex, Plane plane, net.imglib2.Interval bounds) Helper method invoked by AbstractWriter.savePlane(int, long, io.scif.Plane) to perform actual format- specific output.

Methods inherited from class io.scif.AbstractWriter

checkLocation, checkParams, close, getCodecOptions, getColorModel, getCompression, getCompressionTypes, getFramesPerSecond, getHandle, getMetadata, getValidBits, isInitialized, isSupportedCompression, isSupportedType, savePlane, savePlane, setColorModel, setDest, setDest, setDest, setDest, setDest, setDest, setDest, setMetadata, setMetadata, writeSequential

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

asBrowsableLocation, asBrowsableLocation, getFormat, getFormatName

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

Writer

public Writer()

Method Detail

makeCompressionTypes

protected String[] makeCompressionTypes()

Specified by:

makeCompressionTypes in class AbstractWriter<ICSFormat.Metadata>

Returns:

An array of compression types supported by this format. An empty array indicates no compression.

initialize

protected void initialize(int imageIndex,
                          long planeIndex,
                          net.imglib2.Interval bounds)
                   throws FormatException,
                          IOException

Description copied from class: AbstractWriter

Ensures this writer is prepared to write the given plane of the given image.

Overrides:

initialize in class AbstractWriter<ICSFormat.Metadata>

Throws:

FormatException

IOException

writePlane

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

Description copied from class: AbstractWriter

Helper method invoked by AbstractWriter.savePlane(int, long, io.scif.Plane) to perform actual format- specific output.

Specified by:

writePlane in class AbstractWriter<ICSFormat.Metadata>

Throws:

FormatException

IOException

canDoStacks

public boolean canDoStacks()

Specified by:

canDoStacks in interface Writer

Overrides:

canDoStacks in class AbstractWriter<ICSFormat.Metadata>

Returns:

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

getPixelTypes

public int[] getPixelTypes(String codec)

Description copied from interface: Writer

Gets the supported pixel types for the given codec.

Specified by:

getPixelTypes in interface Writer

Overrides:

getPixelTypes in class AbstractWriter<ICSFormat.Metadata>

close

public void close(int imageIndex)
           throws IOException

Throws:

IOException

setDest

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

Description copied from interface: Writer

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

Specified by:

setDest in interface Writer

Overrides:

setDest in class AbstractWriter<ICSFormat.Metadata>

Parameters:

out - 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