ImageEvent

java.lang.Object
- org.youscope.common.image.ImageEvent<T>

Type Parameters:

T - Specifies the array type of the image. Typically either byte[], short[], or int[].

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class ImageEvent<T>
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Objects of this class contain the pixel data of an image, as well as metadata about it, like where and when an image was made.

Author:

Moritz Lang

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageEvent<T>`	`clone()`
`static <T> ImageEvent<T>`	`createImage(T imageData, int width, int height)` Creates a new image with the given image data and meta information.
`static <T> ImageEvent<T>`	`createImage(T imageData, int width, int height, int bitDepth)` Creates a new image with the given image data and meta information.
`boolean`	`equals(java.lang.Object obj)`
`int`	`getBands()` Returns the number of bands (colors in image).
`int`	`getBitDepth()` Returns the bit dept.
`int`	`getBytesPerPixel()` Returns the number of bytes used to store each pixel.
`java.lang.String`	`getCamera()` Returns the name of the camera which took the image.
`java.lang.String`	`getChannel()` Returns the channel in which the image was made.
`java.lang.String`	`getChannelGroup()` Returns the channel group in which the image was made.
`long`	`getCreationTime()` Returns the time milliseconds since January 1, 1970, 00:00:00 GMT when the image was created (see `Date.Date(long)`).
`ExecutionInformation`	`getExecutionInformation()` Returns the information of how often the image producing job was already executed when producing the image.
`int`	`getHeight()` Returns image height in pixels.
`T`	`getImageData()` Returns the pixel data as an array of primitive types (typically byte or short).
`java.lang.Class<?>`	`getImageDataArrayType()` Returns the class of the array in which the image data is stored.
`java.lang.Class<?>`	`getImageDataType()` Returns the class of the primitive type in which one pixel of the image data is stored.
`long`	`getMaxIntensity()` Returns the maximal intensity a pixel can have.
`PositionInformation`	`getPositionInformation()` Returns the information about the logical position this image was made in.
`int`	`getWidth()` Returns image width in pixels.
`int`	`hashCode()`
`boolean`	`isSwitchXY()` Returns if the x and the y direction should be switched for images made by this camera.
`boolean`	`isTransposeX()` Returns if the x-direction of images made by this camera should be transposed.
`boolean`	`isTransposeY()` Returns if the if the y-direction of images made by this camera should be transposed.
`void`	`setBands(int bands)` Sets the number of bands (colors in image).
`void`	`setCamera(java.lang.String camera)` Set the name of the camera with which the image was taken.
`void`	`setChannel(java.lang.String channel)` Sets the channel in which the image was made.
`void`	`setChannelGroup(java.lang.String channelGroup)` Sets the channel group in which the image was made.
`void`	`setCreationTime(long creationTime)` Sets the time milliseconds since January 1, 1970, 00:00:00 GMT when the image was created (see `Date.getTime()`).
`void`	`setExecutionInformation(ExecutionInformation executionInformation)` Sets the information of how often the image producing job was already executed when producing the image.
`void`	`setPositionInformation(PositionInformation positionInformation)` Sets the information about the logical position this image was made in.
`void`	`setSwitchXY(boolean switchXY)` Sets if the x and the y direction should be switched for images made by this camera.
`void`	`setTransposeX(boolean transpose)` Sets if the x-direction of images made by this camera should be transposed.
`void`	`setTransposeY(boolean transpose)` Sets if the y-direction of images made by this camera should be transposed.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getImageDataArrayType
```
public java.lang.Class<?> getImageDataArrayType()
```
    Returns the class of the array in which the image data is stored. One of byte[].class, short[].class or int[].class.
    
    Returns:
    
    Class of array of image data.
  - getImageDataType
```
public java.lang.Class<?> getImageDataType()
```
    Returns the class of the primitive type in which one pixel of the image data is stored. One of byte.class, short.class or int.class.
    
    Returns:
    
    Primitive class of image data.
  - createImage
```
public static <T> ImageEvent<T> createImage(T imageData,
                                            int width,
                                            int height,
                                            int bitDepth)
                                     throws java.lang.NullPointerException,
                                            java.lang.IllegalArgumentException
```
    Creates a new image with the given image data and meta information. The image data must be an array of primitive types byte, short or int. This limitation may change in future releases of YouScope.
    
    Parameters:
    
    imageData - Array of bytes, shorts or ints representing the pixel intensities, either of grayscale images or of several bands (colors) or color images.
    
    width - The width of the image in pixels.
    
    height - The height of the image in pixels.
    
    bitDepth - The bit depth of the image.
    
    Returns:
    
    Newly created image.
    
    Throws:
    
    java.lang.NullPointerException - Thrown if imageData is null.
    
    java.lang.IllegalArgumentException - Thrown if type of image data is not supported by YouScope, or if number of pixels in imageData is not in agreement of claimed width and height of the image.
  - createImage
```
public static <T> ImageEvent<T> createImage(T imageData,
                                            int width,
                                            int height)
                                     throws java.lang.NullPointerException,
                                            java.lang.IllegalArgumentException
```
    Creates a new image with the given image data and meta information. The bit depth is set to the maximal bit depth for the given pixel type, i.e. 8bit for bytes, 16bit for shorts, and 32bit for ints.
    
    Parameters:
    
    imageData - Array of bytes, shorts or ints representing the pixel intensities, either of grayscale images or of several bands (colors) or color images.
    
    width - The width of the image in pixels.
    
    height - The height of the image in pixels.
    
    Returns:
    
    Newly created image.
    
    Throws:
    
    java.lang.NullPointerException - Thrown if imageData is null.
    
    java.lang.IllegalArgumentException - Thrown if type of image data is not supported by YouScope, or if number of pixels in imageData is not in agreement of claimed width and height of the image.
  - setTransposeX
```
public void setTransposeX(boolean transpose)
```
    Sets if the x-direction of images made by this camera should be transposed.
    
    Parameters:
    
    transpose - True, if the x-direction should be transposed.
  - setTransposeY
```
public void setTransposeY(boolean transpose)
```
    Sets if the y-direction of images made by this camera should be transposed.
    
    Parameters:
    
    transpose - True, if the y-direction should be transposed
  - setSwitchXY
```
public void setSwitchXY(boolean switchXY)
```
    Sets if the x and the y direction should be switched for images made by this camera.
    
    Parameters:
    
    switchXY - True, if the x and y direction should be switched.
  - isTransposeX
```
public boolean isTransposeX()
```
    Returns if the x-direction of images made by this camera should be transposed.
    
    Returns:
    
    True, if the x-direction is transposed.
  - isTransposeY
```
public boolean isTransposeY()
```
    Returns if the if the y-direction of images made by this camera should be transposed.
    
    Returns:
    
    True, if the y-direction is transposed.
  - isSwitchXY
```
public boolean isSwitchXY()
```
    Returns if the x and the y direction should be switched for images made by this camera.
    
    Returns:
    
    True, if the x and y direction should be switched.
  - getBands
```
public int getBands()
```
    Returns the number of bands (colors in image).
    
    Returns:
    
    Number of bands.
  - setBands
```
public void setBands(int bands)
```
    Sets the number of bands (colors in image).
    
    Parameters:
    
    bands - Number of bands.
  - getImageData
```
public T getImageData()
```
    Returns the pixel data as an array of primitive types (typically byte or short). Note that the pixel values are typically unsigned, whereas typical java operations on them assume them to be signed. This typically implies that one has to upcast them, e.g. byte to short, or short to int.
    
    Returns:
    
    the imageData
  - getWidth
```
public int getWidth()
```
    Returns image width in pixels.
    
    Returns:
    
    image width in pixels.
  - getHeight
```
public int getHeight()
```
    Returns image height in pixels.
    
    Returns:
    
    image height in pixels
  - getBytesPerPixel
```
public int getBytesPerPixel()
```
    Returns the number of bytes used to store each pixel. Typically one or two for grayscale images, and more only for colour images.
    
    Returns:
    
    Number of bytes used to store a pixel.
  - getBitDepth
```
public int getBitDepth()
```
    Returns the bit dept. This has to be smaller or equal to getBytesPerPixel()*8. For example, 12bit/pixel images are typically stored in 2 bytes/pixel, which would allow for up to 16bit depth. However, 12bit pixels typically only use the lower 12bit of the 16bit available in two bytes.
    
    Returns:
    
    the bitDepth of the image.
  - getMaxIntensity
```
public long getMaxIntensity()
```
    Returns the maximal intensity a pixel can have. This intensity is equal to 2^(getBitDepth())-1. Note that getImageData() returns unsigned values.
    
    Returns:
    
    Maximal pixel intensity.
  - setExecutionInformation
```
public void setExecutionInformation(ExecutionInformation executionInformation)
```
    Sets the information of how often the image producing job was already executed when producing the image.
    
    Parameters:
    
    executionInformation - Information about producing job's evaluation times, or null.
  - getExecutionInformation
```
public ExecutionInformation getExecutionInformation()
```
    Returns the information of how often the image producing job was already executed when producing the image.
    
    Returns:
    
    executionInformation Information about producing job's evaluation times, or null.
  - setPositionInformation
```
public void setPositionInformation(PositionInformation positionInformation)
```
    Sets the information about the logical position this image was made in.
    
    Parameters:
    
    positionInformation - Logical description of position, or null.
  - getPositionInformation
```
public PositionInformation getPositionInformation()
```
    Returns the information about the logical position this image was made in.
    
    Returns:
    
    Logical description of position, or null.
  - setCreationTime
```
public void setCreationTime(long creationTime)
```
    Sets the time milliseconds since January 1, 1970, 00:00:00 GMT when the image was created (see Date.getTime()).
    
    Parameters:
    
    creationTime - The time when image was created.
  - getCreationTime
```
public long getCreationTime()
```
    Returns the time milliseconds since January 1, 1970, 00:00:00 GMT when the image was created (see Date.Date(long)).
    
    Returns:
    
    The time when image was created.
  - setCamera
```
public void setCamera(java.lang.String camera)
```
    Set the name of the camera with which the image was taken.
    
    Parameters:
    
    camera - the name of the camera which took the image.
  - getCamera
```
public java.lang.String getCamera()
```
    Returns the name of the camera which took the image.
    
    Returns:
    
    camera name.
  - setChannelGroup
```
public void setChannelGroup(java.lang.String channelGroup)
```
    Sets the channel group in which the image was made. Together with setChannel(String), this identifies the channel the image was taken in.
    
    Parameters:
    
    channelGroup - the channel group the image was taken in.
  - getChannelGroup
```
public java.lang.String getChannelGroup()
```
    Returns the channel group in which the image was made. Together with getChannel(), this identifies the channel the image was taken in.
    
    Returns:
    
    the channel group the image was taken in.
  - setChannel
```
public void setChannel(java.lang.String channel)
```
    Sets the channel in which the image was made. Together with setChannelGroup(String), this identifies the channel the image was taken in.
    
    Parameters:
    
    channel - the channel the image was taken in.
  - getChannel
```
public java.lang.String getChannel()
```
    Returns the channel in which the image was made. Together with getChannelGroup(), this identifies the channel the image was taken in.
    
    Returns:
    
    the channel the image was taken in.
  - clone
```
public ImageEvent<T> clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ImageEvent<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getImageDataArrayType

getImageDataType

createImage

createImage

setTransposeX

setTransposeY

setSwitchXY

isTransposeX

isTransposeY

isSwitchXY

getBands

setBands

getImageData

getWidth

getHeight

getBytesPerPixel

getBitDepth

getMaxIntensity

setExecutionInformation

getExecutionInformation

setPositionInformation

getPositionInformation

setCreationTime

getCreationTime

setCamera

getCamera

setChannelGroup

getChannelGroup

setChannel

getChannel

clone

hashCode

equals