Pr22.Imaging

Class RawImage

java.lang.Object

Pr22.Imaging.RawImage

public class RawImage
extends java.lang.Object

Low level image data of the system that can be saved or converted to BufferedImage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawImage.FileFormat Image file formats.
static class	RawImage.PixelFormat Available pixel formats.

Constructor Summary

Constructors

Constructor and Description
RawImage() New RawImage.
RawImage(RawImage src) References an existing RawImage.

Method Summary

Modifier and Type	Method and Description
RawImage	convertPixelFormat(RawImage.PixelFormat format, int sline) Converts the RawImage to a specific pixel format.
RawImage	create(RawImage.PixelFormat format, int xsize, int ysize, int sline) Creates a RawImage.
RawImage	duplicate() Duplicates the RawImage.
RawImage	fromImage(java.awt.image.BufferedImage image) Converts a BufferedImage object to RawImage.
RawImage	fromVariant(Variant source) Gets an embedded image from a Variant.
int	getHRes() Returns the horizontal resolution of the RawImage in pixel/meters.
RawImage.PixelFormat	getPixelFormat() Returns the pixel format of the RawImage.
com.sun.jna.Pointer	getRawData() Returns the address of the buffer of the raw pixel data.
int	getRawSize() Returns the size of the raw pixel data.
java.awt.Dimension	getSize() Returns the size of the image in pixels.
int	getSLine() Returns the length of a row in bytes.
int	getVRes() Returns the vertical resolution of the RawImage in pixel/meters.
boolean	isValid() Checks if the RawImage is valid.
RawImage	load(BinData buffer) Loads an image from the memory.
BinData	save(RawImage.FileFormat fileformat) Saves the image to the memory in a specific file format.
BinData	save(RawImage.FileFormat fileformat, Variant properties, java.lang.String comments) Saves the image to the memory in a specific file format.
java.awt.image.BufferedImage	toImage() Returns the image as a BufferedImage object.
Variant	toVariant(int varid, java.lang.String varname) Embeds an image into a Variant.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawImage

public RawImage()

New RawImage.

RawImage

public RawImage(RawImage src)
         throws General

References an existing RawImage.

Parameters:

src - Source RawImage.

Throws:

General

Method Detail

isValid

public boolean isValid()

Checks if the RawImage is valid.

Returns:

In case of valid RawImage the return value is true.

getPixelFormat

public RawImage.PixelFormat getPixelFormat()

Returns the pixel format of the RawImage.

Returns:

RawImage.PixelFormat

getSize

public java.awt.Dimension getSize()

Returns the size of the image in pixels.

Returns:

Size of the image in pixels.

getSLine

public int getSLine()

Returns the length of a row in bytes.

Returns:

Length of a row in bytes.

getRawData

public com.sun.jna.Pointer getRawData()

Returns the address of the buffer of the raw pixel data. (in unmanaged memory)

Returns:

Address of the buffer of the raw pixel data. (in unmanaged memory)

getRawSize

public int getRawSize()

Returns the size of the raw pixel data.

Returns:

Size of the raw pixel data.

getHRes

public int getHRes()

Returns the horizontal resolution of the RawImage in pixel/meters.

Returns:

Horizontal resolution of the RawImage in pixel/meters.

getVRes

public int getVRes()

Returns the vertical resolution of the RawImage in pixel/meters.

Returns:

Vertical resolution of the RawImage in pixel/meters.

create

public RawImage create(RawImage.PixelFormat format,
                       int xsize,
                       int ysize,
                       int sline)
                throws General

Creates a RawImage.

Parameters:

format - Pixel format.

xsize - Horizontal size of image in pixels.

ysize - Vertical size of image in pixels.

sline - Length of a row in bytes (min.: xsize * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

This object.

Throws:

General

load

public RawImage load(BinData buffer)
              throws General

Loads an image from the memory.

Parameters:

buffer - Image data.

Returns:

This object.

Throws:

General

save

public BinData save(RawImage.FileFormat fileformat)
             throws General

Saves the image to the memory in a specific file format.

Parameters:

fileformat - The file format.

Returns:

Output raw memory data.

Throws:

General

save

public BinData save(RawImage.FileFormat fileformat,
                    Variant properties,
                    java.lang.String comments)
             throws General

Saves the image to the memory in a specific file format.

Parameters:

fileformat - The specific file format.

properties - Properties for saving. The properties are described in the reference manual.

comments - Comments for save.

Returns:

Output raw memory data.

Throws:

General

convertPixelFormat

public RawImage convertPixelFormat(RawImage.PixelFormat format,
                                   int sline)
                            throws General

Converts the RawImage to a specific pixel format.

Parameters:

format - Pixel format of the target image.

sline - Length of a row in bytes (x size * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

The converted RawImage in the desired pixel format. (This object.)

Throws:

General

duplicate

public RawImage duplicate()
                   throws General

Duplicates the RawImage.

Returns:

The duplicated RawImage.

Throws:

General

toVariant

public Variant toVariant(int varid,
                         java.lang.String varname)
                  throws General

Embeds an image into a Variant.

Parameters:

varid - The Id for the created Variant.

varname - The name for the created Variant.

Returns:

The created Variant.

Throws:

General

fromVariant

public RawImage fromVariant(Variant source)
                     throws General

Gets an embedded image from a Variant.

Parameters:

source - Variant with an embedded image.

Returns:

This object.

Throws:

General

toImage

public java.awt.image.BufferedImage toImage()
                                     throws General

Returns the image as a BufferedImage object.

Returns:

BufferedImage object.

Throws:

General

fromImage

public RawImage fromImage(java.awt.image.BufferedImage image)
                   throws General

Converts a BufferedImage object to RawImage.

Parameters:

image - The BufferedImage object to be converted to RawImage.

Returns:

This object.

Throws:

General