icy.image

Class IcyBufferedImageUtil

java.lang.Object

icy.image.IcyBufferedImageUtil

public class IcyBufferedImageUtil
extends java.lang.Object

IcyBufferedImage utilities class.
You can find here tools to clone, manipulate the image data type, its size...

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IcyBufferedImageUtil.FilterType

Constructor Summary

Constructors

Constructor and Description
IcyBufferedImageUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static IcyBufferedImage	addChannel(IcyBufferedImage source) Add an empty channel to the specified image and return result as a new image.
static IcyBufferedImage	addChannel(IcyBufferedImage source, int index) Add an empty channel to the specified image and return result as a new image.
static IcyBufferedImage	addChannels(IcyBufferedImage source, int index, int num) Add empty channel(s) to the specified image and return result as a new image.
static IcyBufferedImage	convertToType(IcyBufferedImage source, DataType dataType, boolean rescale) Convert the source image to the specified data type.
static IcyBufferedImage	convertToType(IcyBufferedImage source, DataType dataType, boolean rescale, boolean useDataBounds) Convert the source image to the specified data type.
static IcyBufferedImage	convertToType(IcyBufferedImage source, DataType dataType, Scaler scaler) Deprecated. Use convertType(IcyBufferedImage, DataType, Scaler[]) instead.
static IcyBufferedImage	convertType(IcyBufferedImage source, DataType dataType, Scaler[] scalers) Convert the source image to the specified data type.
static IcyBufferedImage	downscaleBy2(IcyBufferedImage input, boolean filter) Returns a down scaled by a factor of 2 of the input image (X and Y resolution are divided by 2).
static IcyBufferedImage	downscaleBy2(IcyBufferedImage input, boolean filter, IcyBufferedImage output) Returns a down scaled by a factor of 2 of the input image (X and Y resolution are divided by 2).
static IcyBufferedImage	downscaleBy2(IcyBufferedImage source, boolean filter, int level) Down scale the specified image with the given down scale factor.
static java.lang.Object	downscaleBy2(java.lang.Object input, int sizeX, int sizeY, boolean signed, boolean filter) Returns a down scaled by a factor of 2 of the input image data (X and Y resolution are divided by 2).
static java.lang.Object	downscaleBy2(java.lang.Object input, int sizeX, int sizeY, boolean signed, boolean filter, java.lang.Object output) Returns a down scaled by a factor of 2 of the input image data (X and Y resolution are divided by 2).
static IcyBufferedImage	extractChannel(IcyBufferedImage source, int channel) Build a new single channel image (greyscale) from the specified source image channel.
static IcyBufferedImage	extractChannels(IcyBufferedImage source, int... channels) Build a new image from the specified source image channels.
static IcyBufferedImage	extractChannels(IcyBufferedImage source, java.util.List<java.lang.Integer> channelNumbers) Deprecated. Use extractChannels(IcyBufferedImage, int[]) instead.
static java.awt.image.BufferedImage	getARGBImage(IcyBufferedImage source) Convert the current IcyBufferedImage into a ARGB BufferedImage.
static java.awt.image.BufferedImage	getARGBImage(IcyBufferedImage source, java.awt.image.BufferedImage dest) Deprecated. Use toBufferedImage(IcyBufferedImage, BufferedImage) instead.
static java.awt.image.BufferedImage	getARGBImage(IcyBufferedImage source, LUT lut) Convert the current IcyBufferedImage into a ARGB BufferedImage.
static java.awt.image.BufferedImage	getARGBImage(IcyBufferedImage source, LUT lut, java.awt.image.BufferedImage dest) Deprecated. Use toBufferedImage(IcyBufferedImage, BufferedImage, LUT) instead.
static IcyBufferedImage	getCopy(IcyBufferedImage source) Create a copy of the specified image.
static IcyBufferedImage	getSubImage(IcyBufferedImage source, int x, int y, int w, int h) Creates a new image which is a sub part of the source image from the specified coordinates and dimensions.
static IcyBufferedImage	getSubImage(IcyBufferedImage source, int x, int y, int c, int sizeX, int sizeY, int sizeC) Deprecated. Use getSubImage(IcyBufferedImage, Rectangle, int, int) instead.
static IcyBufferedImage	getSubImage(IcyBufferedImage source, java.awt.Rectangle region) Creates a new image which is a sub part of the source image from the specified region.
static IcyBufferedImage	getSubImage(IcyBufferedImage source, java.awt.Rectangle region, int c, int sizeC) Creates a new image from the specified region of the source image.
static IcyBufferedImage	rotate(IcyBufferedImage source, double angle) Return a rotated version of the source image with specified parameters.
static IcyBufferedImage	rotate(IcyBufferedImage source, double xOrigin, double yOrigin, double angle, IcyBufferedImageUtil.FilterType filterType) Return a rotated version of the source image with specified parameters.
static IcyBufferedImage	rotate(IcyBufferedImage source, double angle, IcyBufferedImageUtil.FilterType filterType) Return a rotated version of the source image with specified parameters.
static IcyBufferedImage	scale(IcyBufferedImage source, int width, int height) Return a copy of the image with specified size.
static IcyBufferedImage	scale(IcyBufferedImage source, int width, int height, boolean resizeContent, int xAlign, int yAlign) Return a copy of the image with specified size.
static IcyBufferedImage	scale(IcyBufferedImage source, int width, int height, boolean resizeContent, int xAlign, int yAlign, IcyBufferedImageUtil.FilterType filterType) Return a copy of the source image with specified size, alignment rules and filter type.
static IcyBufferedImage	scale(IcyBufferedImage source, int width, int height, IcyBufferedImageUtil.FilterType filterType) Return a copy of the image with specified size
static java.awt.image.BufferedImage	toBufferedImage(IcyBufferedImage source, java.awt.image.BufferedImage dest) Draw the source IcyBufferedImage into the destination BufferedImage If dest is null then a new TYPE_INT_ARGB BufferedImage is returned.
static java.awt.image.BufferedImage	toBufferedImage(IcyBufferedImage source, java.awt.image.BufferedImage dest, LUT lut) Draw the source IcyBufferedImage into the destination BufferedImage If dest is null then a new TYPE_INT_ARGB BufferedImage is returned.
static java.awt.image.BufferedImage	toBufferedImage(IcyBufferedImage source, int imageType) Convert the current IcyBufferedImage into a BufferedImage of the specified type.
static java.awt.image.BufferedImage	toBufferedImage(IcyBufferedImage source, int imageType, LUT lut) Convert the current IcyBufferedImage into a BufferedImage of the specified type.
static IcyBufferedImage	toIcyBufferedImage(java.awt.image.BufferedImage image) Deprecated. Use IcyBufferedImage.createFrom(BufferedImage) instead.
static IcyBufferedImage	toIcyBufferedImage(java.util.List<java.awt.image.BufferedImage> images) Deprecated. Use IcyBufferedImage.createFrom(List) instead.
static void	translate(IcyBufferedImage source, int dx, int dy) Translate image internal data (all channels) by the specified (x,y) vector.
static void	translate(IcyBufferedImage source, int dx, int dy, int channel) Translate image internal data of specified channel by the specified (x,y) vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

IcyBufferedImageUtil

public IcyBufferedImageUtil()

Method Detail

toIcyBufferedImage

@Deprecated
public static IcyBufferedImage toIcyBufferedImage(java.awt.image.BufferedImage image)

Deprecated. Use IcyBufferedImage.createFrom(BufferedImage) instead.

toIcyBufferedImage

@Deprecated
public static IcyBufferedImage toIcyBufferedImage(java.util.List<java.awt.image.BufferedImage> images)

Deprecated. Use IcyBufferedImage.createFrom(List) instead.

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(IcyBufferedImage source,
                                           java.awt.image.BufferedImage dest,
                                           LUT lut)

Draw the source IcyBufferedImage into the destination BufferedImage
If dest is null then a new TYPE_INT_ARGB BufferedImage is returned.

Parameters:

source - source image

dest - destination image

lut - LUT is used for color calculation (internal lut is used if null).

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(IcyBufferedImage source,
                                           java.awt.image.BufferedImage dest)

Draw the source IcyBufferedImage into the destination BufferedImage
If dest is null then a new TYPE_INT_ARGB BufferedImage is returned.

Parameters:

source - source image

dest - destination image

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(IcyBufferedImage source,
                                           int imageType,
                                           LUT lut)

Convert the current IcyBufferedImage into a BufferedImage of the specified type.

Parameters:

source - source image

imageType - wanted image type, only the following is accepted :
BufferedImage.TYPE_INT_ARGB
BufferedImage.TYPE_INT_RGB
BufferedImage.TYPE_BYTE_GRAY

lut - lut used for color calculation (source image lut is used if null)

Returns:

BufferedImage

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(IcyBufferedImage source,
                                           int imageType)

Convert the current IcyBufferedImage into a BufferedImage of the specified type.

Parameters:

source - source image

imageType - wanted image type, only the following is accepted :
BufferedImage.TYPE_INT_ARGB
BufferedImage.TYPE_INT_RGB
BufferedImage.TYPE_BYTE_GRAY

Returns:

BufferedImage

getARGBImage

@Deprecated
public static java.awt.image.BufferedImage getARGBImage(IcyBufferedImage source,
                                                   LUT lut,
                                                   java.awt.image.BufferedImage dest)

Deprecated. Use toBufferedImage(IcyBufferedImage, BufferedImage, LUT) instead.

Draw the source IcyBufferedImage into the destination ARGB BufferedImage
If dest is null then a new ARGB BufferedImage is returned.
This function is faster for ARGB conversion than toBufferedImage(IcyBufferedImage, BufferedImage, LUT) but the output BufferedImage is fixed to ARGB type (TYPE_INT_ARGB) and the image cannot be volatile, use toBufferedImage(IcyBufferedImage, BufferedImage, LUT) for no ARGB image or if you want volatile accelerated image.

Parameters:

source - source image

dest - destination image. Note that we access image data so it can't be volatile anymore which may result in slower drawing

lut - LUT is used for color calculation (internal lut is used if null).

getARGBImage

@Deprecated
public static java.awt.image.BufferedImage getARGBImage(IcyBufferedImage source,
                                                   java.awt.image.BufferedImage dest)

Deprecated. Use toBufferedImage(IcyBufferedImage, BufferedImage) instead.

Draw the source IcyBufferedImage into the destination ARGB BufferedImage
If dest is null then a new ARGB BufferedImage is returned.

This function is faster for ARGB conversion than toBufferedImage(IcyBufferedImage, BufferedImage) but the output BufferedImage is fixed to ARGB type (TYPE_INT_ARGB) and the image cannot be volatile, use toBufferedImage(IcyBufferedImage, BufferedImage) for no ARGB image or if you want volatile accelerated image.

Parameters:

source - source image

dest - destination image. Note that we access image data so it can't be volatile anymore which may result in slower drawing

getARGBImage

public static java.awt.image.BufferedImage getARGBImage(IcyBufferedImage source,
                                        LUT lut)

Convert the current IcyBufferedImage into a ARGB BufferedImage.
Note that we access image data so it can't be volatile anymore which may result in slower drawing.

Parameters:

source - source image

lut - LUT is used for color calculation (internal lut is used if null).

getARGBImage

public static java.awt.image.BufferedImage getARGBImage(IcyBufferedImage source)

Convert the current IcyBufferedImage into a ARGB BufferedImage.
Note that we access image data so it can't be volatile anymore which may result in slower drawing.

Parameters:

source - source image

convertType

public static IcyBufferedImage convertType(IcyBufferedImage source,
                           DataType dataType,
                           Scaler[] scalers)

Convert the source image to the specified data type.
This method returns a new image (the source image is not modified).

Parameters:

source - source image

dataType - data type wanted

scalers - scalers for scaling internal data during conversion (1 scaler per channel).
Can be set to null to avoid value conversion.

Returns:

converted image

convertToType

@Deprecated
public static IcyBufferedImage convertToType(IcyBufferedImage source,
                                        DataType dataType,
                                        Scaler scaler)

Deprecated. Use convertType(IcyBufferedImage, DataType, Scaler[]) instead.

convertToType

public static IcyBufferedImage convertToType(IcyBufferedImage source,
                             DataType dataType,
                             boolean rescale,
                             boolean useDataBounds)

Convert the source image to the specified data type.
This method returns a new image (the source image is not modified).

Parameters:

dataType - Data type wanted

rescale - Indicate if we want to scale data value according to data (or data type) range

useDataBounds - Only used when rescale parameter is true.
Specify if we use the data bounds for rescaling instead of data type bounds.

Returns:

converted image

convertToType

public static IcyBufferedImage convertToType(IcyBufferedImage source,
                             DataType dataType,
                             boolean rescale)

Convert the source image to the specified data type.
This method returns a new image (the source image is not modified).

Parameters:

dataType - data type wanted

rescale - indicate if we want to scale data value according to data type range

Returns:

converted image

getCopy

public static IcyBufferedImage getCopy(IcyBufferedImage source)

Create a copy of the specified image.

getSubImage

public static IcyBufferedImage getSubImage(IcyBufferedImage source,
                           java.awt.Rectangle region,
                           int c,
                           int sizeC)

Creates a new image from the specified region of the source image.

getSubImage

public static IcyBufferedImage getSubImage(IcyBufferedImage source,
                           java.awt.Rectangle region)

Creates a new image which is a sub part of the source image from the specified region.

See Also:

getSubImage(IcyBufferedImage, Rectangle, int, int)

getSubImage

@Deprecated
public static IcyBufferedImage getSubImage(IcyBufferedImage source,
                                      int x,
                                      int y,
                                      int c,
                                      int sizeX,
                                      int sizeY,
                                      int sizeC)

Deprecated. Use getSubImage(IcyBufferedImage, Rectangle, int, int) instead.

getSubImage

public static IcyBufferedImage getSubImage(IcyBufferedImage source,
                           int x,
                           int y,
                           int w,
                           int h)

Creates a new image which is a sub part of the source image from the specified coordinates and dimensions.

extractChannel

public static IcyBufferedImage extractChannel(IcyBufferedImage source,
                              int channel)

Build a new single channel image (greyscale) from the specified source image channel.

extractChannels

@Deprecated
public static IcyBufferedImage extractChannels(IcyBufferedImage source,
                                          java.util.List<java.lang.Integer> channelNumbers)

Deprecated. Use extractChannels(IcyBufferedImage, int[]) instead.

extractChannels

public static IcyBufferedImage extractChannels(IcyBufferedImage source,
                               int... channels)

Build a new image from the specified source image channels.

addChannels

public static IcyBufferedImage addChannels(IcyBufferedImage source,
                           int index,
                           int num)

Add empty channel(s) to the specified image and return result as a new image.

Parameters:

source - source image.

index - position where we want to add channel(s).

num - number of channel(s) to add.

addChannel

public static IcyBufferedImage addChannel(IcyBufferedImage source,
                          int index)

Add an empty channel to the specified image and return result as a new image.

Parameters:

source - source image.

index - position where we want to add channel.

addChannel

public static IcyBufferedImage addChannel(IcyBufferedImage source)

Add an empty channel to the specified image and return result as a new image.

Parameters:

source - source image.

rotate

public static IcyBufferedImage rotate(IcyBufferedImage source,
                      double xOrigin,
                      double yOrigin,
                      double angle,
                      IcyBufferedImageUtil.FilterType filterType)

Return a rotated version of the source image with specified parameters.

Parameters:

source - source image

xOrigin - X origin for the rotation

yOrigin - Y origin for the rotation

angle - rotation angle in radian

filterType - filter resampling method used

rotate

public static IcyBufferedImage rotate(IcyBufferedImage source,
                      double angle,
                      IcyBufferedImageUtil.FilterType filterType)

Return a rotated version of the source image with specified parameters.

Parameters:

source - source image

angle - rotation angle in radian

filterType - filter resampling method used

rotate

public static IcyBufferedImage rotate(IcyBufferedImage source,
                      double angle)

Return a rotated version of the source image with specified parameters.

Parameters:

source - source image

angle - rotation angle in radian

downscaleBy2

public static java.lang.Object downscaleBy2(java.lang.Object input,
                            int sizeX,
                            int sizeY,
                            boolean signed,
                            boolean filter,
                            java.lang.Object output)

Returns a down scaled by a factor of 2 of the input image data (X and Y resolution are divided by 2).
This function is specifically optimized for factor 2 down scaling.

Parameters:

input - input image data array (single dimension)

sizeX - width of source image

sizeY - height of source image

signed - consider input byte data as signed (only meaningful when filter is enabled)

filter - enable pixel blending for better representation of the down sampled result image (otherwise nearest neighbor is used)

output - output buffer (single dimension array with same data type as source image data array). If set to null a new array is allocated.

Returns:

output buffer containing the down scaled version of input image data.

downscaleBy2

public static java.lang.Object downscaleBy2(java.lang.Object input,
                            int sizeX,
                            int sizeY,
                            boolean signed,
                            boolean filter)

Returns a down scaled by a factor of 2 of the input image data (X and Y resolution are divided by 2).
This function is specifically optimized for factor 2 down scaling.

Parameters:

input - input image data array (single dimension)

sizeX - width of source image

sizeY - height of source image

signed - consider input byte data as signed (only meaningful when filter is enabled)

filter - enable pixel blending for better representation of the down sampled result image (otherwise nearest neighbor is used)

Returns:

output buffer containing the down scaled version of input image data.

downscaleBy2

public static IcyBufferedImage downscaleBy2(IcyBufferedImage input,
                            boolean filter,
                            IcyBufferedImage output)

Returns a down scaled by a factor of 2 of the input image (X and Y resolution are divided by 2).
This function is specifically optimized for factor 2 down scaling.

Parameters:

input - input image

filter - enable pixel blending for better representation of the down sampled result image (otherwise nearest neighbor is used)

output - output image receiving the result (should be of same type as input image with X and Y resolution divided by 2). If set to null a new image is created.

downscaleBy2

public static IcyBufferedImage downscaleBy2(IcyBufferedImage input,
                            boolean filter)

Returns a down scaled by a factor of 2 of the input image (X and Y resolution are divided by 2).
This function is specifically optimized for factor 2 down scaling.

Parameters:

input - input image

filter - enable pixel blending for better representation of the down sampled result image (otherwise nearest neighbor is used)

downscaleBy2

public static IcyBufferedImage downscaleBy2(IcyBufferedImage source,
                            boolean filter,
                            int level)

Down scale the specified image with the given down scale factor.
If down scale factor equals 0 then the input image is directly returned.

Parameters:

source - input image

filter - enable pixel blending for better representation of the down sampled result image (otherwise nearest neighbor is used)

level - number of downscale to process: scale level = 1/2^level

Returns:

scaled image or source image is scale level equals 0

scale

public static IcyBufferedImage scale(IcyBufferedImage source,
                     int width,
                     int height,
                     boolean resizeContent,
                     int xAlign,
                     int yAlign,
                     IcyBufferedImageUtil.FilterType filterType)

Return a copy of the source image with specified size, alignment rules and filter type.

Parameters:

source - source image

resizeContent - indicate if content should be resized or not (empty area are 0 filled)

xAlign - horizontal image alignment (SwingConstants.LEFT / CENTER / RIGHT)
(used only if resizeContent is false)

yAlign - vertical image alignment (SwingConstants.TOP / CENTER / BOTTOM)
(used only if resizeContent is false)

filterType - filter method used for scale (used only if resizeContent is true)

scale

public static IcyBufferedImage scale(IcyBufferedImage source,
                     int width,
                     int height,
                     boolean resizeContent,
                     int xAlign,
                     int yAlign)

Return a copy of the image with specified size.
By default the FilterType.BILINEAR is used as filter method if resizeContent is true

Parameters:

source - source image

resizeContent - indicate if content should be resized or not (empty area are 0 filled)

xAlign - horizontal image alignment (SwingConstants.LEFT / CENTER / RIGHT)
(used only if resizeContent is false)

yAlign - vertical image alignment (SwingConstants.TOP / CENTER / BOTTOM)
(used only if resizeContent is false)

scale

public static IcyBufferedImage scale(IcyBufferedImage source,
                     int width,
                     int height,
                     IcyBufferedImageUtil.FilterType filterType)

Return a copy of the image with specified size

Parameters:

source - source image

filterType - filter method used for scale (used only if resizeContent is true)

scale

public static IcyBufferedImage scale(IcyBufferedImage source,
                     int width,
                     int height)

Return a copy of the image with specified size.
By default the FilterType.BILINEAR is used as filter method.

translate

public static void translate(IcyBufferedImage source,
             int dx,
             int dy,
             int channel)

Translate image internal data of specified channel by the specified (x,y) vector.
Data going "outside" image bounds is lost.

translate

public static void translate(IcyBufferedImage source,
             int dx,
             int dy)

Translate image internal data (all channels) by the specified (x,y) vector.
Data going "outside" image bounds is lost.