Class ImageDisplay

Overview

Image displays are components used to display the contents of images. Component methods may be used to position these on the page, but specialized methods such as ImageDisplaySetImageRect are supplied to allow the position and size of the image portion of the display ( excluding borders, captions, etc ) to be specified. As with other methods dealing with coordinates, use those ending in 'InView' to find the coordinates of the display as seen in a window. Currently only raster and rgb image displays have a well-defined coordinate system for child components, and this coordinate system has its origin at the top-left of the displayed image, and units equivalent to image pixels.

Image display types may be one of the following

-2 - Best image display. This is only used when setting a display type, and it produces line plots for 1-d images, and raster or rgb displays for 2-d data.

1 - Raster image display

2 - Surface plot image display

3 - Line plot image display

4 - RGB image display

7 - Spreadsheet image display

8 - Surface model image display ( currently only available on the Macintosh ).

Methods

void ImageDisplayAccumulateROIsToMask( ImageDisplay imgDisp, ImageReference mask, Number top, Number left, Number bottom, Number right, Number mask_val )

Sets mask to mask_val at points in imageDisplay's rois

 

void ImageDisplayAddKeyListener( ImageDisplay imgDisp, String listener_key, String listener_script )

Adds the listener_script to the key listener list under the tag listener_key.

 

void ImageDisplayAddROI( ImageDisplay imgDisp, ROI roi )

Adds the roi to this image display.

 

void ImageDisplayChangeDisplayType( ImageDisplay imgDisp, Number new_type )

Changes the type of the image display.

 

Number ImageDisplayCountROIs( ImageDisplay imgDisp )

Returns the number of ROIs on this image display.

 

void ImageDisplayDeleteROI( ImageDisplay imgDisp, ROI roi )

Deletes the roi from this image display.

 

Boolean ImageDisplayDoesROIExist( ImageDisplay imgDisp, String name )

Determines whether the given ROI exists on this image display.

 

void ImageDisplayExportToFile( ImageDisplay imgDisp, String format, String file_name )

Exports the display to the file 'file_name' using the format 'format'.

 

ImageReference ImageDisplayGetBufferedImage( ImageDisplay imgDisp )

Gets the image resulting from the contrast transformation.

 

Number ImageDisplayGetComplexMode( ImageDisplay imgDisp )

Gets the complex mode of the display.

 

Number ImageDisplayGetComplexModeRange( ImageDisplay imgDisp )

Gets the parameter used in converting complex to real.

 

void ImageDisplayGetContrastLimits( ImageDisplay imgDisp, NumberVariable low, NumberVariable high )

Gets the contrast limits of the display.

 

Number ImageDisplayGetContrastMode( ImageDisplay imgDisp )

Returns the contrast mode.

 

void ImageDisplayGetContrastParameters( ImageDisplay imgDisp, NumberVariable bright, NumberVariable contrast )

Gets the parameters for the contrast mode.

 

ImageReference ImageDisplayGetDisplayedImage( ImageDisplay imgDisp )

Gets the image that is actually displayed in the image display.

 

void ImageDisplayGetDisplayedLayers( ImageDisplay imgDisp, NumberVariable start, NumberVariable end )

Gets the layers that are summed into the display.

 

Number ImageDisplayGetDisplayType( ImageDisplay imgDisp )

Returns type of the image display.

 

Boolean ImageDisplayGetDoAutoSurvey( ImageDisplay imgDisp )

Determines whether min and max are determined automatically.

 

ImageReference ImageDisplayGetExportImage( ImageDisplay imgDisp, Number mode, ImageDisplay clut_display )

Gets the image representation of the image as it appears on the screen at full resolution.

 

ImageReference ImageDisplayGetImage( ImageDisplay imgDisp )

Returns the single image displayed by the image display.

 

void ImageDisplayGetImageAdjustRect( ImageDisplay imgDisp, NumberVariable top, NumberVariable left, NumberVariable bottom, NumberVariable right )

Returns the image display outside the image rect

 

void ImageDisplayGetImageAdjustRectInView( ImageDisplay imgDisp, NumberVariable top, NumberVariable left, NumberVariable bottom, NumberVariable right )

Returns the image display outside the image rect in view coordinates

 

void ImageDisplayGetImageRect( ImageDisplay imgDisp, NumberVariable top, NumberVariable left, NumberVariable bottom, NumberVariable right )

Gets the bounds of the image in the image display.

 

void ImageDisplayGetImageRectInView( ImageDisplay imgDisp, NumberVariable top, NumberVariable left, NumberVariable bottom, NumberVariable right )

Gets the bounds of the image in the image display in view coordinates.

 

ImageReference ImageDisplayGetInputColorTable( ImageDisplay imgDisp )

Gets the input color table for the display.

 

ImageReference ImageDisplayGetIntensityTransformation( ImageDisplay imgDisp )

Gets the ITT of the display.

 

Number ImageDisplayGetMinimumContrast( ImageDisplay imgDisp )

Gets the minimum contrast of the display.

 

ImageReference ImageDisplayGetOutputColorTable( ImageDisplay imgDisp )

Gets the output color table for the display.

 

ROI ImageDisplayGetROI( ImageDisplay imgDisp, Number index )

Returns the given ROI on this image display.

 

Number ImageDisplayGetROISelectionStyle( ImageDisplay imgDisp, ROI r )

Gets the selection style of the roi in the imag display.

 

Number ImageDisplayGetSurveyTechnique( ImageDisplay imgDisp )

Gets the survey technique of the display.

 

Boolean ImageDisplayIsCaptionOn( ImageDisplay imgDisp )

Returns true if captions are drawn.

 

Boolean ImageDisplayIsROISelected( ImageDisplay imgDisp, ROI roi )

Determines whether the given ROI is selected on this image display.

 

Boolean ImageDisplayIsValid( ImageDisplay imgDisp )

Returns true if 'imageDisplay' points to a valid object.

 

ROI ImageDisplayLookupROI( ImageDisplay imgDisp, String name )

Returns the given ROI on this image display.

 

ROI ImageDisplayLookupROIByID( ImageDisplay imgDisp, Number id )

Returns the ROI with the given id on this image display.

 

void ImageDisplayRemoveKeyListener( ImageDisplay imgDisp, String listener_key )

Removes the listener script with the tag listener_key from the key listener list.

 

void ImageDisplaySetCaptionOn( ImageDisplay imgDisp, Boolean on )

Sets whether to draw captions.

 

void ImageDisplaySetComplexMode( ImageDisplay imgDisp, Number mode )

Sets the complex mode of the display.

 

void ImageDisplaySetComplexModeRange( ImageDisplay imgDisp, Number range )

Sets the parameter used in converting complex to real.

 

void ImageDisplaySetContrastLimits( ImageDisplay imgDisp, Number low, Number hight )

Sets the contrast limits of the display.

 

void ImageDisplaySetContrastMode( ImageDisplay imgDisp, Number mode )

Sets the contrast mode.

 

void ImageDisplaySetContrastParameters( ImageDisplay imgDisp, Number bright, Number contrast )

Gets the parameters for the contrast mode.

 

void ImageDisplaySetDisplayedLayers( ImageDisplay imgDisp, Number start, Number end )

Sets the layers that are summed into the display.

 

void ImageDisplaySetDoAutoSurvey( ImageDisplay imgDisp, Boolean do_survey )

Sets whether min and max are determined automatically.

 

void ImageDisplaySetImageRect( ImageDisplay imgDisp, Number top, Number left, Number bottom, Number right )

Sets the bounds of the image part of the image display.

 

void ImageDisplaySetInputColorTable( ImageDisplay imgDisp, ImageReference clut )

Sets the input color table of the display.

 

void ImageDisplaySetIntensityTransformation( ImageDisplay imgDisp, ImageReference itt )

Sets the ITT of the display.

 

void ImageDisplaySetMinimumContrast( ImageDisplay imgDisp, Number contrast )

Sets the minimum contrast of the display.

 

void ImageDisplaySetROISelected( ImageDisplay imgDisp, ROI roi, Boolean select )

Sets the selection status of the region of interest in the image display.

 

void ImageDisplaySetROISelectionStyle( ImageDisplay imgDisp, ROI r, Number style )

Sets the selection style of the roi in the imag display.

 

void ImageDisplaySetSurveyTechnique( ImageDisplay imgDisp, Number tech )

Sets the survey technique of the display.

 

Related Functions

ImageDisplay =( ImageDisplay, Component )

 

ImageDisplay =( ImageDisplay, ! )

 

ImageDisplay =( ImageDisplay, ImageDisplay )

 

void ApplyDataBar( ImageDisplay imgDisp )

Applies a data bar to the image.

 

ImageDisplay ImageDisplayNullify( ! )

 

ImageDisplay ImageDocumentAddImageDisplay( ImageDocument imgDoc, ImageReference image, Number displayType )

Adds the given image and an image display for it of the given type.

 

ImageDisplay ImageDocumentGetImageModeDisplay( ImageDocument imgDoc )

Gets the image display targeted by the current image mode.

 

ImageReference NewLiveFFT( ImageDisplay imageDisplay, ROI roi, Boolean reduce )

Creates a new live fft of the area in 'roi', that is reduced if 'reduce' is 'true'

 

ImageReference NewLiveHistogram( ImageDisplay imageDisplay, ROI roi, Number num_channels )

Creates a new live histogram of the area in 'roi', binned by 'num_channels'

 

ImageReference NewLiveProfile( ImageDisplay imageDisplay, Number start_x, Number start_y, Number end_x, Number end_y, Number width )

Creates a new live profile from (start_x,start_y) to (end_x,end_y)