Module io.scif

Package io.scif.formats

Class JPEG2000Format.Writer

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractWriter<JPEG2000Format.Metadata>

io.scif.formats.JPEG2000Format.Writer

All Implemented Interfaces:

HasFormat, HasSource, SCIFIOPlugin, TypedWriter<JPEG2000Format.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:

JPEG2000Format

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

Constructor Summary

Constructors

Constructor	Description
Writer()

Method Summary

Modifier and Type	Method	Description
boolean	canDoStacks()	Overridden to indicate that stacks are not supported.
byte[]	compressBuffer(int imageIndex, long planeIndex, Plane plane, net.imglib2.Interval bounds)	Compresses the buffer.
int[]	getPixelTypes(String codec)	Overridden to return the formats supported by the writer.
protected String[]	makeCompressionTypes()
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, initialize, isInitialized, isSupportedCompression, isSupportedType, savePlane, savePlane, setColorModel, setDest, 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 org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface io.scif.HasSource

close

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Constructor Detail

Writer

public Writer()

Method Detail

makeCompressionTypes

protected String[] makeCompressionTypes()

Specified by:

makeCompressionTypes in class AbstractWriter<JPEG2000Format.Metadata>

Returns:

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

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<JPEG2000Format.Metadata>

Throws:

FormatException

IOException

compressBuffer

public byte[] compressBuffer(int imageIndex,
                             long planeIndex,
                             Plane plane,
                             net.imglib2.Interval bounds)
                      throws FormatException,
                             IOException

Compresses the buffer.

Parameters:

imageIndex - the image index within the dataset

planeIndex - the plane index within the image

plane - the image tile being compressed.

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

public boolean canDoStacks()

Overridden to indicate that stacks are not supported.

Specified by:

canDoStacks in interface Writer

Overrides:

canDoStacks in class AbstractWriter<JPEG2000Format.Metadata>

Returns:

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

getPixelTypes

public int[] getPixelTypes(String codec)

Overridden to return the formats supported by the writer.

Specified by:

getPixelTypes in interface Writer

Overrides:

getPixelTypes in class AbstractWriter<JPEG2000Format.Metadata>