org.mechio.api.vision

Interface ImageEvent

public interface ImageEvent

Defines an interface for supplying an Image and metadata. Images are assumed to be uncompressed images with 8-bits per color channel.

Author:

Matthew Stevenson

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	getData()
Integer	getHeight() Returns the Image height.
Long	getImageId() Returns the id associated with the given image.
String	getImageSourceId() Returns the id of the source of the Image.
Long	getImageTimestampMillisecUTC() Returns the timestamp of the Image.
Integer	getNChannels() Returns the number of color channels in the image.
Integer	getWidth() Returns the Image width.
Integer	getWidthStep() Returns the widthstep of the Image.

Method Detail

getImageId

Long getImageId()

Returns the id associated with the given image.

Returns:

id associated with the given image;

getImageTimestampMillisecUTC

Long getImageTimestampMillisecUTC()

Returns the timestamp of the Image.

Returns:

timestamp of the Image

getImageSourceId

String getImageSourceId()

Returns the id of the source of the Image.

Returns:

id of the source of the Image

getWidth

Integer getWidth()

Returns the Image width.

Returns:

Image width

getHeight

Integer getHeight()

Returns the Image height.

Returns:

Image height

getNChannels

Integer getNChannels()

Returns the number of color channels in the image. Grayscaled images will return 1 and RGB images will return 3.

Returns:

number of color channels in the image

getWidthStep

Integer getWidthStep()

Returns the widthstep of the Image. This is the number of bytes in each row of the Image.

Returns:

number of bytes in each row of the Image

getData

ByteBuffer getData()