org.lsst.ccs.utilities.image

Interface ImagePixelData

All Known Implementing Classes:

GeneratedImage

public interface ImagePixelData

Interface for data that can provide pixel data level image data. This interface allows to access data in a rectangular pixel geometry, pixel by pixel. To simplify matters the returned data samples are of type "int".

Author:

turri

Method Summary

Modifier and Type	Method and Description
int	getHeight() Get the height of the Image.
default double	getMaxValue() Get the maximum value of the contained data.
int	getPixelData(int x, int y) Get the data sample for pixel (x,y).
int	getWidth() Get the width of the Image.

Method Detail

getWidth

int getWidth()

Get the width of the Image.

Returns:

The image width.

getHeight

int getHeight()

Get the height of the Image.

Returns:

The image height.

getPixelData

int getPixelData(int x,
                 int y)

Get the data sample for pixel (x,y).

Parameters:

x - the x coordinate of the pixel.

y - the y coordinate of the pixel.

Returns:

the value of pixel (x,y)

getMaxValue

default double getMaxValue()

Get the maximum value of the contained data. This is used so that we can render the image on the screen in gray scale. Double.NaN should be returned if the maximum value cannot be calculated.

Returns:

The max value of the data if available. Double.NaN otherwise.