jsky.image.gui
Interface GraphicsImageDisplay

All Superinterfaces:
BasicImageDisplay, BasicImageReadableProcessor
All Known Subinterfaces:
MainImageDisplay
All Known Implementing Classes:
DivaGraphicsImageDisplay, DivaMainImageDisplay, NavigatorImageDisplay

public interface GraphicsImageDisplay
extends BasicImageDisplay

This defines the interface for a widget that can display images and draw graphics overlays.

Version:
$Revision: 1.5 $
Author:
Allan Brighton, Peter W. Draper

Method Summary
 void blankImage(double ra, double dec)
          Display a blank image with the given center coordinates.
 void clear()
          Clear the image display, freeing up any resources currently used by the image so that they can be garbage collected.
 CanvasGraphics getCanvasGraphics()
          Return an object to be used for drawing persistent graphics over the image
 FITSImage getFitsImage()
          If the current image is in FITS format, return the FITSImage object managing it, otherwise return null.
 double getPixelValue(Point2D.Double p, int band)
          Return the value of the pixel in the given band at the given user coordinates
 double[] getPixelValues(Rectangle region, int band)
          Return an array containing the values of the pixels in the given band in the given user coordinates region.
 boolean isClear()
          Return true if the image has been cleared.
 
Methods inherited from interface jsky.image.gui.BasicImageDisplay
addImageGraphicsHandler, getCanvas, getCoordinateConverter, getDisplayImage, getImage, getImageHeight, getImageProcessor, getImageWidth, getInterpolation, getOrigin, getScale, getScaleHints, getVisibleArea, getWCS, isAutoCenterImage, isImmediateMode, isInitialized, isPrescaled, isWCS, removeImageGraphicsHandler, scaleToFit, setAutoCenterImage, setImage, setImageProcessor, setImmediateMode, setInterpolation, setOrigin, setPrescaled, setScale, setScaleHints, setWCS, updateImage
 

Method Detail

getCanvasGraphics

CanvasGraphics getCanvasGraphics()
Return an object to be used for drawing persistent graphics over the image


clear

void clear()
Clear the image display, freeing up any resources currently used by the image so that they can be garbage collected.


isClear

boolean isClear()
Return true if the image has been cleared.


blankImage

void blankImage(double ra,
                double dec)
Display a blank image with the given center coordinates.

Parameters:
ra - RA center coordinate in deg J2000
dec - Dec center coordinate in deg J2000

getFitsImage

FITSImage getFitsImage()
If the current image is in FITS format, return the FITSImage object managing it, otherwise return null. (The FITSImage object is available via the "#fits_image" property from the FITS codec, which implements FITS support for JAI.)


getPixelValue

double getPixelValue(Point2D.Double p,
                     int band)
Return the value of the pixel in the given band at the given user coordinates

Specified by:
getPixelValue in interface BasicImageDisplay

getPixelValues

double[] getPixelValues(Rectangle region,
                        int band)
Return an array containing the values of the pixels in the given band in the given user coordinates region. The pixel values are converted to double. Any pixels outside the image bounds are set to the mean image value, if known, otherwise 0.

Parameters:
region - describes the region of the image to get in user coordinates
band - the band of the image to get