net.imagej.notebook

Class Images

java.lang.Object

net.imagej.notebook.Images

public final class Images
extends Object

Utility methods for adapting image data structures.

Author:

Curtis Rueden, Gabriel Selzer, Dasong Gao

Method Summary

Modifier and Type	Method and Description
static String	base64(RenderedImage image)
static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage	bufferedImage(net.imagej.Dataset source) Converts the given Dataset to a BufferedImage.
static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage	bufferedImage(net.imglib2.RandomAccessibleInterval<T> source) Converts the given RandomAccessibleInterval to a BufferedImage.
static <T extends net.imglib2.type.numeric.RealType<T>> Object	bufferedImage(net.imglib2.RandomAccessibleInterval<T> source, double[] min, double[] max) Converts the given RandomAccessibleInterval to a BufferedImage.
static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage	bufferedImage(net.imglib2.RandomAccessibleInterval<T> source, double min, double max) Converts the given RandomAccessibleInterval to a BufferedImage.
static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage	bufferedImage(net.imglib2.RandomAccessibleInterval<T> source, int xAxis, int yAxis, int cAxis, double[] min, double[] max, long... pos) Converts the given RandomAccessibleInterval to a BufferedImage.
static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage	bufferedImage(net.imglib2.RandomAccessibleInterval<T> source, int xAxis, int yAxis, int cAxis, NotebookService.ValueScaling scaling, long... pos) Converts the given RandomAccessibleInterval to a BufferedImage.
static BufferedImage	decode(byte[] data) Converts the given byte array into a BufferedImage.
static byte[]	encode(RenderedImage image) Converts the given RenderedImage into a stream of PNG bytes.
static byte[]	encode(RenderedImage image, String format) Converts the given RenderedImage into a stream of bytes.
static String	html(RenderedImage image)
static String	html(RenderedImage image, String title)

Methods inherited from class java.lang.Object

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

Method Detail

encode

public static byte[] encode(RenderedImage image)
                     throws IOException

Converts the given RenderedImage into a stream of PNG bytes.

Parameters:

image - The image to convert to a byte stream.

Returns:

A stream of bytes in PNG format.

Throws:

IOException

encode

public static byte[] encode(RenderedImage image,
                            String format)
                     throws IOException

Converts the given RenderedImage into a stream of bytes.

Parameters:

image - The image to convert to a byte stream.

format - The informal name of the format for the returned bytes; e.g. "png" or "jpg". See ImageIO.getImageWritersByFormatName(String).

Returns:

A stream of bytes in the requested format, or null if the image cannot be converted to the specified format.

Throws:

IOException

decode

public static BufferedImage decode(byte[] data)
                            throws IOException

Converts the given byte array into a BufferedImage.

Parameters:

data - The bytes to convert to an image.

Returns:

A BufferedImage of the given bytes, or null if an image cannot be decoded from the specified data stream.

Throws:

IOException

base64

public static String base64(RenderedImage image)
                     throws IOException

Throws:

IOException

html

public static String html(RenderedImage image)
                   throws IOException

Throws:

IOException

html

public static String html(RenderedImage image,
                          String title)
                   throws IOException

Throws:

IOException

bufferedImage

public static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage bufferedImage(net.imagej.Dataset source)

Converts the given Dataset to a BufferedImage.

Parameters:

source - The image to render.

Returns:

BufferedImage representation.

bufferedImage

public static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage bufferedImage(net.imglib2.RandomAccessibleInterval<T> source)

Converts the given RandomAccessibleInterval to a BufferedImage.

Parameters:

source - The image to render.

Returns:

BufferedImage representation.

bufferedImage

public static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage bufferedImage(net.imglib2.RandomAccessibleInterval<T> source,
                                                                                           double min,
                                                                                           double max)

Converts the given RandomAccessibleInterval to a BufferedImage.

Parameters:

source - The image to render.

min - The minimum value allowed on the display.

max - The maximum value allowed on the display.

Returns:

BufferedImage representation.

bufferedImage

public static <T extends net.imglib2.type.numeric.RealType<T>> Object bufferedImage(net.imglib2.RandomAccessibleInterval<T> source,
                                                                                    double[] min,
                                                                                    double[] max)

Converts the given RandomAccessibleInterval to a BufferedImage.

Parameters:

source - The image to render.

min - The minimum value per dimension allowed on the display.

max - The maximum value per dimension allowed on the display.

Returns:

BufferedImage representation.

bufferedImage

public static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage bufferedImage(net.imglib2.RandomAccessibleInterval<T> source,
                                                                                           int xAxis,
                                                                                           int yAxis,
                                                                                           int cAxis,
                                                                                           NotebookService.ValueScaling scaling,
                                                                                           long... pos)

Converts the given RandomAccessibleInterval to a BufferedImage.

Parameters:

source - The image to render.

xAxis - The image dimension to use for the X axis.

yAxis - The image dimension to use for the Y axis.

cAxis - The image dimension to use for compositing multiple channels, or -1 for no compositing.

scaling - Value scaling strategy; see NotebookService.ValueScaling.

pos - Dimensional position of the image. Passing null or the empty array will display the default (typically the first) position.

Returns:

BufferedImage representation.

bufferedImage

public static <T extends net.imglib2.type.numeric.RealType<T>> BufferedImage bufferedImage(net.imglib2.RandomAccessibleInterval<T> source,
                                                                                           int xAxis,
                                                                                           int yAxis,
                                                                                           int cAxis,
                                                                                           double[] min,
                                                                                           double[] max,
                                                                                           long... pos)

Converts the given RandomAccessibleInterval to a BufferedImage.

Parameters:

source - The image to render.

xAxis - The image dimension to use for the X axis.

yAxis - The image dimension to use for the Y axis.

cAxis - The image dimension to use for compositing multiple channels, or -1 for no compositing.

min - The minimum value per dimension allowed on the display

max - The maximum value per dimension allowed on the display

pos - Dimensional position of the image. Passing null or the empty array will display the default (typically the first) position.

Returns:

BufferedImage representation.