org.robokind.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
 int getChannelCount()
          Returns the number of color channels in the image.
 int getHeight()
          Returns the Image height.
 Image getImage()
          Returns the Image for this event.
 long getImageId()
          Returns the id associated with the given image.
 String getImageSourceId()
          Returns the id of the source of the Image.
 long getImageTimestampUTC()
          Returns the timestamp of the Image.
 int getWidth()
          Returns the Image width.
 int 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;

getImageTimestampUTC

long getImageTimestampUTC()
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

int getWidth()
Returns the Image width.

Returns:
Image width

getHeight

int getHeight()
Returns the Image height.

Returns:
Image height

getChannelCount

int getChannelCount()
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

int 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

getImage

Image getImage()
Returns the Image for this event.

Returns:
Image for this event


Copyright © 2011. All Rights Reserved.