boofcv.core.image

Class ConvertBufferedImage

java.lang.Object

boofcv.core.image.ConvertBufferedImage

public class ConvertBufferedImage
extends Object

Functions for converting to and from BufferedImage.

Author:

Peter Abeles

Constructor Summary

Constructors

Constructor and Description
ConvertBufferedImage()

Method Summary

Methods

Modifier and Type	Method and Description
static BufferedImage	checkInputs(ImageBase src, BufferedImage dst) If null the dst is declared, otherwise it checks to see if the 'dst' as the same shape as 'src'.
static ImageFloat32	convertFrom(BufferedImage src, ImageFloat32 dst) Converts the buffered image into an ImageFloat32.
static ImageUInt8	convertFrom(BufferedImage src, ImageUInt8 dst) Converts the buffered image into an ImageUInt8.
static <T extends ImageBase> void	convertFrom(BufferedImage src, T dst, boolean orderRgb) Converts a buffered image into an image of the specified type.
static <T extends ImageInt16> T	convertFrom(BufferedImage src, T dst, Class<T> type) Converts the buffered image into an ImageInt16.
static <T extends ImageSingleBand> MultiSpectral<T>	convertFromMulti(BufferedImage src, MultiSpectral<T> dst, boolean orderRgb, Class<T> type) Converts the buffered image into an MultiSpectral image of the specified type.
static <T extends ImageSingleBand> T	convertFromSingle(BufferedImage src, T dst, Class<T> type) Converts a buffered image into an image of the specified type.
static BufferedImage	convertTo_F32(MultiSpectral<ImageFloat32> src, BufferedImage dst, boolean orderRgb) Converts a ImageUInt8 into a BufferedImage.
static BufferedImage	convertTo_U8(MultiSpectral<ImageUInt8> src, BufferedImage dst, boolean orderRgb) Converts a ImageUInt8 into a BufferedImage.
static BufferedImage	convertTo(ImageBase src, BufferedImage dst, boolean orderRgb) Converts an image into a BufferedImage.
static BufferedImage	convertTo(ImageFloat32 src, BufferedImage dst) Converts the buffered image into an ImageFloat32.
static BufferedImage	convertTo(ImageInt16 src, BufferedImage dst) Converts a ImageInt16 into a BufferedImage.
static BufferedImage	convertTo(ImageUInt8 src, BufferedImage dst) Converts a ImageUInt8 into a BufferedImage.
static BufferedImage	convertTo(JComponent comp, BufferedImage storage) Draws the component into a BufferedImage.
static BufferedImage	extractBuffered(ImageUInt8 img) Creates a new BufferedImage that internally uses the same data as the provided ImageUInt8.
static BufferedImage	extractBuffered(InterleavedU8 img) Creates a new BufferedImage that internally uses the same data as the provided InterleavedU8.
static ImageUInt8	extractImageUInt8(BufferedImage img) For BufferedImage stored as a byte array internally it extracts an image.
static InterleavedU8	extractInterleavedU8(BufferedImage img) For BufferedImage stored as a byte array internally it extracts an interleaved image.
static boolean	isSubImage(BufferedImage img) Checks to see if the input image is a subImage().
static MultiSpectral	orderBandsIntoBuffered(MultiSpectral src, BufferedImage dst) Returns a new image with the color bands in the appropriate ordering.
static <T extends ImageSingleBand> void	orderBandsIntoRGB(MultiSpectral<T> image, BufferedImage input) If a MultiSpectral was created from a BufferedImage its colors might not be in the expected order.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertBufferedImage

public ConvertBufferedImage()

Method Detail

extractInterleavedU8

public static InterleavedU8 extractInterleavedU8(BufferedImage img)

For BufferedImage stored as a byte array internally it extracts an interleaved image. The input image and the returned image will both share the same internal data array. Using this function allows unnecessary memory copying to be avoided.

Parameters:

img - Image whose internal data is extracted and wrapped.

Returns:

An image whose internal data is the same as the input image.

extractImageUInt8

public static ImageUInt8 extractImageUInt8(BufferedImage img)

For BufferedImage stored as a byte array internally it extracts an image. The input image and the returned image will both share the same internal data array. Using this function allows unnecessary memory copying to be avoided.

Parameters:

img - Image whose internal data is extracted and wrapped.

Returns:

An image whose internal data is the same as the input image.

extractBuffered

public static BufferedImage extractBuffered(InterleavedU8 img)

Creates a new BufferedImage that internally uses the same data as the provided InterleavedU8. If 3 bands then the image will be of type TYPE_3BYTE_BGR or if 1 band TYPE_BYTE_GRAY.

Parameters:

img - Input image who's data will be wrapped by the returned BufferedImage.

Returns:

BufferedImage which shared data with the input image.

extractBuffered

public static BufferedImage extractBuffered(ImageUInt8 img)

Creates a new BufferedImage that internally uses the same data as the provided ImageUInt8. The returned BufferedImage will be of type TYPE_BYTE_GRAY.

NOTE: This only works on images which are not subimages!

Parameters:

img - Input image who's data will be wrapped by the returned BufferedImage.

Returns:

BufferedImage which shared data with the input image.

convertFrom

public static <T extends ImageBase> void convertFrom(BufferedImage src,
                                     T dst,
                                     boolean orderRgb)

Converts a buffered image into an image of the specified type.

Parameters:

src - Input BufferedImage which is to be converted

dst - The image which it is being converted into

orderRgb - If applicable, should it adjust the ordering of each color band to maintain color consistency

convertFromSingle

public static <T extends ImageSingleBand> T convertFromSingle(BufferedImage src,
                                              T dst,
                                              Class<T> type)

Converts a buffered image into an image of the specified type. In a 'dst' image is provided it will be used for output, otherwise a new image will be created.

convertFrom

public static ImageUInt8 convertFrom(BufferedImage src,
                     ImageUInt8 dst)

Converts the buffered image into an ImageUInt8. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new unsigned image is created.

Returns:

Converted image.

convertFrom

public static <T extends ImageInt16> T convertFrom(BufferedImage src,
                                   T dst,
                                   Class<T> type)

Converts the buffered image into an ImageInt16. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new unsigned image is created.

Returns:

Converted image.

convertFrom

public static ImageFloat32 convertFrom(BufferedImage src,
                       ImageFloat32 dst)

Converts the buffered image into an ImageFloat32. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new unsigned image is created.

Returns:

Converted image.

convertFromMulti

public static <T extends ImageSingleBand> MultiSpectral<T> convertFromMulti(BufferedImage src,
                                                            MultiSpectral<T> dst,
                                                            boolean orderRgb,
                                                            Class<T> type)

Converts the buffered image into an MultiSpectral image of the specified type.

Parameters:

src - Input image. Not modified.

dst - Output. The converted image is written to. If null a new unsigned image is created.

orderRgb - If applicable, should it adjust the ordering of each color band to maintain color consistency. Most of the time you want this to be true.

type - Which type of data structure is each band. (ImageUInt8 or ImageFloat32)

Returns:

Converted image.

convertTo

public static BufferedImage convertTo(ImageBase src,
                      BufferedImage dst,
                      boolean orderRgb)

Converts an image into a BufferedImage.

Parameters:

src - Input image. Pixels must have a value from 0 to 255.

dst - Where the converted image is written to. If null a new image is created.

orderRgb - If applicable, should it change the order of the color bands (assumed RGB or ARGB) into the order based on BufferedImage.TYPE. Most of the time you want this to be true.

Returns:

Converted image.

convertTo

public static BufferedImage convertTo(ImageUInt8 src,
                      BufferedImage dst)

Converts a ImageUInt8 into a BufferedImage. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new image is created.

Returns:

Converted image.

convertTo

public static BufferedImage convertTo(ImageInt16 src,
                      BufferedImage dst)

Converts a ImageInt16 into a BufferedImage. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new image is created.

Returns:

Converted image.

convertTo

public static BufferedImage convertTo(ImageFloat32 src,
                      BufferedImage dst)

Converts the buffered image into an ImageFloat32. If the buffered image has multiple channels the intensities of each channel are averaged together. The floating point image is assumed to be between 0 and 255.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new image is created.

Returns:

Converted image.

convertTo_U8

public static BufferedImage convertTo_U8(MultiSpectral<ImageUInt8> src,
                         BufferedImage dst,
                         boolean orderRgb)

Converts a ImageUInt8 into a BufferedImage. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new image is created.

orderRgb - If applicable, should it change the order of the color bands (assumed RGB or ARGB) into the order based on BufferedImage.TYPE. Most of the time you want this to be true.

Returns:

Converted image.

convertTo_F32

public static BufferedImage convertTo_F32(MultiSpectral<ImageFloat32> src,
                          BufferedImage dst,
                          boolean orderRgb)

Converts a ImageUInt8 into a BufferedImage. If the buffered image has multiple channels the intensities of each channel are averaged together.

Parameters:

src - Input image.

dst - Where the converted image is written to. If null a new image is created.

orderRgb - If applicable, should it change the order of the color bands (assumed RGB or ARGB) into the order based on BufferedImage.TYPE. Most of the time you want this to be true.

Returns:

Converted image.

checkInputs

public static BufferedImage checkInputs(ImageBase src,
                        BufferedImage dst)

If null the dst is declared, otherwise it checks to see if the 'dst' as the same shape as 'src'.

convertTo

public static BufferedImage convertTo(JComponent comp,
                      BufferedImage storage)

Draws the component into a BufferedImage.

Parameters:

comp - The component being drawn into an image.

storage - if not null the component is drawn into it, if null a new BufferedImage is created.

Returns:

image of the component

orderBandsIntoBuffered

public static MultiSpectral orderBandsIntoBuffered(MultiSpectral src,
                                   BufferedImage dst)

Returns a new image with the color bands in the appropriate ordering. The returned image will reference the original image's image arrays.

orderBandsIntoRGB

public static <T extends ImageSingleBand> void orderBandsIntoRGB(MultiSpectral<T> image,
                                                 BufferedImage input)

If a MultiSpectral was created from a BufferedImage its colors might not be in the expected order. Invoking this function ensures that the image will have the expected ordering. For images with 3 bands it will be RGB and for 4 bands it will be ARGB.

isSubImage

public static boolean isSubImage(BufferedImage img)

Checks to see if the input image is a subImage().

Parameters:

img -

Returns: