icy.image

Class AbstractImageProvider

java.lang.Object

icy.image.AbstractImageProvider

All Implemented Interfaces:

ImageProvider

public abstract class AbstractImageProvider
extends java.lang.Object
implements ImageProvider

Abstract implementation of the ImageProvider interface.
It provide methods wrapper so you only need implement one method the get your importer working.
But free feel to override more methods to provide better support and/or better performance.

Author:

Stephane

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_THUMBNAIL_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractImageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
IcyBufferedImage	getImage(int z, int t) Returns the image located at specified position.
IcyBufferedImage	getImage(int serie, int z, int t) Returns the image located at specified position.
IcyBufferedImage	getImage(int serie, int resolution, int z, int t) Returns the image located at specified position.
IcyBufferedImage	getImage(int serie, int resolution, int z, int t, int c) Returns the image located at specified position.
IcyBufferedImage	getImage(int serie, int resolution, java.awt.Rectangle rectangle, int z, int t) Returns the image located at specified position.
IcyBufferedImage	getImageByTile(int serie, int resolution, int z, int t, int c, int tileW, int tileH, ProgressListener listener) Returns the image located at specified position using tile by tile reading (if supported by the importer).
java.lang.Object	getPixels(int serie, int resolution, java.awt.Rectangle rectangle, int z, int t, int c) Returns the pixel data located for specified position of the image.
int	getResolutionFactor(int serie, int wantedSize) Returns the image resolution that best suit to the size resolution.
static int	getResolutionFactor(int sizeX, int sizeY, int wantedSize) Returns the sub image resolution which best suit to the desired size.
IcyBufferedImage	getThumbnail(int serie) Returns the image thumbnail for the specified serie of the image.
int	getTileHeight(int serie) Returns the (optimal) tile height for the specified serie of the image.
static java.util.List<java.awt.Rectangle>	getTileList(int sizeX, int sizeY, int tileW, int tileH) Get the list of tiles to fill the given XY plan size.
int	getTileWidth(int serie) Returns the (optimal) tile width for the specified serie of the image.

Methods inherited from class java.lang.Object

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

Methods inherited from interface icy.image.ImageProvider

getImage, getMetaData

Field Detail

DEFAULT_THUMBNAIL_SIZE

public static final int DEFAULT_THUMBNAIL_SIZE

See Also:

Constant Field Values

Constructor Detail

AbstractImageProvider

public AbstractImageProvider()

Method Detail

getTileWidth

public int getTileWidth(int serie)
                 throws UnsupportedFormatException,
                        java.io.IOException

Description copied from interface: ImageProvider

Returns the (optimal) tile width for the specified serie of the image.
This method allow to know the best tile size to use when using the sub region image loading operations.
This method should returns 0 if tile loading is not supported and -1 if any tile size can be used.

Specified by:

getTileWidth in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

Returns:

optimal tile width

Throws:

UnsupportedFormatException

java.io.IOException

getTileHeight

public int getTileHeight(int serie)
                  throws UnsupportedFormatException,
                         java.io.IOException

Description copied from interface: ImageProvider

Returns the (optimal) tile height for the specified serie of the image.
This method allow to know the best tile size to use when using the sub region image loading operations.
This method should returns 0 if tile loading is not supported and -1 if any tile size can be used.

Specified by:

getTileHeight in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

Returns:

optimal tile height

Throws:

UnsupportedFormatException

java.io.IOException

getThumbnail

public IcyBufferedImage getThumbnail(int serie)
                              throws UnsupportedFormatException,
                                     java.io.IOException

Description copied from interface: ImageProvider

Returns the image thumbnail for the specified serie of the image.

Specified by:

getThumbnail in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

Returns:

thumbnail image.

Throws:

UnsupportedFormatException

java.io.IOException

getPixels

public java.lang.Object getPixels(int serie,
                         int resolution,
                         java.awt.Rectangle rectangle,
                         int z,
                         int t,
                         int c)
                           throws UnsupportedFormatException,
                                  java.io.IOException

Description copied from interface: ImageProvider

Returns the pixel data located for specified position of the image.
Data is returned in form of a single dimension array, the type of this array depends from the image data type
which can be retrieve from the metadata (see OMEXMLMetadataImpl.getPixelsType(int)

Specified by:

getPixels in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

resolution - Wanted resolution level for the image (use 0 if unsure).
The retrieved image resolution is equal to image.resolution / (2^resolution)
So for instance level 0 is the default image resolution while level 1 is base image resolution / 2 and so on...

rectangle - The 2D region we want to retrieve.
If set to null then the whole image is returned.

z - Z position of the image (slice) we want retrieve data from

t - T position of the image (frame) we want retrieve data from

c - C position of the image (channel) we want retrieve (-1 is not accepted here).

Returns:

native type array containing image pixel data.

Throws:

UnsupportedFormatException

java.io.IOException

getImage

public IcyBufferedImage getImage(int serie,
                        int resolution,
                        java.awt.Rectangle rectangle,
                        int z,
                        int t)
                          throws UnsupportedFormatException,
                                 java.io.IOException

Description copied from interface: ImageProvider

Returns the image located at specified position.

Specified by:

getImage in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

resolution - Wanted resolution level for the image (use 0 if unsure).
The retrieved image resolution is equal to image.resolution / (2^resolution)
So for instance level 0 is the default image resolution while level 1 is base image resolution / 2 and so on...

rectangle - The 2D region we want to retrieve.
If set to null then the whole image is returned.

z - Z position of the image (slice) we want retrieve

t - T position of the image (frame) we want retrieve

Returns:

image

Throws:

UnsupportedFormatException

java.io.IOException

getImage

public IcyBufferedImage getImage(int serie,
                        int resolution,
                        int z,
                        int t,
                        int c)
                          throws UnsupportedFormatException,
                                 java.io.IOException

Description copied from interface: ImageProvider

Returns the image located at specified position.

Specified by:

getImage in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

resolution - Wanted resolution level for the image (use 0 if unsure).
The retrieved image resolution is equal to image.resolution / (2^resolution)
So for instance level 0 is the default image resolution while level 1 is base image resolution / 2 and so on...

z - Z position of the image (slice) we want retrieve

t - T position of the image (frame) we want retrieve

c - C position of the image (channel) we want retrieve (-1 means all channel).

Returns:

image

Throws:

UnsupportedFormatException

java.io.IOException

getImage

public IcyBufferedImage getImage(int serie,
                        int resolution,
                        int z,
                        int t)
                          throws UnsupportedFormatException,
                                 java.io.IOException

Description copied from interface: ImageProvider

Returns the image located at specified position.

Specified by:

getImage in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

resolution - Wanted resolution level for the image (use 0 if unsure).
The retrieved image resolution is equal to image.resolution / (2^resolution)
So for instance level 0 is the default image resolution while level 1 is base image resolution / 2 and so on...

z - Z position of the image (slice) we want retrieve

t - T position of the image (frame) we want retrieve

Returns:

image

Throws:

UnsupportedFormatException

java.io.IOException

getImage

public IcyBufferedImage getImage(int serie,
                        int z,
                        int t)
                          throws UnsupportedFormatException,
                                 java.io.IOException

Description copied from interface: ImageProvider

Returns the image located at specified position.

Specified by:

getImage in interface ImageProvider

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

z - Z position of the image (slice) we want retrieve

t - T position of the image (frame) we want retrieve

Returns:

image

Throws:

UnsupportedFormatException

java.io.IOException

getImage

public IcyBufferedImage getImage(int z,
                        int t)
                          throws UnsupportedFormatException,
                                 java.io.IOException

Description copied from interface: ImageProvider

Returns the image located at specified position.

Specified by:

getImage in interface ImageProvider

Parameters:

z - Z position of the image (slice) we want retrieve

t - T position of the image (frame) we want retrieve

Returns:

image

Throws:

UnsupportedFormatException

java.io.IOException

getImageByTile

public IcyBufferedImage getImageByTile(int serie,
                              int resolution,
                              int z,
                              int t,
                              int c,
                              int tileW,
                              int tileH,
                              ProgressListener listener)
                                throws UnsupportedFormatException,
                                       java.io.IOException

Returns the image located at specified position using tile by tile reading (if supported by the importer).
This method is useful to read a sub resolution of a very large image which cannot fit in memory and also to take advantage of multi threading.

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

resolution - Wanted resolution level for the image (use 0 if unsure).
The retrieved image resolution is equal to image.resolution / (2^resolution)
So for instance level 0 is the default image resolution while level 1 is base image resolution / 2 and so on...

z - Z position of the image (slice) we want retrieve

t - T position of the image (frame) we want retrieve

c - C position of the image (channel) we want retrieve.
-1 is a special value meaning we want all channel.

tileW - width of the tile (better to use a multiple of 2)

tileH - height of the tile (better to use a multiple of 2)

listener - Progression listener

Throws:

UnsupportedFormatException

java.io.IOException

getTileList

public static java.util.List<java.awt.Rectangle> getTileList(int sizeX,
                                             int sizeY,
                                             int tileW,
                                             int tileH)

Get the list of tiles to fill the given XY plan size.

Parameters:

sizeX - plan sizeX

sizeY - plan sizeY

tileW - tile width

tileH - tile height

getResolutionFactor

public static int getResolutionFactor(int sizeX,
                      int sizeY,
                      int wantedSize)

Returns the sub image resolution which best suit to the desired size.

Parameters:

sizeX - original image width

sizeY - original image height

wantedSize - wanted size (for the maximum dimension)

Returns:

resolution ratio
0 = original resolution
1 = (original resolution / 2)
2 = (original resolution / 4)

getResolutionFactor

public int getResolutionFactor(int serie,
                      int wantedSize)
                        throws UnsupportedFormatException,
                               java.io.IOException

Returns the image resolution that best suit to the size resolution.

Parameters:

serie - Serie index for multi serie image (use 0 if unsure).

wantedSize - wanted size (for the maximum dimension)

Returns:

resolution ratio
0 = original resolution
1 = (original resolution / 2)
2 = (original resolution / 4)

Throws:

java.io.IOException

UnsupportedFormatException