CGDRAW_ROI
This procedure draws a region or group of regions, defined by the IDLanROI or
IDLanROIGroup objects, on a direct graphics device. The type of ROI drawn is
based on the TYPE property of a given IDLanROI object. These can be points,
polylines, or filled polygons. This procedure is a Coyote Graphics wrapper for
the built-in IDL procedure DRAW_ROI.
Categories
Graphics
Params
roi: in, required, type=object
The input ROI object. Must be either an IDLanROI object or an IDLanROIGroup
object (if you wish to draw multiple ROIs at the same time).
Keywords
addcmd: in, optional, type=boolean, default=0
Set this keyword to add the command to an cgWindow. Setting this keyword
automatically sets the WINDOW keyword, but the command does not erase the
graphics window as it would normally.
color: in, optional, type=string, default='opposite'
The name of the polygon color. Color names are those used with cgColor.
This value can also be a long integer or a byte or short integer index
into the current color table.
device: in, optional, type=boolean, default=0
Set to indicate the polygon vertices are in device coordinates, rather than data coordinates.
linestyle: in, optional, type=integer, default=0
Set this keyword to the normal linestyle graphics keyword values. The default is a solid line.
normal: in, optional, type=boolean, default=0
Set to indicate the polygon vertices are in normalized coordinates, rather than data coordinates.
outline: in, optional, type=boolean, default=0
Set this keyword to draw the outline of the ROI, rather than the default filled ROI. In this
case cgPlotS will be used to draw the ROI, rather than the built-in IDL procedure Draw_ROI.
psym: in, optional, type=integer
Any normal IDL PSYM values, plus any value supported by the Coyote Library
routine cgSYMCAT. An integer between 0 and 46. May also be specified as a
symbol names. See `cgSymCat` for details.
symsize: in, optional, type=float/vector, default=1.0
A scalar or vector of symbol sizes. Default is 1.0. May be a vector of the same
length as X.
t3d: in, optional, type=boolean, default=0
Set this keyword to use the 3D coordinate system established by !P.T.
thick: in, optional, type=float, default=1.0
window: in, optional, type=boolean, default=0
Set this keyword to add the command to the current cgWindow application.
_ref_extra: in, optional
Any `DRAW_ROI <http://www.exelisvis.com/docs/DRAW_ROI_Procedure.html>` keyword
not defined here may be used
Examples
Download `cgDraw_ROI_Example <http://www.idlcoyote.com/tip_examples/cgdraw_roi_example.pro>'
for an example program illustrating how cgDraw_ROI can be used.
Author
FANNING SOFTWARE CONSULTING::
David W. Fanning
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: david@idlcoyote.com
Coyote's Guide to IDL Programming: http://www.idlcoyote.com
History
Change History::
Written, 11 November 2012. David W. Fanning.
Copyright
Copyright (c) 2012, Fanning Software Consulting, Inc.