0% found this document useful (0 votes)
217 views21 pages

Java (TM) Advanced Imaging API

Answers to frequently asked questions (FAQ) provides brief answers to many common questions about the Java Advanced Imaging API. Many of the answers are derived from the jai-interest e-mail archive.
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
Download as pdf or txt
0% found this document useful (0 votes)
217 views21 pages

Java (TM) Advanced Imaging API

Answers to frequently asked questions (FAQ) provides brief answers to many common questions about the Java Advanced Imaging API. Many of the answers are derived from the jai-interest e-mail archive.
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
Download as pdf or txt
Download as pdf or txt
You are on page 1/ 21

Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

sun.com
http://java.sun.com/products/java-media/jai/forDevelopers/jaifaq.html May 09, 2011

FAQ
Java Advanced Imaging API

This collection of answers to frequently asked questions (FAQ) provides brief answers to many common questions about the
Java Advanced Imaging API. Please check here before posting a question to the jai-interest@java.sun.com mailing list.

Many of the answers are derived from the jai-interest e-mail archive. For legal reasons, sample code provided by users outside
Sun cannot be included in the FAQ. However, links to that sample code in the archives are included.

Question Index

General
What is the Java Advanced Imaging API?
Who needs the Java Advanced Imaging API?
What features will the Java Advanced Imaging API add to the Java 2 platform?
Is the Java Advanced Imaging API compatible with the Java 2D API?
What other APIs relate to the Java Advanced Imaging API?
How and when can I get the Java Advanced Imaging API?
Is the Java Advanced Imaging API 100% pure Java?
How can I determine whether an operation has a native acceleration method?
Will the Java Advanced Imaging API source code be made available?
Where can I get more information?
How can I unsubscribe from the jai-interest mailing list?
Why don't my messages to the jai-interest mailing list appear?
My question may already be answered in the mail archives - where are they?
Reporting problems to the jai-interest alias.
Where can I get the Java Advanced Imaging Tutorial?
Does Java Advanced Imaging work with JDK 1.1?

Technical

How many bands and how many bits per band are supported?
What data formats are supported?
What is the best to use for performance?
What is the Java Advanced Imaging API doing about performance?
What is "mediaLib" (or "mlib") in the Java Advanced Imaging API?
Does Java Advanced Imaging require native code?
How can I avoid s?
How can I control the amount of memory allocated to the tile cache?
How can I control the amount of memory allocated to the Java runtime?
Java Advanced Imaging appears to have a memory leak
What is the best way to display large images efficiently in the Java Advanced Imaging API?
When/where are tiles cached in the Java Advanced Imaging API?
My image is in color, but the Java Advanced Imaging API is telling me there's only 1 band!
On Solaris, Java Advanced Imaging complains about lack of access to an X server.
How can I use a BufferedImage as a source for a Java Advanced Imaging operation?
How can I use a from the AWT in Java Advanced Imaging?
How do I create a from an array of data?
How do I convert images between color spaces?
How do I convert any image (with any color model) to a 1 bit image (B&W)?
How does the image coordinate system work?
How are regions of interest (ROIs) used?
How do I tell when a Java Advanced Imaging operator is complete?
How do I create an overlay?
How do I convert an image with 10 or 12 bit color to 8 bit color?
How do I handle palette-color images?
How does Java Advanced Imaging handle image borders?
How do I convert an into a grayscale Image?
How can I perform convolution with a different kernel for each band?
Can I serialize a ?
How can I create and run an Applet?

1 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Where can I find an example of how to write a custom operator?

Bugs/Issues (see also the JAI bug page)

Why is my application crashing?

Platform

What platforms are supported?


Does Java Advanced Imaging run on my Macintosh?
When will Java Advanced Imaging be available for Linux?
Is there code which accelerates the image operators on some platforms?

Image I/O

What image file formats are supported? What limitations do these have?
How does Image File I/O relate to Java Advanced Imaging?
How do I load an image into Java Advanced Imaging?
How can I load a page of a multi-page TIFF file?
How do I save an image as a TIFF (or: BMP, JPEG, PNG, ...)?
Why can't I delete a file that I read in using the "FileLoad" operator?
How can I store float data?
Is there any way to know the extent of an image before loading the complete file?
I wrote a PNG image with transparency but it looks opaque in my browser.
How come Java Advanced Imaging can't read one of my image files?
Why won't a remote operation load my image file?
Why doesn't Java Advanced Imaging support my favorite file format?
How can I save space when using the BMP format?
How can I save the data displayed on a Canvas in a file?
Why don't certain operations with GIF source images function correctly?

Additional Code Samples


Add a transparency mask (alpha channel) to an image.
Scale an image or image region.
Retile an image.
Choose an image with a file dialog and load it into a
Convolve an image.
Combine multiple separate images into one multibanded image.
Load an image, do something to every pixel, and display the result.
Place one smaller Image within a larger template image into a pre-defined area.
Display a collection of images.

General

What is the Java Advanced Imaging API?


The Java Advanced Imaging API extends the Java 2 platform by allowing sophisticated, high-performance image processing
to be incorporated into Java applets and applications. It is a set of classes providing imaging functionality beyond that of Java
2D and the Java Foundation classes, though it is designed for compatibility with those APIs. This API implements a set of
core image processing capabilities including image tiling, regions of interest, deferred execution and a set of core image
processing operators, including many common point, area, and frequency domain operators.

Back to Question Index


Who needs the Java Advanced Imaging API?
The Java Advanced Imaging API is intended to meet the needs of technical (medical, seismological, remote sensing, etc.) as
well as commercial imaging (such as document production and photography). The API can benefit all Java developers who
want to incorporate imaging into their Java applets and applications.

Back to Question Index


What features does the Java Advanced Imaging API add to the Java 2 platform?
Rich set of functionality for digital imaging.
High level of extensibility to allow arbitrary processing capabilities.
Support for a wide variety of data types.
Deferred Execution.
Remote Imaging and truly distributed imaging.
Allow multiple implementations with different trade-offs of memory usage, operator optimization, and hardware

2 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

acceleration.

Back to Question Index


Is the Java Advanced Imaging API compatible with the Java 2D API?
Yes. Applications written using the Java 2D API are completely forward compatible with the Java Advanced Imaging API.

Back to Question Index


What other APIs relate to the Java Advanced Imaging API?
The Java Advanced Imaging API is part of the Java Media API suite that work together to provide customers with enhanced
graphics, imaging and communication capabilities. These APIs include: Java 2D for graphics, text, and fundamental image
manipulation; Java 3D; Image I/O; the Java Media Framework (JMF) for components to play and control time-based media
such as audio and video; Java Shared Data Toolkit; Java Sound; and Java Speech.

Back to Question Index


How and when can I get the Java Advanced Imaging API?
A 1.1.2_01 implementation of the Java Advanced Imaging API is available as a standard extension to the Java 2 platform from
the Java Advanced Imaging Website.

Back to Question Index


Is the Java Advanced Imaging API 100% pure Java?
The Java Advanced Imaging API may be run without any native code, i.e., without the code which provides native
acceleration. When run in this manner, the Java Advanced Imaging API uses only Java code. However, the Java Advanced
Imaging API has not yet been certified as meeting the requirements of the "100% Pure Java" Program per se.

Back to Question Index


How can I determine whether an operation has a native acceleration method?
The Java Advanced Imaging 1.1.2_01 README lists all the operations that have a native implementation (See section
"Operators").
If a native implementation is present it is, by default, the preferred implementation. But if the nature of the sources and
parameters of the operation are incompatible with the native operation then processing will revert to Java code. In general the
following minimum requirements must be adhered to for the mediaLib native implementation of an operation to be executed:

All sources must be s.


All sources and destination must have
a which is a and
a which is a or no (i.e., it is null).
All sources and the destination must have at most 4 bands of pixel data.
Further restrictions may be imposed by individual operations but the above are the most common requirements.

Back to Question Index

Will the source code for the Java Advanced Imaging API be made available?
The source code for the Java Advanced Imaging (JAI) API is not available at this time. We would however like to hear from
customers who might have an interest in obtaining the source code in the future. The exact mechanism by which the source
might be made available is at present undefined.

Back to Question Index


Where can I get more information?
A very good source of code snippets and discussions on more obscure topics in the Java Advanced Imaging API is the
jai-interest mail archive, at: http://archives.java.sun.com/archives/jai-interest.html

The latest API, programmers guide, and other available documents can be found at: http://java.sun.com/products/java-
media/jai/

Back to Question Index

How can I unsubscribe from the jai-interest mailing list?


To unsubscribe, send email to listserv@java.sun.com and include in the body of the message . For general
help, send email to listserv@java.sun.com and include "help" in the body of the message.

Back to Question Index


Why don't my messages to the jai-interest mailing list appear?
From time to time, in order to prevent unsolicited commercial messages ("spam") from appearing on the list, we may allow
postings only from list subscribers. If the email address from which you sent the message does not match your address as it

3 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

appears in the subscription list, your posting may be disallowed. If this happens to you, please send mail to
jai-comments@sun.com and we will attempt to rectify the situation.

The other situation where it may seem that postings to the jai-interest mailing list do not appear, it may be that the
subscription options for you are set to not send you a copy of your posting. To rectify this, send mail to listserv@java.sun.com
with the following as body of mail

SET jai-interest@java.sun.com MAIL SUBJECTHDR REPRO NOACK

Back to Question Index

My question may already be answered in the mail archives - where are they?
The jai-interest archives are available on line at:
http://archives.java.sun.com/archives/jai-interest.html

The archives are available directly, grouped by month, in reverse chronological order and, within each month, in alphabetical
order by subject. Messages appear in the archive almost immediately after being posted to the list.

A search tool is available for the archives. Access to it may be obtained via the page referred to above or directly here.

Before posting a message to the discussion list, please consider searching the archives to determine whether the topic has
already been addressed.

Back to Question Index

Reporting problems to the jai-interest alias.


Please scan this FAQ and the mail archives to see if your problem has already been addressed. If it hasn't, there are several
things you can do to increase the chances that we will be able to help you resolve your problem.
Please supply the simplest possible code that exhibits the problem if at all possible. A self-contained, compilable example is
best. Where this is not possible, as much context as you can give will be helpful.

For code that generates errors or exceptions, please use the Java command line option "-Djava.compiler=none" as this will
produce a stack trace with line numbers. These line numbers are important for us to locate the root cause of most bugs.

Back to Question Index

Where can I get the Java Advanced Imaging Tutorial?


The Java Advanced Imaging Tutorial is available for download at
http://java.sun.com/products/javamedia/jai (Click Download)

This tutorial is an interactive Java application that uses the Java Advanced Imaging API to showcase real-world imaging
examples, that run as a part of the tutorial. It will help you rapidly create new applications using Java Advanced Imaging.

Back to Question Index

Does Java Advanced Imaging work with JDK 1.1?


No. You need the Java 2 platform (a/k/a JDK 1.2). Specifically, Java Advanced Imaging 1.1.2_01 requires the Java 2 platform,
version 1.3 or higher.

Back to Question Index

Technical

How many bands and how many bits per band are supported?
The Java 2D and Java Advanced Imaging APIs support:
up to 32 bits for integral data
32 and 64 bit (float and double) floating-point data
any number of bands
Users may define their own custom classes to support other data types.

Back to Question Index


What data formats are supported?
The Java Advanced Imaging API supports unsigned byte, signed and unsigned short (Java 2 only partially supports signed
short), int, float, and double data types. Complex numbers are represented using two bands, one for the real and one for the

4 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

imaginary portion of each sample. Certain operators require the use of an integral data type (not float or double), e.g., table
lookup and bitwise logical operators.

Back to Question Index


What is the best to use for performance?
Fastest processing performance will be achieved when the is composed of a and a
type that is supported by native acceleration for the operations of interest. The arrays of all sources
and the destinations should match.

Back to Question Index


What is the Java Advanced Imaging API doing about performance?
An optional C-based library for Win32, Solaris and Linux provides performance enhancements for many operators. This
library is called mediaLib.
Additional hardware optimization on UltraSPARC running Solaris is achieved using the VIS Instruction Set. Additional
hardware optimization on the Intel x86 architecture is achieved using MMX.

Back to Question Index

What is "mediaLib" (or "mlib") in the Java Advanced Imaging API?


mediaLib is a Sun-developed high-performance image processing library. The reference implementation of the Java
Advanced Imaging API makes use of a special version of mediaLib which is a subset of mediaLib 2.0 and includes a JNI
wrapper. For more information on mediaLib 2.0, see:
http://www.sun.com/sparc/vis/mediaLib.html

On those Win32 platforms which support MMX, Java Advanced Imaging uses a version of mediaLib containing MMX
instructions for acceleration. For those Win32 and Solaris/Intel platforms where MMX is not supported, Java Advanced
Imaging uses a pure C version of mediaLib. On Solaris/SPARC platforms, it uses a version containing VIS instructions for
acceleration. On the Linux platform, it uses a pure C version of medialib. The use of mediaLib is not essential to the design of
the Java Advanced Imaging API; other native platform-specific libraries could be integrated in the future.

Back to Question Index

Does Java Advanced Imaging require native code?


No. Native code is supplied for performance purposes only. A C library is supplied for SPARC, Linux and Intel x86 platforms
which accelerates most of the operators. In addition there is a lower level SPARC library (VIS) and a MMX library allowing
additional hardware acceleration for many operators. If Java Advanced Imaging code does not find these libraries, pure Java
code is used.

Back to Question Index

How can I avoid s?


There are several possible reasons for an application to produce an
A common reason is a failure to specify enough memory for the Java virtual machine (JVM) at application startup time.
Regardless of how much physical and virtual memory is available on your system, the Java runtime will only allocate a fixed
amount, which is determined when the Java Virtual Machine (JVM) starts up. How to allocate more memory to the JVM is
discussed below.

JAI creates a object to store computed portions of images. By default, the cache size is allowed to store up to 16
megabytes of image data. Therefore the JVM should generally be started up with a size larger than this. The actual memory
requirements depend on many factors such as the sizes of the images being used and how many operations are used to
produce an output image. A setting of , giving 128 megabytes of (virtual) memory to the JVM is a reasonable
starting value. Alternatively, you can specify the size of the tile cache yourself with the
method.

Another possible cause of excessive memory use is the use of tile sizes which are too large. By default, images inherit their
tile size from their source, i.e. the previous image in a chain. If the tile size is large, more data may be generated than required
by an operation. You can specify a smaller tile size for use by an image by creating an object, setting its tile size
fields and passing it to the call via a object.

You might also consider adjusting the capacity of the tile cache being used for your particular instance of Java Advanced
Imaging. The cache to use for a specific operation may also be specified via the . For all operations, a tile is
not calculated until a region of the image overlapping the tile is requested. To save re-computation, the resulting tiles are
stored in a cache. When the cache runs out of memory it removes tiles until it has enough memory to store the new tiles. For
example, if you are scrolling an image you might scroll to one area and then back to the original area. Tiles required in the
original area might have been flushed from the cache in the intervening time, thereby necessitating their recalculation. By

5 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

allowing recalculation to take place, there is no need to store all of the computed tiles permanently.

The most efficient storage of image data in RAM will be accomplished when the images are tiled and those tiles which are not
currently needed are flushed from memory. The deferred execution architecture of the operation chain attempts to process
only the tiles that it must. The tile cache attempts to flush those tiles which are no longer needed. These two facilities working
in tandem attempt to provide a reasonable tradeoff between memory use and computation.

The operation chain itself does not, however, handle the way image data are managed in the source and sink portions of the
chain as this cannot always be controlled by the API itself. For example, if the image source is a file which is not tiled, then the
entire image will be loaded. If a tiled source image file is used (e.g., tiled TIFF or FlashPIX), then only those tiles required to
execute the operation chain will be read from the disk.

Similarly, at the data sink end of a chain, e.g., the display, if the entire image is requested and held in memory then that will
provoke computation of all tiles in all intermediate operations in the chain and consequently reading of the entire image from
disk. The data sink will be most efficient if it requests only those tiles that it needs and uses some kind of efficient algorithm
for disposing of the destination tiles that it does not need, e.g., those neither being displayed nor adjacent to tiles being
displayed.

To reduce RAM usage even further you also have the option of implementing your own tile cache which uses an alternate
type of backing storage for the tiles in the cache, e.g., a disk file or a database. Such an approach may lower execution
speed in some cases but there are always tradeoffs. There is also a mechanism to replace the "Least Recently Used"
algorithm with a custom implementation via the tile cache metric and tile comparator features.

When images with non-standard bit depths (e.g., 1 or 2 bits per sample) are processed, some JAI operators may perform
temporary expansion to an 8 bit per sample format. This may require excessive memory in some cases. This behavior was
particularly pronounced in the 1.0.2 release; the 1.1 and later releases are significantly more efficient when performing scale,
rotate, affine, and transpose operations on 1-bit images.

In JAI 1.0.2, tiles were only removed from the Tile Cache when the cache became full. At this point, tiles were released from
memory until 25% of the memory was freed. As of JAI 1.1 and later, tiles can also be released if no "hard references" to the
tiles remain. This can occur for example, if an operation goes "out of scope". JAI 1.1 also checks for OutOfMemoryErrors
when requesting tiles, and if one occurs, tiles will be released from the cache and the compute request will be reissued. This
has significantly reduced OutOfMemoryError conditions in applications. Applications should still check for OutOfMemoryError
conditions because other portions of a program can trigger these independent of JAI.

Some improvements were made in JAI 1.1.1 to reduce memory related exceptions while loading image files that may have
been noticed with previous JAI versions.

Back to Question Index

How can I control the amount of memory allocated to the tile cache?
You may obtain a reference to the default tile cache and call its method, supplying the cache capacity in
bytes:

Back to Question Index


How can I control the amount of memory allocated to the Java runtime?
It may be necessary to set the maximum size of the memory allocation pool of the Java interpreter using the command
line option. This is particularly important if you are attempting to work with large, untiled imagery.
<size>
Sets the maximum size of the memory allocation pool (the garbage collected heap) to <size>. The default is 1
megabyte of memory. The size must be at least 1000 bytes.
By default, the size is measured in bytes. To specify the size in either kilobytes or megabytes, append "k" for
kilobytes or "m" for megabytes.

<size>
Sets the startup size of the memory allocation pool (the garbage collected heap) to <size>. The default is 4
megabytes of memory. The size must be at least 1000 bytes and must be less than or equal to the maximum
memory size (as specified by the option).
By default, the size is measured in bytes. To specify the size in either kilobytes or megabytes, append "k" for
kilobytes or "m" for megabytes.

6 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Back to Question Index


Java Advanced Imaging appears to have a memory leak.
While it is certainly possible that a bug in either the Java runtime or the implementation of the Java Advanced Imaging API
itself could cause a memory leak, in most cases what appears to be a memory leak is simply the result of a temporary
demand for more memory than is available from the Java runtime. A true memory leak implies that an ever-increasing amount
of memory will be required by the application; an application that requests a large amount of memory but will eventually
release it may be inefficient but cannot truly be said to exhibit a memory leak. The JAI 1.0.2 implementation of the tile cache
allowed the cache to fill completely before releasing tiles, giving the impression of an increasing consumption of memory. JAI
1.1 allows tiles to be released when there are no longer any "hard references" to the operation objects.

Back to Question Index


What is the best way to display large images efficiently in the Java Advanced Imaging
API?
In general, the proper use of tiling is the easiest way to limit the amount of work done. Setting the tile sizes will be very
application-dependent. The Java Advanced Imaging API will perform work on a per-tile basis. If the final operator in a chain
requires a certain source rectangle to be computed, the actual computation may extend past the actual area needed, up to
the next set of tile boundaries.
Experiments have shown that tile sizes of 512x512 and larger appear to be the most efficient.

Back to Question Index

When/where are tiles cached in the Java Advanced Imaging API?


The only place where caching takes place automatically is in the method . So if you subclass from
and override the or methods, but not the method (or you override but call the
superclass method somehow), you get caching automatically. Otherwise, you don't. You can construct your own
implementations of the interface or use the factory method in the class and insert tiles manually, or you can
construct a around your image which will perform caching.
If you're using an subclass, but don't want caching, you can call:

Back to Question Index


My image is in color, but the Java Advanced Imaging API is telling me there's only 1
band!
A RenderedImage has a and a . The describes the pixel data the image has and how
it is stored in the buffer. The interprets the pixel data in a specific . The color definition of a particular
band of the pixel is dependent on the and its associated . Without a , the pixel data of an
image has no color definition.
Your image may have an . In this case, the image data is stored in a 1-banded form, and the is
used to determine the red, green, blue, and optional alpha values for each pixel. The will
automatically cause such images to appear to have 3 or 4 bands as appropriate.

Back to Question Index

On Solaris, Java Advanced Imaging complains about lack of access to an X server.


Java Advanced Imaging versions previous to JAI 1.1.1 used the AWT toolkit to load GIF and JPEG files. This problem is a
manifestation of a JDK bug in which creation of the AWT class results in an attempt to open the X display. To work
around this problem in Java Advanced Imaging versions prior to 1.1.1, either make an X display available to the Java runtime
using the environment variable (no windows will appear on the display), or consider running a dummy X server that
will satisfy the AWT, such as the utility included with the X11R6.4 distribution.

In the JAI 1.1.1 version, the GIF and JPEG decoders were improved to no longer have a dependency on the X server.

Back to Question Index

How can I use a BufferedImage as a source for a Java Advanced Imaging operation?
A may be used directly as a source to any Java Advanced Imaging operator or method that calls for a
or source or sources.

Back to Question Index

7 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

How can I use a from the AWT in Java Advanced Imaging?


This code sample reads a GIF or JPEG file using the class into a , converts the AWT-Image
into a in JAI, then displays the .
You can also do this in Java2D. Use a to ensure the image is loaded, get its width and height and create a
with the right dimensions. Then call on the and then call on the
returned , passing it the . Now you have a containing your image data. A
is an instance of , so you can pass it to any Java Advanced Imaging interface that calls for a
.

An example of creating an image from float data can be found here.

Back to Question Index

How do I create a from an array of data?


The steps to do this are:

1. Construct a from your data array.


2. Construct a describing the data layout.

3. Construct a from the and . You can use methods from the class to do
this.

4. Construct a which describes your data. The factory method


will take care of this for some common cases.

5. Construct a with the and

6. Populate the with your data by using the method to copy your raster into the
TiledImage.

Only the last step involves any actual processing. The rest is just object creation.

Alternatively, a may be constructed directly from the and . The


class may then be used to produce a from the . This approach avoids copying entirely.

Sample code to make a out of a 2D array of floats can be found here.

Back to Question Index

How do I convert images between color spaces?


The Java 2 platform (JDK 1.2 and later) contains a Kodak color management engine which uses ICC profiles for conversion.
You will need to provide the ICC profiles in a form from which you can create a object. The
can then be used to create a , which can be used to create a that can
be supplied to the JAI "colorconvert" operation. If you use the "colorconvert" operation in this manner, and the
of the source image (and thus the resultant destination image) is not compatible with the being specified to the
"colorconvert" operation, then you should also provide an appropriate in an object passed as a
. The should be compatible with the provided.
ICC profiles for the following color spaces may be downloaded here.

CMY
CMYK
YCbCr based on REC 601
YCbCr linear based on REC 601
YCbCr based on REC 701
YCbCr linear based on REC 709
Linear Y part of YCbCr for Color Conversion Support

Back to Question Index


How do I convert any image (with any color model) to a 1 bit image (B&W)?
Use one of the dither operators -- either OrderedDither (fast) or ErrorDiffusion (slower, but higher quality).
First, convert the image to a luminance (grayscale) image and then dither it. You can convert to a grayscale space using the
operator:

8 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

For simple linear conversions to grayscale, the "bandcombine" operator could also be used.

The dither operation needs to have a lookup table that converts any values less than half the grayscale range to zero and
any values above half the range to one. The dither operation will automatically vary the threshold to minimize any contouring
effects. Here is some sample code that illustrates using the "errordiffusion" and "ordereddither" operations for dithering a
grayscale image to a monochrome (1-bit or bilevel) image.

An alternative to dithering for converting an 8-bit grayscale image to a 1-bit monochrome image is simply to apply a threshold
to the image. The "Binarize" operation may be used for this purpose. A threshold may be derived by first creating a Histogram
using the "Histogram" operation and then calculating the threshold using one of several methods:

This code example demonstrates how "binarize" operation can be used to apply the threshold.

Back to Question Index


How does the image coordinate system work?
A occupies an arbitrary rectangular area in the 2D plane. Note that, as in the Java 2D API, the Y axis values
increase from top to bottom.

Consider this annoted image:

The coordinates of the upper-left corner of the image appears at the point given by the and methods.
The width and height of the image are obtained similarly using the and methods. In the illustration, the
image starts at pixel (-100, -90) and has a width of 330 pixels and height of 215 pixels. The lower right pixel of the image is
thus (229, 124). As shown here, the image location is not restricted to the positive quadrant.

Overlayed on the image is its tile grid. Each tile contains a rectangular portion of the image; all tiles have the same width and
height and tiles do not overlap. Tiles are referenced by a pair of indices, i.e., tile (2, 3) is to the right and below tile (1, 2).
Tiles may extend past the edges of the image. The contents of the portion outside the image are undefined. Only tiles that
have some overlap with the image bounds can be obtained by calling . Attempts to retrieve any other tiles will result in
a return value of

The semantics of an image never depend on the layout of its tile grid layout, but performance maybe affected by the choice of

9 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

tile size and offsets. The tile grid is defined by the four methods , ,
and . The first two methods yield the position of the upper-left corner of a notional tile (0, 0). The image need
not actually contain such a tile. For example, the tile grid of the image illustrated above may renumbered so that the upper left
tile has index (-1, -3) and the lower right tile has index (2, -1):

The image doesn't contain a (0, 0) tile at all, and the pixel ( , ) does not even fall
within the image. Both images should act exactly identically when used as a source for all JAI operations except possibly for
the output tile grid layout.

The minimum and maximum tile indices may be derived by determining the tile indices of the upper left and lower right pixels
of the image. To determine the tile index of a given point, the following methods (available in the class) may be
used:

It is not sufficent to compute since this will produce the wrong result for negative indices.
Instead, it is necessary to compute the equivalent of . The code above
produces the same results using integer arithmetic only.
Most often, images loaded from external sources will have their minimum X and Y and tile grid X and Y offsets all equal to
zero. As operations are performed, however, such as scaling, rotation or translation, the coordinates of the resultant images
will change.

On a more microscopic level, pixels in a may be thought of as squares with a 1 x 1 extent centered at (x +
0.5, y + 0.5). Geometric mapping operations may need to take this half pixel shift into account.

Unlike the coordinate system, which is discrete, the coordinate system is continuous. The
image dimensions are described in terms of floating-point miniumum X and Y coordinates, a height, and an aspect ratio. For
the "renderable" operation, you supply the height in the renderable coordinate space and the aspect ratio is derived
automatically from the ratio of the source image width to its height (width/height) in the rendered image coordinate system.

When a is rendered, an is applied to map its coordinate system into the rendered pixel
coordinate system which is appropriate to a target device such as a display, printer, file, etc. You have to specify the
appropriate transformation.

10 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Back to Question Index

How are regions of interest (ROIs) used?


At this time ROIs are used in Java Advanced Imaging for three purposes:

To delimit the area of data to be initialized in the and methods.


To specify the region to be considered in calculating image statistics such as mean, extrema, and histogram.
As meta-data which are associated with images via properties.
In the latter case ROIs may be geometrically transformed or "shrunk" by operators in an image chain but otherwise are
ignored (this geometric modification of the ROI occurs in parallel with the actual image processing operations). In no case
other than the statistics operations does the presence of a ROI affect the operation per se.

One way that you might be able to subtract regions in two images defined by a ROI is as follows:

Set up an image chain to calculate the overall difference image.


Intersect the two ROIs.
Determine the bounding box of the intersection.
Create a covering the area of the bounding box.
Extract from the difference image a of data over the bounding box.
Use with the of the previous step and the bounding box to set the data of the .
Note that the only tiles which will be calculated in the difference image are those which overlap the bounding box of the
intersection of the two ROIs. Thus if you are using tiled source and destination images computation will be minimized.

Back to Question Index

How can I tell when a Java Advanced Imaging operator is complete?


Normally, the deferred execution model makes the notion of "completing" the computation of an image meaningless. Images
are computed a tile at a time, and tiles may be computed multiple times if the tile cache is unable to reserve storage for them.
However, in some cases such as perfomance benchmarking you may wish to force an image to be computed in its entirety.
is a convenience method which effectively does the following:

Validates the sources and parameters of the operations according to the specification of the associated

Inserts a node into the imaging chain.


No actual computation of image data will occur until data is requested from a node in the chain unless the
method of the associated returns . In this case, the chain will be evaluated as soon as the node is
appended to the chain. Otherwise, you can force a chain to be evaluated up to a given node by invoking on
the of that node. This will force evaluation of the entire chain up to and including that node.

Even at this point, actual tile data will not necessarily have been computed. A loop such as the following may be used to force
actual tile computation:

Note that if you wish to measure the execution time of a given node you will need to force computation on its source nodes
first to exclude their evaluation time from the measurement. The tile caching should also be disabled.

Back to Question Index

How do I create an overlay?


As indicated in the specification of the "overlay" operator, it puts one on top of another . To
use this operator, two source s are needed; call them src1 and src2. Then to create an "overlay" op, you
simply do:

11 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

The result dst will have src2 on the top and src1 on the bottom. The part of src1 covered by src2 will not be seen. The image
layout (width, height, etc.) of dst is copied from src1.

One constraint is that src1 and src2 must have the same data type and number of bands, or the library will throw an
.

The position of src2 is based on its minimum X and Y. If you wish to move src2 to a different location, you must do a
"translate" operation on src2 first, and overlay the translated image on src1.

If src2 is bigger than src1, it may cover the entire src1 and you'll only see part of src2 as a result (since dst has the
dimensions of src1). To increase the dimensions of an image, the "border" operation may be used.

Back to Question Index

How do I convert an image with 10 or 12 bit color to 8 bit color?


The most direct approach is to use the "lookup" operator to map your 10 or 12 bit data to 8-bit values. If you just want to do
simple range conversion, then, for 12 bit data the lookup table's data can be created by:

A refinement of this is to apply a linear "contrast stretch" (really a brightness adjustment) by mapping the min and max values
in the 12 bit image to 0 and 255 in the 8 bit image. (Note that we're cheating here and stuffing values we're interpreting as
unsigned into Java's signed byte type).
You can determine the min/max using Extrema operator. You will normally want to choose the min of all bands as the
minimum, and likewise for the max. Doing it band by band will cause color shifts. Of course, if the imagery is false color, you
may not care.

You then create the table by:

You may find that these approaches sacrifice too much detail at the low radiance end of the scale. Frequently a non-linear
transformation is needed, usually somewhere between square-root and cube-root.

Back to Question Index


How do I handle palette-color images?
This type of image, e.g., one derived from a TIFF palette-color file, will have a that is an instance of
. In general, if the of the source image is an but that of the destination is not,
then the source image is temporarily "expanded" during processing to the number of bands indicated by the
(which is the same as the number returned by ).
The destination is either specified by an object passed in via the parameter to
or it is derived from the of the (first) source image: a "best guess" is constructed for the
destination by passing the source to . If source data are not expanded, it is
assumed that the operation in question will apply any special handling needed when it encounters an case.
If it does not specially handle such a case then the raster data will be treated as grayscale (note that if a is

12 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

specified via the it is incumbent on the user to ensure that it will be compatible with the destination
).

Some operations perform processing on the colormap, effectively changing the colormap and not performing any pixel
manipulation. This behavior is accomplished by the operations being subclasses of . The
operations which are implemented as subclasses of ColormapOpImage are "addConst", "andConst", "divideIntoConst", "exp",
"invert", "log", "lookup", "multiplyConst", "not", "orConst", "piecewise", "rescale", "subtractFromConst", "threshold" and
"xorConst".

As of JAI 1.1.2, a new specifies whether processing should take


place on the colormap, or on the pixel (index) data for those operations that are implemented as subclasses of
. By default, a node has a hint with a value of , which
means the processing is done on the colormap, and not on the indices. To suppress this behavior, a hint with a value of
should be attached to the node.

Other operations, like "translate" (with integral translation factors) and "crop" operations do not actually perform any
processing of the data: they effectively forward tile requests on to the source image.

As of JAI 1.1.2, a new has been provided that allows for


automatic color translation for colormapped imagery in those situations where not doing so would result in unexpected /
incorrect results (such as geometric operations). Operations that are implemented as subclasses of
and set this RenderingHint to true, such that these
operations are performed correctly on the colormapped imagery, not treating the indices into the color map as pixel data.
These operations are listed in the The Java Advanced Imaging 1.1.2 README

One of the common uses of the format operator is to cast the pixel values of an image to a given data type. In such a case,
since JAI 1.1.2, the format operation adds a object for with the
value of , if the source image provided has an . Due to the addition of this new
, using the "format" operation with source(s) that have an will cause the destination to have
an expanded non- . This expansion ensures that the conversion to a different data type,
or happens correctly such that the indices into the color map (for images) are not
treated as pixel data.

One further thing to note is that even if you pass in an via the this will not change the way in
which the image data per se are handled, although you might be able to display the result. For those operations that are not
subclasses of ColormapOpImage, or where color translation is not being performed through the use of
, the image data will still be processed as if they represent grayscale data.

Sometimes it might be useful to convert the palette-color images into RGB images at the beginning of the processing. One
way to expand the palette-color images is by inserting a "format" operation which changes the , thereby forcing
expansion. (Note that as mentioned "crop" and integral translation merely forward the tile requests to the source so you can't
expand the data via those operations.) Obviously expanding the palette-color data to RGB will increase the memory footprint
but this way you are assured of obtaining a valid result.

Probably the best means of converting a palette-color image to a 3-band RGB image is to use the "lookup" operation. You
can construct the lookup table using values returned by the getBlues()/getGreens()/getReds() methods of
the method should tell you the number of elements in the lookup table. This code example shows how to
perform the conversion.

Back to Question Index

How does Java Advanced Imaging API handle image borders?


Java Advanced Imaging API's "border" operation and classes are capable of extending an image outward for
a specified number of pixels in various ways. This is used mainly for geometric operations where interpolation is needed.
To display an image with a decorative border, the Swing toolkit supports several kinds of borders in
package. For some applications, you may want to use an (found in the sample directory) to display the image, then
add a Swing border to it.

The Java Advanced Imaging API does not have a "drop shadow" or similar special effect operator as found in some imaging
software. Such an effect could be created by overlaying an image over a modified version of itself to produce a 3D look.

Back to Question Index

How do I convert an into a grayscale image?


A method to convert an CS_sRGB into a grayscale Image (CS_GRAY) can be found here.

Back to Question Index

13 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

How can I perform convolution with a different kernel for each band?
If you intend to convolve all bands of a given multi-band image (the common case) with the same kernel then you can use the
"convolve" operation as is. If however you would like to convolve each band of a multi-band image with a different kernel then
you would need to extract each band, e.g., using "bandselect", apply the appropriate convolution kernel to each band using
"convolve", and then merge the separate filtered bands into a resultant multi-band image.
If you are attempting to do some sort of multispectral template matching however, the above scenario might not be what you
want. In that case, you could use single-band convolution by, for example, first converting the images to a different color
space such as HIS or YCC and perform the template matching using the intensity or luminance band.

Back to Question Index

Can I serialize a ?
A may not be serialized directly as it does not implement the interface. You may however
construct a from a . See the
documentation for more information. Alternatively, if a suitable external file format exists the interfaces may be
useful.

Back to Question Index


How can I create and run an Applet?
In order to use Java Advanced Imaging in a browser environment, your applet HTML file should be converted with the Java
Plug-in HTMLConverter (now sits in the JDK 1.3.1 and JDK 1.4 bin directories). The Java Plug-in (now part of JRE/JDK 1.3.1
and 1.4) and JAI configuration requirements are as follows:

Install the Java Plugin for your architecture (Solaris, Windows, etc.). The Java Plug-in is available from the Java Plug-in
download page. The Plug-in is now part of the JRE. Follow the links to download the plugins and patches for the
platform of your choice. There are also pointers to a FAQ, Documentation and other relevant information at this site.

Follow the Java Plug-in Browser Registration Instructions for the platform of your choice

Solaris Browser Registration Instructions


Linux Browser Registration Instructions
Windows Browser Registration Instructions. Look for the section on running Netscape 7.x/Mozilla 1.x with Java
Plug-in.

Once the Java Plug-in is registered with the browser, download the JAI JRE installation executable
On Solaris: jai-1_1_2_01-lib-solaris-sparc-jre.bin
On Linux: jai-1_1_2_01-lib-linux-i586-jre.bin
On Windows: jai-1_1_2_01-lib-windows-i586-jre.exe

Follow the installation instruction to install JRE version of JAI into the Java Plugin just installed.

After JAI is installed in the manner described above, certain permissions may need to be added to the

Java policy file

Or user java policy file

On Solaris:

$HOME/.java.policy
On Windows (NT, for example)

C:\WINNT\Profiles\$User\.java.policy
The permissions needed to be added are:

On solaris:

On Windows:

14 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

If the users encode images in the applet, the applet may write to some temporary file. If the users don't encode images in
the applet, no permission is needed on Windows. As mentioned above, on Solaris, the user still needs to grant execute
permission to /usr/bin/uname on Solaris.

The above steps will make sure the JAI files are picked up by the Plugin at runtime.

An example html file to run the applet is here.

Applets can also utilize the Auto Installation capabilities provided by Java Plugin (JPI) including Java extension deployment to
facilitate applet deployment. For details please refer to the The Java Advanced Imaging Installation Instructions.

Back to Question Index

Where can I find an example of how to write a custom operator?


Let's say I want to create a new operator called the 2D Fourier Transform operator.
Operations which are to be created using JAI.create() must be registered with the default OperationRegistry. They can also be
automatically detected and registered by listing it in a registry file (META-INF/registryFile.jai) which is often contained in a jar file
with the user's other class files (see the javadoc for OperationRegistry and OperationRegistrySpi classes for more information).
Each operation has an (denoted "descriptor" in the registry file) which provides a textual description of the
operation and specifies the number and type of its sources and parameters. The also specifies the
supported operation modes ("rendered", "renderable", "collection" etc.). Rendered and renderable mode correspond to
resolution-dependent and resolution-independent operations, respectively. For more information on these concepts please refer
to the Java Advanced Imaging Programmer's Guide available via the Java Advanced Imaging home page.

For each there should also be at least one of either a (RIF) or


(CRIF). The RIF is for rendered mode operations only; the CRIF can handle operations which
function only in renderable mode or in both rendered and renderable modes. The RIFs and CRIFs have entries in the registry
file denoted "rendered" and "renderable", respectively. Preferences for RIFs may also be set in the registry file.

In most of the reference port operation implementations there is also eventually an implementation class which is a descendent
of . For example, it may be a subclass of , , etc., as appropriate. The RIF or CRIF is
responsible for creating an instance of this class. It is possible for a RIF to instantiate different implementation classes
depending on the types of the sources and parameters. It is also possible for multiple RIFs to instantiate the same
implementation class (e.g., "rotate" and "affine" operators might share a common implementation). A RIF may even instantiate a
chain of several connected objects.

What happens when is invoked is as follows:

1. The for the operation in question will be retrieved from the registry.

2. The source(s) and parameter(s) will be checked for compatibility with the operation as defined by the

3. A is created for the given operation. The contains the name of the operation, the sources and
parameters and any rendering hints, but no actual image data until it is rendered as the result of a call to methods such as
, or .

When the is eventually rendered, the following occurs:

1. The registry method is called using the information stored in the .

2. The registry creates a list of RIFs for this operation in the preferred order and invokes the method of each RIF in
sequence; the first non- returned value is the result of the operation.

3. When the method of a RIF is invoked it is responsible for returning an instance of (usually an
subclass) created for this operation.

A similar sequence of events occurs for renderable mode operations using

In summary, to create a new operation you need to do the following:

1. Create an subclass for your operation.


2. Create a RIF or CRIF as appropriate.
3. Create an

15 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

4. Register your operation descriptor, RIF/CRIF, and preferences if appropriate with the .

It is recommended that the user create a (and include it in the jar file or the classpath) and add the
necessary entries in that file to register the new operator, the image factories for each supported mode and preferences if any.
To avoid the hassles involved in creating a separate file, it is possible to register s and
RIFs/CRIFs, using the 's and / methods. After this
registering (and setting of preferences, if desired), the new operation can then be invoked through . Of course, the
drawback of this is that the new operator will not be automatically reloaded every time a Java Advanced Imaging program is
executed, since it is not present in . So, in order to use it, the registry methods would always have to be invoked
beforehand.

An example of how to use the 's methods to register a descriptor and it's image factories :

Aids to writing your own codec can be found in the Programmer's Guide, section 14.5 and the PNM code supplied with the
sample demo.

Back to Question Index

Bugs/Issues

Why is my application crashing?


If you encounter JVM crashes or exceptions that you believe are not the fault of your code, please send a description of the
problem and any available program output to jai-comments@sun.com Please specify your hardware configuration and JVM
version (as reported by ). If you are sending in a stack trace from an exception, please run Java with the
flag so that line numbers appear in the stack trace output.

Back to Question Index

Platform

What platforms are supported?


The Java Advanced Imaging API should run on the Java 2 Platform, Standard Edition version 1.3 and higher. The Java 2
Platform is available for Win32, Solaris, Linux, IBM-AIX, Mac OS X and Digital Unix.
However, Java Advanced Imaging has only been tested on Win32, Solaris, and Linux (Red Hat 6.1 JVM) Java 2 platforms.
Please check the Java 2 Website for the latest porting information. Native performance enhancements for the Java Advanced
Imaging API are currently available for Windows, Solaris and Linux. Java Advanced Imaging should work without native
performance enhancements for other platforms, however this usage is unsupported.

Back to Question Index

16 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Does Java Advanced Imaging run on my Macintosh?


Yes - Apple supports Java Advanced Imaging on the Mac. For details and downloads, please visit Java 3D and Java Advanced
Imaging Update.

Back to Question Index


When will Java Advanced Imaging be available for Linux?
The Java Advanced Imaging API implementation is now available for Linux. It can be downloaded from http://java.sun.com
/products/javamedia/jai/downloads/download.html

Back to Question Index


Is there code which accelerates the image operators on some platforms?
A C library is supplied for sparc, linux and intel which accelerates most of the operators. In addition there is a lower level sparc
library and an MMX enabled library allowing additional hardware acceleration for many operators. If Java Advanced Imaging
code does not find these libraries, pure java code is used.

Back to Question Index

Image I/O

What image file formats are supported? What limitations do these have?
The codec classes supplied with Java Advanced Imaging 1.1.2_01 support BMP, GIF (read only), FlashPix (read only), JPEG,
PNG, PNM, TIFF, and WBMP.
Please note the codec classes are not a committed part of the Java Advanced Imaging API, and that there is a separate Java
Image File I/O package. For more information on Image I/O in JAI please refer to Image I/O in Java Advanced Imaging.

The two file formats which support short integer (16-bit) data in the file I/O package supplied with Java Advanced Imaging
1.1.2_01 are Portable Network Graphics (PNG) and TIFF. There is support in the codec APIs for reading multi-image files, and
the TIFF codec was enhanced in 1.1 to support both reading and writing of multi-image files. Below are some answers to
common format-specific questions.

TIFF
The documentation incorrectly showed an example of using the "tiff" operator in renderable mode; all codecs operate in the
rendered mode only. You can do a followed by a to get a
renderable source based on an image file.

Limitations of the TIFF codec in 1.1.2_01:

LZW compressed format (encoding) is not supported for the usual reason.
Planar format (PlanarConfiguration field has value 2) is not supported for decoding or encoding.
The TIFF reader reads only the tiles which overlap the data rectangle requested by operations which are "downstream" in
the imaging chain. Consequently for tiled TIFF the tiles are not read from the TIFF disk image until such time as their
geometric region is needed to complete processing of the chain for which they are the data source. If tiles have been
previously loaded but have since been flushed from the cache then they will of course need to be reloaded.

BMP
The Windows 95 version of BMP is supported. The bit depth of the output when saving a BMP will be determined by that
of the source image.

GIF
As of JAI 1.1.1, the JAI GIF decoder is no longer implemented by calling into the AWT Toolkit. The new implementation of
the JAI GIF decoder correctly handles images with transparent backgrounds.

GIF encoding is problematic due to active patents. See the jai-interest mail archive for possible solutions.

PNG
PNG is fully implemented. The type of the encoded image (RGB, Greyscale, or Palette) is determined by the type of the
image being saved, not by the choice of subclass.

JPEG
The JPEG support is currently implemented on top of the unofficial JDK classes in the package,
which may not exist in all Java 2 environments.

FlashPix
FlashPIX reading is only partially implemented. There is no FlashPIX writer. Tiles of FlashPIX images are read only when

17 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

required.

The Java Advanced Imaging API includes an extention interface allowing third parties to provide their favorite file format
handling. Some of the file formats which have been requested and which we encourage third parties to provide are FITS, NITF,
DICOM, EPS, RDF, or other vector formats.

Back to Question Index

How does Image File I/O relate to the Java Advanced Imaging API?
Please refer to http://java.sun.com/products/javamedia/jai/iio.html

Back to Question Index


How do I load an image into Java Advanced Imaging?
The easiest way to load a local image file stored in TIFF or any other supported image file format is to use the "fileload"
operation as follows:

Or, using to produce a :

Back to Question Index


How can I load a page of a multi-page TIFF file?
A code sample is included here to show one method of loading a page of a multi-page TIFF file. Within the JAI API a "page"
parameter was added to the "TIFF" operator to simplify this procedure.

Back to Question Index


How do I save an image as a TIFF (or: BMP, JPEG, PNG, ...)?
Use the "filestore" operator:

Back to Question Index


Why can't I delete a file that I read in using the "FileLoad" operator?
The "FileLoad" operator is merely a wrapper for what is effected by the "Stream" operator. While the "FileLoad" operator saves
the user having to create the stream, it has a side effect. This is that the stream has to have a reference that is held by the
"FileLoad" operator as long as there is a possibility that the data might be read. Only when data will no longer be read, can the
stream be released. This means that as long as the stream is held the file will be locked. It is this locking of the file that prevents
the file from being deleted, till the reference to the stream is released. Since the reference to the stream will be held until the
internal objects created by the "FileLoad" operator are garbage-collected, the two options to allow the file to be deleted are:
Ensuring that all references to the "FileLoad" operation result are nullified and then invoking the garbage collector.
Using the "Stream" operator instead of the "FileLoad" and having the application manage the stream closing.

It should be noted, if using the first option listed above, that since there are no requirements on the Java VM for when it actually
releases objects no longer referenced, there's no guarantee that invoking the garbage collector will actually cause the objects to
be garbage-collected. Thus the second option listed above is the better method.

Back to Question Index


How can I store float data?
Currently the only supported image format which possesses the ability to store float data at all is TIFF. The capability of writing
out float data to a TIFF format has been added in Java Advanced Imaging 1.1.

Back to Question Index


Is there any way to know the extent of an image before loading the complete file?
Depending on the particular codec, invoking the and methods on the returned by
may or may not cause the image data per se to be read from the file. For TIFF and
FlashPix images, actual reading of the image data from the file is deferred until a request for data is actually made by invoking
the or methods.

18 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Back to Question Index


I wrote a PNG image with transparency but it looks opaque in my browser.
Many popular browsers do not support PNG transparency correctly. The PNG Home Site lists the current status of many
popular browsers here.

Back to Question Index


How come Java Advanced Imaging can't read one of my image files?
Many image file format specifications have areas that are capable of varying interpretations, and interoperability between image
readers and writers is not always perfect. If you find an image in a supported format that cannot be read by the Java Advanced
Imaging API (or an image written by Java Advanced Imaging that cannot be read by other programs), we encourage you to send
us the image along with any available information about other programs that can and cannot read it. Although future work on
image I/O will be done under a separate framework, we are still committed to fixing bugs in the existing implementation.

Back to Question Index


Why won't a remote operation load my image file?
If you are using Java Advanced Imaging's remote imaging classes:
When passed to the server, the file path must be an absolute path to the file in question, which must be visible from the server.
A single name will always fail as the server has no way to know on which machine or in which directory ("folder") the file in
question resides.

Back to Question Index


Why doesn't Java Advanced Imaging support my favorite file format?
Most file I/O enhancements will be made in the context of the image I/O standard extension. The exact nature of these
enhancements is yet to be determined. Please refer to the JSR for more information.

Back to Question Index


How can I save space when using the BMP format?
24 bit BMP images tend to be large since they are not compressed, and an R, G and B triplet has to be stored for each pixel. If
the objective is to store the image in a lesser amount of space, a simple way of doing this would be to convert the BMP image to
a format that inherently supports compression, like JPEG. Here is a piece of code you can use to convert BMP images to JPEG
images:

If the objective is to actually reduce the number of colors in the image and then store it as a BMP, the following sequence of
steps could be followed:

1. Choose the 16 colors that will be used as the color palette for the output and dither the 24 bit image down to 4 bits per
channel.

2. Re-format this 4 bit image, so that the palette is stored in an associated and the data is stored 2 pixels
packed per byte (using a )

3. Write this re-formatted image as a BMP using the "filestore" operator.

Back to Question Index


How can I save the data displayed on a Canvas in a file?
There is a new class in the Java 2 Platform Standard Edition version 1.3 called that allows direct screen
capture. Also, if the image is drawn into a Swing component, its print method can be used to capture the image.
Another approach is to create an AWT image and call the same application method to draw into it.

Next, convert the AWTImage to a PlanarImage:

Then, write out the PlanarImage (for example, in BMP format):

19 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Back to Question Index


Why don't certain operations with GIF source images function correctly?
As of JAI 1.1.1, the GIF decoder produces an image which has an IndexColorModel instead of a ComponentColorModel as was
previously the case. This may provoke strange discrepancies in applications which have made assumptions about the nature of
image ColorModels. Such applications might need to add an ImageLayout containing a ComponentColorModel to the
RenderingHints of certain operations or perhaps simply convert all IndexColorModel images to 3-band RGB images when they
are loaded.
As of JAI 1.1.2, applications may no longer need to add an ImageLayout containing a ComponentColorModel to the
RenderingHints of certain operations or to convert all IndexColorModel images to 3-band RGB images when they are loaded.
While the GIF decoder still produces an image which has an IndexColorModel, those operations that would produce an incorrect
result when operating on a source with an IndexColorModel use the JAI.KEY_REPLACE_INDEX_COLOR_MODEL
RenderingHint (as of JAI 1.1.2) to cause the resultant image to have a non-IndexColorModel, and do the processing on the color
translated pixels, as opposed to performing the operations on the indices into the colormap. A detailed discussion of these
issues can be found here.
Back to Question Index

Additional Code Samples

Add a transparency mask (alpha channel) to an image.


This code example expects two command line arguments which are the paths to a three-band and a one-band byte image,
respectively, with the same width and height and stored in a supported format.

Back to Question Index


Scale an image or image region.
A method used to scale image or image region can be found here.

Back to Question Index


Retile an image.
Sample code which will work for all the supported image types may be found here.
Most operators allow tile layout to be specified via the hint. One may retile an image, in the next operator this
image is used as a source by specifying a new tileWidth/tileHeight. If you don't want to perform any operations on the image,
you can always use the reformat operator, with the same data type.

You can also use the freely available utility "tiffcp" (part of the libtiff distribution) to retile TIFF images. This works well with Java
Advanced Imaging. tiffcp is also a bit more tolerant of images with "bad" headers than Java Advanced Imaging and you can use
it on a TIFF image that Java Advanced Imaging can't read in order to clean it up. You can get libtiff here.

The utility "tiffsplit" is also in the libtiff distribution. This program splits a multi-image TIFF into single-image TIFFs.

Back to Question Index

Choose an image with a file dialog and load it into a .


See the code sample.

Back to Question Index


Convolve an image.
A simple convolution example is here.
A example of a float image with a float kernel, converted to a for display may be found here.

Back to Question Index

Combine multiple separate images into one multibanded image.


Use the "BandMerge" operation. An alternative is given by this code example.

20 of 21 5/10/2011 7:39 AM
Java[tm] Advanced Imaging API http://java.sun.com/jsp_utils/PrintPage.jsp?url=http://java.sun.com/prod...

Back to Question Index


Load an image, do something to every pixel, and display the result.
Sample code can be found here.

Back to Question Index


Place one smaller image within a larger template image into a pre-defined area.
In the following, assume that you already have two s named and where the latter will be inset in the
former. Then you could try something like this:

The preceding snippet assumes that the images and have compatible s and that the min X and Y of these
images are set to give the correct relative positions. The translate operation can be used to set the min X and Y of the images to
the correct relative positions. The TiledImage should contain the desired result.

Back to Question Index


Display a collection of images.

This assumes that the Collection object contains a number of s. Of course you can a use different layout for the
. If you want to display images in separate windows, just create a new for each image and put the panel in there.

copyright © Sun Microsystems, Inc

21 of 21 5/10/2011 7:39 AM

You might also like