/usr/share/gnudatalanguage/coyote/cgplots.pro is in gdl-coyote 2016.11.13-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | ; docformat = 'rst'
;
; NAME:
; cgPlotS
;
; PURPOSE:
; The purpose of cgPlotS is to create a wrapper for the traditional IDL graphics
; command, PlotS. The primary purpose of this is to create plot commands that work
; and look identically both on the display and in PostScript files.
;
;******************************************************************************************;
; ;
; Copyright (c) 2010, by Fanning Software Consulting, Inc. All rights reserved. ;
; ;
; Redistribution and use in source and binary forms, with or without ;
; modification, are permitted provided that the following conditions are met: ;
; ;
; * Redistributions of source code must retain the above copyright ;
; notice, this list of conditions and the following disclaimer. ;
; * Redistributions in binary form must reproduce the above copyright ;
; notice, this list of conditions and the following disclaimer in the ;
; documentation and/or other materials provided with the distribution. ;
; * Neither the name of Fanning Software Consulting, Inc. nor the names of its ;
; contributors may be used to endorse or promote products derived from this ;
; software without specific prior written permission. ;
; ;
; THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY ;
; EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ;
; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT ;
; SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, ;
; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;
; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; ;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ;
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ;
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;
;******************************************************************************************;
;
;+
; The purpose of cgPlotS is to create a wrapper for the traditional IDL graphics
; command, PlotS. The primary purpose of this is to create plot commands that work
; and look identically both on the display and in PostScript files.
;
; The program requires the `Coyote Library <http://www.idlcoyote.com/documents/programs.php>`
; to be installed on your machine.
;
; :Categories:
; Graphics
;
; :Params:
; X_: in, required, type=any
; A vector or scalar argument providing the X components of the points to be
; drawn or connected. May be a 2xN or 3xN array, if Y and Z parameters are
; not used.
; Y_: in, optional, type=any
; A vector or scalar argument providing the Y components of the points to be
; drawn or connected.
; Z_: in, optional, type=any
; A vector or scalar argument providing the Z components of the points to be
; drawn or connected.
;
; :Keywords:
; addcmd: in, optional, type=boolean, default=0
; Set this keyword to add the command to an cgWindow display.
; color: in, optional, type=string/integer, default='opposite'
; If this keyword is a string, the name of the data color.
; Color names are those used with cgColor. Otherwise, the keyword is assumed
; to be a color index into the current color table. May be a vector of the same
; length as X.
; map_object: in, optional, type=object
; If you are drawing on a map projection set up with Map_Proj_Init
; and using projected meter space, rather than lat/lon space, then you can use this
; keyword to provide a cgMap object that will allow you to convert the `x` and `y`
; parameters from longitude and latitude, respectively, to projected meter space
; before drawing. X and Y must both be present.
; psym: in, optional
; Any symbol value supported by the Coyote Library routine cgSYMCAT. In particular, an
; integer or integer array the same length as X with values between 0 and 46. The keyword
; may also be specified as a symbol name or names. If using symbol names, the symbol cannot
; be set to a negative value. See `cgSymCat` for details.
; symcolor: in, optional, type=string/integer/vector, default=COLOR
; If this keyword is a string, the name of the symbol color. By default, same as COLOR.
; Otherwise, the keyword is assumed to be a color index into the current color table.
; May be a vector of the same length as X.
; 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.
; window: in, optional, type=boolean, default=0
; Set this keyword to add the command to the current cgWindow application.
; _extra: in, optional, type=any
; Any `IDL PlotS keyword <http://www.exelisvis.com/docs/PLOTS_Procedure.html>`
; not defined here is allowed in the program.
;
; :Examples:
; Use like the IDL PLOTS command::
; cgPlot, Findgen(11)
; cgPlotS, !X.CRange, [5,5], LINESTYLE=2, THICK=2, COLOR='red'
;
; Use vectors for symbols and colors::
; seed = -3L
; x = Randomu(seed, 5) * 9 + 0.5
; x = x[Sort(x)]
; y = Randomu(seed, 5) * 9 + 0.5
; cgPlot, x, y, /NoData
; colors = ['red6', 'blu6', 'grn6', 'dodger blue', 'orange']
; symbols = Indgen(5)+14
; cgPlots, x, y, PSYM=symbols, Color=colors, SymSize=2
;
; :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, 12 November 2010. DWF.
; Added SYMCOLOR keyword. PSYM accepts all values from cgSYMCAT. SYMCOLOR and SYMSIZE
; keywords can be vectors the size of x. 15 November 2010. DWF
; Added ability to support COLOR keyword as a vector the size of x. 15 November 2010. DWF
; Now setting decomposition state by calling cgSetColorState. 16 November 2010. DWF.
; Final color table restoration skipped in Z-graphics buffer. 17 November 2010. DWF.
; Changes so that color variables don't change type. 23 Nov 2010. DWF.
; Modified to use decomposed color, if possible. 24 Dec 2010. DWF.
; Whoops! Programming is like herding cats! 29 Dec 2010. DWF.
; In some cases, I was turning BYTE values to strings without converting to
; INTEGERS first. 30 Dec 2010. DWF.
; Moved setting to decomposed color before color selection process to avoid PostScript
; background problems when passed 24-bit color integers. 12 Jan 2011. DWF.
; Added WINDOW keyword. 24 Jan 2011. DWF.
; Made a modification that allows THICK and COLOR keywords apply to symbols, too. 24 Feb 2011. DWF.
; Modified error handler to restore the entry decomposition state if there is an error. 17 March 2011. DWF
; Fixed a problem in which the colors of the line was not accurate in some cases. 29 November 2011. DWF.
; Added the MAP_OBJECT keyword for plotting on map projections. 2 Jan 2012. DWF.
; Made sure the map coordinate system is established before drawing if a map object is passed
; into the program. 26 June 2012. DWF.
; Added the ability to specify the PSYM keyword as a string. 20 July 2012. DWF.
; Added a check for a window to draw into, if needed. 8 July 2012. DWF.
; Loop counter didn't assume someone would pass in 2D array of XY pairs. Fixed. 31 Jan 2013. DWF.
; Added the ability to pass a vector of values via the PSYM keyword. 10 Oct 2014. DWF
; Changes on 10 Oct 2014 caused some problems with cgMap_Grid, which calls cgPlots with arguments
; that are not the same length. Added code to make sure all positional parameters are the same
; length. 16 Oct 2014. DWF.
; Running into more problems from 10 Oct 2014 changes. Have to unpack 2D and 3D data passed in as single parameter.
; Changed the default value for the symbol size to !P.Symsize rather than 1.0. 17 April 2015. DWF.
;
; :Copyright:
; Copyright (c) 2010-2014, Fanning Software Consulting, Inc.
;-
PRO cgPlotS, x_, y_, z_, $
ADDCMD=addcmd, $
COLOR=scolor, $
MAP_OBJECT=map_object, $
PSYM=psymIn, $
SYMCOLOR=ssymcolor, $
SYMSIZE=symsize, $
WINDOW=window, $
_EXTRA=extra
Compile_Opt idl2
; Error handling.
Catch, theError
IF theError NE 0 THEN BEGIN
Catch, /CANCEL
void = cgErrorMsg()
IF Keyword_Set(dataSwitch) THEN x_ = Temporary(y_)
IF Keyword_Set(restore) THEN x_ = tempData
IF N_Elements(currentState) NE 0 THEN cgSetColorState, currentState
RETURN
ENDIF
; Did the user pass parameters?
IF N_Params() EQ 0 THEN BEGIN
Print, 'USE SYNTAX: cgPlotS, x, y, [z]'
RETURN
ENDIF
; Check to see if psymIn is a string. If so, covert it here.
IF N_Elements(psymIn) NE 0 THEN BEGIN
IF Size(psymIn, /TNAME) EQ 'STRING' THEN BEGIN
names = cgSymCat(/Names)
psym = IntArr(N_Elements(psymIn))
FOR j=0,N_Elements(psymIn)-1 DO BEGIN
index = Where(STRUPCASE(StrCompress(names, /REMOVE_ALL)) EQ STRUPCASE(StrCompress(psymIN[j], /REMOVE_ALL)), count)
IF count GT 0 THEN psym[j] = index[0] ELSE Message, 'Cannot resolve the PSYM value: ' + psymIn[j]
ENDFOR
ENDIF ELSE psym = psymIn
ENDIF
; Should this be added to a resizeable graphics window?
IF (Keyword_Set(window) OR Keyword_Set(addcmd)) AND ((!D.Flags AND 256) NE 0) THEN BEGIN
cgWindow, 'cgPlotS', x_, y_, z_, $
COLOR=scolor, $
MAP_OBJECT=map_object, $
PSYM=psym, $
SYMCOLOR=ssymcolor, $
SYMSIZE=symsize, $
ADDCMD=1, $
_EXTRA=extra
RETURN
ENDIF
; Need a window?
IF ((!D.Flags AND 256) NE 0) && (!D.Window LT 0) THEN cgDisplay
; Set up PostScript device for working with colors.
IF !D.Name EQ 'PS' THEN Device, COLOR=1, BITS_PER_PIXEL=8
; The PLOTS command requires at least two positional parameters.
; If we only have one, then we will fake it, as we do in a line
; plot.
n_params = N_Params()
IF (n_params EQ 1) && Size(x_, /N_DIMENSIONS) EQ 1 THEN BEGIN
temp = x_
x_ = Indgen(N_Elements(x_))
y_ = Temporary(temp)
n_params = 2
dataSwitch = 1
ENDIF
; If we have one parameter, but it is two or three dimensional, extract the data.
restore = 0
IF (n_params EQ 1) && Size(x_, /N_DIMENSIONS) EQ 2 THEN BEGIN
dims = Size(x_, /DIMENSIONS)
IF dims[0] EQ 2 THEN BEGIN
tempData = x_
x_ = Reform(tempData[0,*])
y_ = Reform(tempData[1,*])
n_params = 2
restore = 1
ENDIF
IF dims[0] EQ 3 THEN BEGIN
tempData = x_
x_ = Reform(tempData[0,*])
y_ = Reform(tempData[1,*])
z_ = Reform(tempData[2,*])
n_params = 3
restore = 1
ENDIF
ENDIF
; Going to draw the lines in decomposed color, if possible
cgSetColorState, 1, CurrentState=currentState
; If current state is "indexed color" and colors are represented as long integers then "fix" them.
IF (currentState EQ 0) THEN BEGIN
IF Size(scolor, /TNAME) EQ 'LONG' THEN scolor = Fix(scolor)
IF Size(ssymcolor, /TNAME) EQ 'LONG' THEN ssymcolor = Fix(ssymcolor)
ENDIF
; Choose a color.
color = cgDefaultColor(sColor, DEFAULT='OPPOSITE')
symcolor = cgDefaultColor(ssymcolor, DEFAULT=color)
; Check parameters and keywords.
IF N_Elements(psym) EQ 0 THEN psym = 0
IF N_Elements(symsize) EQ 0 THEN symsize = !P.SymSize
; Be sure the vectors are the right length and are defined.
CASE n_params OF
2: BEGIN
maxsize = Max([N_Elements(x_), N_Elements(y_)], maxIndex)
IF (maxIndex EQ 0) && (N_Elements(y_) EQ 1) THEN y = Replicate(y_, N_Elements(x_))
IF (maxIndex EQ 1) && (N_Elements(x_) EQ 1) THEN x = Replicate(x_, N_Elements(y_))
END
3: BEGIN
maxsize = Max([N_Elements(x_), N_Elements(y_), N_Elements(z_)], maxIndex)
IF (maxIndex EQ 0) && (N_Elements(y_) EQ 1) THEN y = Replicate(y_, N_Elements(x_))
IF (maxIndex EQ 0) && (N_Elements(z_) EQ 1) THEN z = Replicate(z_, N_Elements(x_))
IF (maxIndex EQ 0) THEN x = x_
IF (maxIndex EQ 1) && (N_Elements(x_) EQ 1) THEN x = Replicate(x_, N_Elements(y_))
IF (maxIndex EQ 1) && (N_Elements(z_) EQ 1) THEN z = Replicate(z_, N_Elements(y_))
IF (maxIndex EQ 1) THEN y = y_
IF (maxIndex EQ 2) && (N_Elements(x_) EQ 1) THEN x = Replicate(x_, N_Elements(z_))
IF (maxIndex EQ 2) && (N_Elements(y_) EQ 1) THEN y = Replicate(y_, N_Elements(z_))
IF (maxIndex EQ 2) THEN z = z_
END
ENDCASE
; Make sure you have everything accounted for.
IF N_Elements(x) EQ 0 THEN x = x_
IF N_Elements(y) EQ 0 THEN y = y_
IF (n_params EQ 3) && (N_Elements(z) EQ 0) THEN z = z_
; Check other variables.
xsize = N_Elements(x)
IF N_Elements(color) GT 1 THEN BEGIN
IF N_Elements(color) NE xsize THEN $
Message, 'COLOR vector must contain the same number of elements as the data.'
ENDIF
IF N_Elements(symcolor) GT 1 THEN BEGIN
IF N_Elements(symcolor) NE xsize THEN $
Message, 'SYMCOLOR vector must contain the same number of elements as the data.'
ENDIF
IF N_Elements(symsize) GT 1 THEN BEGIN
IF N_Elements(symsize) NE xsize THEN $
Message, 'SYMSIZE vector must contain the same number of elements as the data.'
ENDIF
IF N_Elements(psym) GT 1 THEN BEGIN
IF N_Elements(psym) NE xsize THEN $
Message, 'PSYM vector must contain the same number of elements as the data.'
ENDIF
; Do you have a map obect? If so, you need both an X and a Y vector.
; Convert from lon/lat to projected XY.
IF Obj_Valid(map_object) && (N_Params() EQ 2) THEN BEGIN
xy = map_object -> Forward(x, y)
xmap = Reform(xy[0,*])
ymap = Reform(xy[1,*])
ENDIF
; Get current color table vectors.
TVLCT, rr, gg, bb, /Get
; Draw the line or symbol.
IF N_Elements(color) EQ 1 THEN BEGIN
; Load a color, if needed.
IF Size(color, /TNAME) EQ 'STRING' THEN color = cgColor(color)
CASE n_params OF
1: IF psym[0] LE 0 THEN PlotS, x, Color=color, _STRICT_EXTRA=extra
2: BEGIN
IF Obj_Valid(map_object) && (N_Params() EQ 2) THEN BEGIN
IF psym[0] LE 0 THEN BEGIN
map_object -> Draw, /NoGraphics
PlotS, xmap, ymap, Color=color, _STRICT_EXTRA=extra
ENDIF
ENDIF ELSE BEGIN
IF psym[0] LE 0 THEN PlotS, x, y, Color=color, _STRICT_EXTRA=extra
ENDELSE
END
3: IF psym[0] LE 0 THEN PlotS, x, y, z, Color=color, _STRICT_EXTRA=extra
ENDCASE
ENDIF ELSE BEGIN
FOR j=0,xsize-2 DO BEGIN
thisColor = color[j]
IF Size(thisColor, /TNAME) EQ 'STRING' THEN thisColor = cgColor(thisColor)
CASE n_params OF
1: IF psym[0] LE 0 THEN BEGIN
PlotS, [x[0,j],x[0,j+1]], [x[1,j],x[1,j+1]], [x[2,j],x[2,j+1]], $
Color=thisColor, _STRICT_EXTRA=extra
END
2: IF psym[0] LE 0 THEN BEGIN
IF Obj_Valid(map_object) && (N_Params() EQ 2) THEN BEGIN
map_object -> Draw, /NoGraphics
PlotS, [xmap[j],xmap[j+1]], [ymap[j], ymap[j+1]], $
Color=thisColor, _STRICT_EXTRA=extra
ENDIF ELSE BEGIN
PlotS, [x[j],x[j+1]], [y[j], y[j+1]], $
Color=thisColor, _STRICT_EXTRA=extra
ENDELSE
ENDIF
3: IF psym[0] LE 0 THEN BEGIN
PlotS, [x[j],x[j+1]], [y[j], y[j+1]], [z[j], z[j+1]], $
Color=thisColor, _STRICT_EXTRA=extra
ENDIF
ENDCASE
ENDFOR
ENDELSE
; Draw the symbol, if required.
FOR j=0,xsize-1 DO BEGIN
; Get information about the symbol you are drawing.
IF N_Elements(symcolor) GT 1 THEN thisColor = symcolor[j] ELSE thisColor = symcolor
IF Size(thisColor, /TNAME) EQ 'STRING' THEN thisColor = cgColor(thisColor)
IF N_Elements(symsize) GT 1 THEN thisSize = symsize[j] ELSE thisSize = symsize
IF N_Elements(psym) GT 1 THEN thisSymbol = psym[j] ELSE thisSymbol = psym
IF Abs(thisSymbol) GT 0 THEN BEGIN
CASE n_params OF
1: BEGIN
PlotS, x[*,j], COLOR=thisColor, PSYM=cgSymCat(Abs(thisSymbol), _EXTRA=extra, COLOR=thisColor), $
SYMSIZE=thisSize, _STRICT_EXTRA=extra
END
2: BEGIN
IF Obj_Valid(map_object) && (N_Params() EQ 2) THEN BEGIN
map_object -> Draw, /NoGraphics
PlotS, xmap[j], ymap[j], COLOR=thisColor, PSYM=cgSymCat(Abs(thisSymbol), _EXTRA=extra, COLOR=thisColor), $
SYMSIZE=thisSize, _STRICT_EXTRA=extra
ENDIF ELSE BEGIN
PlotS, x[j], y[j], COLOR=thisColor, PSYM=cgSymCat(Abs(thisSymbol), _EXTRA=extra, COLOR=thisColor), $
SYMSIZE=thisSize, _STRICT_EXTRA=extra
ENDELSE
END
3: BEGIN
PlotS, x[j], y[j], z[j], COLOR=thisColor, PSYM=cgSymCat(Abs(thisSymbol), _EXTRA=extra, COLOR=thisColor), $
SYMSIZE=thisSize, _STRICT_EXTRA=extra
END
ENDCASE
ENDIF
ENDFOR
; Restore the decomposed state if you can.
cgSetColorState, currentState
; Restore the color table. Can't do this for the Z-buffer or
; the snap shot will be incorrect.
IF (!D.Name NE 'Z') THEN TVLCT, rr, gg, bb
; If you switched data, switch it back.
IF Keyword_Set(dataSwitch) THEN x_ = Temporary(y_)
; If you unpacked the data, restore it.
IF Keyword_Set(restore) THEN x_ = Temporary(tempData)
END
|