/usr/share/gnudatalanguage/astrolib/fxbwritm.pro is in gdl-astrolib 2018.02.16+dfsg-1.
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 | PRO FXBWRITM, UNIT, COL, $
D0, D1, D2, D3, D4, D5, D6, D7, D8, D9, $
D10, D11, D12, D13, D14, D15, D16, D17, D18, D19, $
D20, D21, D22, D23, D24, D25, D26, D27, D28, D29, $
D30, D31, D32, D33, D34, D35, D36, D37, D38, D39, $
D40, D41, D42, D43, D44, D45, D46, D47, D48, D49, $
NOIEEE=NOIEEE, NOSCALE=NOSCALE, $
POINTERS=POINTERS, PASS_METHOD=PASS_METHOD, $
ROW=ROW, NANVALUE=NANVALUE, BUFFERSIZE=BUFFERSIZE, $
ERRMSG=ERRMSG, WARNMSG=WARNMSG, STATUS=OUTSTATUS
;+
; NAME:
; FXBWRITM
; PURPOSE:
; Write multiple columns/rows to a disk FITS binary table file.
; EXPLANATION :
; A call to FXBWRITM will write multiple rows and multiple
; columns to a binary table in a single procedure call. Up to
; fifty columns may be read in a single pass. The file should
; have already been opened with FXBOPEN (with write access) or
; FXBCREATE. FXBWRITM optimizes writing multiple columns by
; first writing a large chunk of data to the FITS file all at
; once. FXBWRITM cannot write variable-length arrays; use
; FXBWRITE instead.
;
; The number of columns is limited to 50 if data are passed by
; positional argument. However, this limitation can be overcome
; by passing pointers to FXBWRITM. The user should set the PASS_METHOD
; keyword to 'POINTER' as appropriate, and an array of pointers to
; the data in the POINTERS keyword. The user is responsible for freeing
; the pointers.
;
; CALLING SEQUENCE:
; FXBWRITM, UNIT, COL, D0, D1, D2, ..., [ ROW= , PASS_METHOD, NANVALUE=
; POINTERS=, BUFFERSIZE= ]
;
; INPUT PARAMETERS:
; UNIT = Logical unit number corresponding to the file containing the
; binary table.
; D0,..D49= An IDL data array to be written to the file, one for
; each column. These parameters will be igonred if data
; is passed through the POINTERS keyword.
; COL = Column in the binary table to place data in. May be either
; a list of column numbers where the first column is one, or
; a string list of column names.
; OPTIONAL INPUT KEYWORDS:
; ROW = Either row number in the binary table to write data to,
; starting from row one, or a two element array containing a
; range of row numbers to write. If not passed, then
; the entire column is written.
; NANVALUE= Value signalling data dropout. All points corresponding to
; this value are set to be IEEE NaN (not-a-number). Ignored
; unless DATA is of type float, double-precision or complex.
; NOSCALE = If set, then TSCAL/TZERO values are ignored, and data is
; written exactly as supplied.
; PASS_METHOD = A scalar string indicating method of passing
; data to FXBWRITM. One of 'ARGUMENT' (indicating
; pass by positional argument), or'POINTER' (indicating
; passing an array of pointers by the POINTERS
; keyword).
; Default: 'ARGUMENT'
; POINTERS = If PASS_METHOD is 'POINTER' then the user must pass
; an array of IDL pointers to this keyword, one for
; each column. Ultimately the user is responsible for
; deallocating pointers.
; BUFFERSIZE = Data are transferred in chunks to conserve
; memory. This is the size in bytes of each chunk.
; If a value of zero is given, then all of the data
; are transferred in one pass. Default is 32768 (32
; kB).
; OPTIONAL OUTPUT KEYWORDS:
; ERRMSG = If defined and passed, then any error messages will be
; returned to the user in this parameter rather than
; depending on the MESSAGE routine in IDL. If no errors are
; encountered, then a null string is returned. In order to
; use this feature, ERRMSG must be defined first, e.g.
;
; ERRMSG = ''
; FXBWRITE, ERRMSG=ERRMSG, ...
; IF ERRMSG NE '' THEN ...
; WARNMSG = Messages which are considered to be non-fatal
; "warnings" are returned in this output string.
; STATUS = An output array containing the status for each
; read, 1 meaning success and 0 meaning failure.
;
; PROCEDURE CALLS:
; None.
; EXAMPLE:
; Write a binary table 'sample.fits' giving 43 X,Y positions and a
; 21 x 21 PSF at each position:
;
; (1) First, create sample values
; x = findgen(43) & y = findgen(43)+1 & psf = randomn(seed,21,21,43)
;
; (2) Create primary header, write it to disk, and make extension header
; fxhmake,header,/initialize,/extend,/date
; fxwrite,'sample.fits',header
; fxbhmake,header,43,'TESTEXT','Test binary table extension'
;
; (3) Fill extension header with desired column names
; fxbaddcol,1,header,x[0],'X' ;Use first element in each array
; fxbaddcol,2,header,y[0],'Y' ;to determine column properties
; fxbaddcol,3,header,psf[*,*,0],'PSF'
;
; (4) Write extension header to FITS file
; fxbcreate,unit,'sample.fits',header
;
; (5) Use FXBWRITM to write all data to the extension in a single call
; fxbwritm,unit,['X','Y','PSF'], x, y, psf
; fxbfinish,unit ;Close the file
;
; COMMON BLOCKS:
; Uses common block FXBINTABLE--see "fxbintable.pro" for more
; information.
; RESTRICTIONS:
; The binary table file must have been opened with FXBCREATE or
; FXBOPEN (with write access).
;
; The data must be consistent with the column definition in the binary
; table header.
;
; The row number must be consistent with the number of rows stored in the
; binary table header.
;
; A PASS_METHOD of POINTER does not use the EXECUTE() statement and can be
; used with the IDL Virtual Machine. However, the EXECUTE() statement is
; used when the PASS_METHOD is by arguments.
; CATEGORY:
; Data Handling, I/O, FITS, Generic.
; PREVIOUS HISTORY:
; C. Markwardt, based on FXBWRITE and FXBREADM (ver 1), Jan 1999
; WRITTEN:
; Craig Markwardt, GSFC, January 1999.
; MODIFIED:
; Version 1, Craig Markwardt, GSFC 18 January 1999.
; Documented this routine, 18 January 1999.
; C. Markwardt, added ability to pass by handle or pointer.
; Some bug fixes, 20 July 2001
; W. Landsman/B.Schulz Allow more than 50 arguments when using pointers
; W. Landsman Remove pre-V5.0 HANDLE options July 2004
; W. Landsman Remove EXECUTE() call with POINTERS May 2005
; C. Markwardt Allow the output table to have TSCAL/TZERO
; keyword values; if that is the case, then the passed values
; will be quantized to match those scale factors before being
; written. Sep 2007
; E. Hivon: write 64bit integer and double precision columns, Mar 2008
; C. Markwardt Allow unsigned integers, which have special
; TSCAL/TZERO values. Feb 2009
; C. Markwardt Add support for files larger than 2 GB, 2012-04-17
;
;-
;
compile_opt idl2
@fxbintable
ON_ERROR, 2
;
; Check the number of parameters.
;
IF N_PARAMS() LT 2 THEN BEGIN
MESSAGE = 'Syntax: FXBWRITM, UNIT, COL, DATA1, DATA2, ' $
+' ..., ROW=, POINTERS=, PASS_METHOD=, NANVALUE=, BUFFERSIZE='
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
IF N_ELEMENTS(BUFFERSIZE) EQ 0 THEN BUFFERSIZE = 32768L
;
; COL may be one of several descriptors:
; * a list of column numbers, beginning with 1
; * a list of column names
;
MYCOL = [ COL ] ; Make sure it is an array
SC = SIZE(MYCOL)
NUMCOLS = N_ELEMENTS(MYCOL)
OUTSTATUS = LONARR(NUMCOLS)
COLNAMES = 'D'+STRTRIM(LINDGEN(50),2)
;
; Determine whether the data has been passed as arguments or pointers
;
IF N_ELEMENTS(PASS_METHOD) EQ 0 THEN PASS_METHOD = 'ARGUMENT'
PASS = STRUPCASE(STRTRIM(PASS_METHOD[0],2))
IF PASS NE 'ARGUMENT' AND PASS NE 'POINTER' THEN BEGIN
MESSAGE = 'ERROR: PASS_METHOD must be ARGUMENT or POINTER'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
NP = N_ELEMENTS(POINTERS)
IF PASS NE 'ARGUMENT' AND NP LT NUMCOLS THEN BEGIN
MESSAGE = 'ERROR: POINTERS array contains too few elements'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
IF PASS EQ 'POINTER' THEN BEGIN
SZ = SIZE(POINTERS)
IF SZ[SZ[0]+1] NE 10 THEN BEGIN
MESSAGE = 'ERROR: POINTERS must be an array of pointers'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
WH = WHERE(PTR_VALID(POINTERS[0:NUMCOLS-1]) EQ 0, CT)
IF CT GT 0 THEN BEGIN
MESSAGE = 'ERROR: POINTERS contains invalid pointers'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
ENDIF
;
; Find the logical unit number in the FXBINTABLE common block.
;
ILUN = WHERE(LUN EQ UNIT,NLUN)
ILUN = ILUN[0]
IF NLUN EQ 0 THEN BEGIN
MESSAGE = 'Unit ' + STRTRIM(UNIT,2) + $
' not opened properly'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
;
; Make sure the file was opened for write access.
;
IF STATE[ILUN] NE 2 THEN BEGIN
MESSAGE = 'Unit ' + STRTRIM(UNIT,2) + $
' not opened for write access'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
;
; Check the number of columns. It should be fewer than 50
;
IF (NUMCOLS GT 50) AND (PASS EQ 'ARGUMENT') THEN BEGIN
MESSAGE = 'Maximum of 50 columns exceeded'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
; Commented out because too much data is not a problem
; IF NUMCOLS LT N_PARAMS()-2 THEN BEGIN
; MESSAGE = 'ERROR: too few data parameters passed'
; IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
; ERRMSG = MESSAGE
; RETURN
; END ELSE MESSAGE, MESSAGE
; ENDIF
ICOL = LONARR(NUMCOLS)
FOUND = BYTARR(NUMCOLS)
NOTFOUND = ''
NNOTFOUND = 0L
IF N_ELEMENTS(WARNMSG) NE 0 THEN WARNMSG = ''
;
; If COL is of type string, then search for a column with that label.
;
IF SC[SC[0]+1] EQ 7 THEN BEGIN
MYCOL = STRUPCASE(STRTRIM(MYCOL,2))
FOR I = 0, NUMCOLS-1 DO BEGIN
XCOL = WHERE(TTYPE[*,ILUN] EQ MYCOL[I], NCOL)
ICOL[I] = XCOL[0]
IF NCOL GT 0 THEN FOUND[I] = 1
IF NOT FOUND[I] THEN BEGIN
IF NOTFOUND EQ '' THEN NOTFOUND = MYCOL[I] $
ELSE NOTFOUND = NOTFOUND +', ' + MYCOL[I]
NNOTFOUND = NNOTFOUND + 1
ENDIF
ENDFOR
IF NNOTFOUND EQ NUMCOLS THEN BEGIN
MESSAGE = 'ERROR: None of the requested columns were found'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF ELSE IF NNOTFOUND GT 0 THEN BEGIN
MESSAGE = 'WARNING: Columns ' + NOTFOUND + ' were not found'
IF N_ELEMENTS(WARNMSG) NE 0 THEN WARNMSG = MESSAGE $
ELSE MESSAGE, MESSAGE, /INFO
ENDIF
;
; Otherwise, a numerical column was passed. Check its value.
;
ENDIF ELSE BEGIN
ICOL[*] = LONG(MYCOL) - 1
FOUND[ICOL] = 1
ENDELSE
;
; Step through each column index, and check for validity
;
MESSAGE = ''
FOR I = 0, NUMCOLS-1 DO BEGIN
IF NOT FOUND[I] THEN GOTO, LOOP_END_COLCHECK
IF (ICOL[I] LT 0) OR (ICOL[I] GE TFIELDS[ILUN]) THEN BEGIN
MESSAGE = 'COL "'+STRTRIM(MYCOL[I],2)+$
'" must be between 1 and ' + $
STRTRIM(TFIELDS[ILUN],2)
FOUND[I] = 0
ENDIF
;
; If there are no elements in the array, then set !ERR to -1.
;
IF FOUND[I] AND N_ELEM[ICOL[I],ILUN] EQ 0 THEN BEGIN
FOUND[I] = 0
MESSAGE = MESSAGE + '; Number of elements to write in "'+$
STRTRIM(MYCOL[I],2)+'" should be zero'
ENDIF
;
; Do not permit variable-length columns
;
IF MAXVAL[ICOL[I],ILUN] GT 0 THEN BEGIN
MESSAGE = MESSAGE + 'FXBWRITM cannot write ' + $
'variable-length column "'+STRTRIM(MYCOL[I],2)+'"'
FOUND[I] = 0
ENDIF
LOOP_END_COLCHECK:
ENDFOR
;
; If ROW was not passed, then set it equal to the entire range. Otherwise,
; extract the range.
;
IF N_ELEMENTS(ROW) EQ 0 THEN BEGIN
ROW = [1LL, NAXIS2[ILUN]]
ENDIF
CASE N_ELEMENTS(ROW) OF
1: ROW2 = LONG64(ROW[0])
2: ROW2 = LONG64(ROW[1])
ELSE: BEGIN
MESSAGE = 'ROW must have one or two elements'
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
END
ENDCASE
ROW1 = LONG64(ROW[0])
;
; If ROW represents a range, then make sure that the row range is legal, and
; that reading row ranges is allowed (i.e., the column is not variable length.
;
IF ROW1 NE ROW2 THEN BEGIN
MAXROW = NAXIS2[ILUN]
IF (ROW1 LT 1) OR (ROW1 GT MAXROW) THEN BEGIN
MESSAGE = 'ROW[0] must be between 1 and ' + $
STRTRIM(MAXROW,2)
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
END ELSE IF (ROW2 LT ROW1) OR (ROW2 GT MAXROW) THEN BEGIN
MESSAGE = 'ROW[1] must be between ' + $
STRTRIM(ROW1,2) + ' and ' + STRTRIM(MAXROW,2)
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
;
; Otherwise, if ROW is a single number, then just make sure it's valid.
;
END ELSE BEGIN
IF (ROW1 LT 1) OR (ROW1 GT NAXIS2[ILUN]) THEN BEGIN
MESSAGE = 'ROW must be between 1 and ' + $
STRTRIM(NAXIS2[ILUN],2)
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF
ENDELSE
;
; Check the type of the data against that defined for this column.
;
COLNDIM = LONARR(NUMCOLS)
COLDIM = LONARR(NUMCOLS, 8) ;; Maximum of 8 dimensions in output
COLTYPE = LONARR(NUMCOLS)
BOFF1 = LONARR(NUMCOLS)
BOFF2 = LONARR(NUMCOLS)
NOUTPUT = LONARR(NUMCOLS)
NROWS = ROW2-ROW1+1
MESSAGE = ''
DTYPENAMES = [ 'BAD TYPE', 'BYTE', 'FIX', 'LONG', $
'FLOAT', 'DOUBLE', 'COMPLEX', 'STRING', $
'BAD TYPE', 'DCOMPLEX', $
'BAD TYPE', 'BAD TYPE', 'BAD TYPE', 'BAD TYPE', 'LONG64' ]
FOR I = 0L, NUMCOLS-1 DO BEGIN
IF NOT FOUND[I] THEN GOTO, LOOP_END_DIMS
;; Data type of the input.
COLTYPE[I] = IDLTYPE[ICOL[I],ILUN]
SZ = 0
IF PASS EQ 'ARGUMENT' THEN BEGIN
RESULT = EXECUTE('SZ = SIZE('+COLNAMES[I]+')')
IF RESULT EQ 0 THEN BEGIN
MESSAGE = MESSAGE + '; Could not extract type info (column '+$
STRTRIM(MYCOL[I],2)+')'
FOUND[I] = 0
ENDIF
ENDIF ELSE SZ = SIZE(*(POINTERS[I]))
TSCAL1 = TSCAL[ICOL[I],ILUN]
TZERO1 = TZERO[ICOL[I],ILUN]
TYPE = SZ[SZ[0]+1]
TYPE_BAD = TYPE NE COLTYPE[I]
;; Handle case of scaled data being stored in an
;; integer column
IF NOT KEYWORD_SET(NOSCALE) AND $
(TSCAL1 NE 0) AND (TSCAL1 NE 1) AND $
(TYPE EQ 4 OR TYPE EQ 5) AND $
(COLTYPE[I] EQ 2 OR COLTYPE[I] EQ 3 OR COLTYPE[I] EQ 14) THEN $
TYPE_BAD = 0
;; Unsigned types are OK
IF TSCAL1 EQ 1 AND $
((COLTYPE[I] EQ 2 AND TZERO1 EQ 32768) OR $
(COLTYPE[I] EQ 3 AND TZERO1 EQ 2147483648D)) AND $
(TYPE EQ 1 OR TYPE EQ 2 OR TYPE EQ 3 OR $
TYPE EQ 12 OR TYPE EQ 13 OR TYPE EQ 14) THEN BEGIN
TYPE_BAD = 0
ENDIF
IF TYPE_BAD THEN BEGIN
CASE COLTYPE[I] OF
1: STYPE = 'byte'
2: STYPE = 'short integer'
3: STYPE = 'long integer'
4: STYPE = 'floating point'
5: STYPE = 'double precision'
6: STYPE = 'complex'
7: STYPE = 'string'
9: STYPE = 'double complex'
12: STYPE = 'unsigned integer'
13: STYPE = 'unsigned long integer'
14: STYPE = 'long64 integer'
ENDCASE
FOUND[I] = 0
MESSAGE = '; Data type (column '+STRTRIM(MYCOL[I],2)+$
') should be ' + STYPE
ENDIF
DIMS = N_DIMS[*,ICOL[I],ILUN]
NDIMS = DIMS[0]
DIMS = DIMS[1:NDIMS]
IF NDIMS EQ 1 AND DIMS[0] EQ 1 THEN BEGIN
;; Case of only one output element, try to return a
;; scalar. Otherwise, it is a vector equal to the
;; number of rows to be read
COLNDIM[I] = 1L
COLDIM[I,0] = NROWS
ENDIF ELSE BEGIN
COLNDIM[I] = NDIMS
COLDIM[I,0:(NDIMS-1)] = DIMS
IF NROWS GT 1 THEN BEGIN
COLDIM[I,NDIMS] = NROWS
COLNDIM[I] = COLNDIM[I]+1
ENDIF
ENDELSE
;
; Check the number of elements in the input
;
NOUTP = ROUND(PRODUCT(COLDIM[I,0:COLNDIM[I]-1]))
IF SZ[SZ[0]+1] EQ 7 THEN BEGIN
NOUTP = NOUTP / COLDIM[I,0]
IF NOUTP NE SZ[SZ[0]+2] THEN GOTO, ERR_NELEM
NOUTPUT[I] = NOUTP
ENDIF ELSE IF SZ[SZ[0]+2] NE NOUTP THEN BEGIN
ERR_NELEM:
MESSAGE = MESSAGE+'; Data array (column '+STRTRIM(MYCOL[I],2)+$
') should have ' + STRTRIM(LONG(NOUTP),2) + ' elements'
FOUND[I] = 0
ENDIF ELSE NOUTPUT[I] = NOUTP
;; Byte offsets
BOFF1[I] = BYTOFF[ICOL[I],ILUN]
IF ICOL[I] EQ TFIELDS[ILUN]-1 THEN BOFF2[I] = NAXIS1[ILUN]-1 $
ELSE BOFF2[I] = BYTOFF[ICOL[I]+1,ILUN]-1
LOOP_END_DIMS:
ENDFOR
;
; Check to be sure that there are columns to be written
;
W = WHERE(FOUND EQ 1, COUNT)
IF COUNT EQ 0 THEN BEGIN
STRPUT, MESSAGE, ':', 0
MESSAGE = 'ERROR: No requested columns could be written'+MESSAGE
IF N_ELEMENTS(ERRMSG) NE 0 THEN BEGIN
ERRMSG = MESSAGE
RETURN
END ELSE MESSAGE, MESSAGE
ENDIF ELSE IF MESSAGE NE '' THEN BEGIN
STRPUT, MESSAGE, ':', 0
MESSAGE = 'WARNING: Some columns could not be written'+MESSAGE
IF N_ELEMENTS(WARNMSG) NE 0 THEN WARNMSG = MESSAGE $
ELSE MESSAGE, MESSAGE, /INFO
ENDIF
;; I construct a list of unique column names here. Why?
;; Because if *all* the columns are named, then there is no
;; need to read the data from disk first. Since columns can
;; be given more than once in MYCOL, we need to uniq-ify it.
CC = MYCOL[UNIQ(MYCOL, SORT(MYCOL))]
NC = N_ELEMENTS(CC)
;
; Find the position of the first byte of the data array in the file.
;
OFFSET0 = NHEADER[ILUN] + NAXIS1[ILUN]*(ROW1-1LL)
POS = 0LL
NROWS0 = NROWS
J = 0LL
;; Here, we constrain the buffer to be at least 16 rows long.
;; If we fill up 32 kB with fewer than 16 rows, then there
;; must be a lot of (big) columns in this table. It's
;; probably a candidate for using FXBREAD instead.
BUFFROWS = LONG((BUFFERSIZE/NAXIS1[ILUN]) > 16L)
IF BUFFERSIZE LE 0 THEN BUFFROWS = NROWS0
;
; Loop through the data in chunks
;
WHILE NROWS GT 0 DO BEGIN
J = J + 1
NR = NROWS < BUFFROWS
OFFSET1 = NAXIS1[ILUN]*POS
;
; Proceed by reading a byte array from the input data file
; FXBREADM reads all columns from the specified rows, and
; sorts out the details of which bytes belong to which columns
; in the next FOR loop.
;
BB = BYTARR(NAXIS1[ILUN], NR)
; If *all* columns are being filled, then there is no reason to
; read from the file
IF NC LT TFIELDS[ILUN] THEN BEGIN
POINT_LUN,UNIT,OFFSET0+OFFSET1
READU, UNIT, BB
ENDIF
;
; Now select out the desired columns to write
;
FOR I = 0, NUMCOLS-1 DO BEGIN
IF NOT FOUND[I] THEN GOTO, LOOP_END_WRITE
;; Copy data into DD
IF PASS EQ 'ARGUMENT' THEN BEGIN
RESULT = EXECUTE('DD = '+COLNAMES[I])
IF RESULT EQ 0 THEN GOTO, LOOP_END_WRITE
ENDIF ELSE DD = *(POINTERS[I])
; ENDIF
IF N_ELEMENTS(DD) EQ 1 THEN DD = [DD]
DD = REFORM(DD, NOUTPUT[I]/NROWS0, NROWS0, /OVERWRITE)
IF POS GT 0 OR NR LT NROWS0 THEN $
DD = DD[*,POS:(POS+NR-1)]
;; Now any conversions to FITS format must be done
COUNT = 0L
CT = COLTYPE[I]
;; Perform data scaling, if scaling values are available
IF NOT KEYWORD_SET(NOSCALE) THEN BEGIN
TSCAL1 = TSCAL[ICOL[I],ILUN]
TZERO1 = TZERO[ICOL[I],ILUN]
IF TSCAL1 EQ 0 THEN TSCAL1 = 1
;; Handle special unsigned cases
IF TZERO1 EQ 32768 AND TSCAL1 EQ 1 AND CT EQ 2 THEN $
;; Unsigned integer
DD = UINT(DD) - UINT(TZERO1) $
ELSE IF TZERO1 EQ 2147483648D AND TSCAL1 EQ 1 AND CT EQ 3 THEN $
;; Unsigned long integer
DD = ULONG(DD) - ULONG(TZERO1) $
ELSE IF TZERO1 NE 0 THEN DD = DD - TZERO1
IF TSCAL1 NE 1 THEN DD = DD / TSCAL1
ENDIF
SZ = SIZE(DD)
TP = SZ[SZ[0]+1]
CASE 1 OF
;; Integer types
(CT EQ 1): BEGIN
;; Type-cast may be needed if we used TSCAL/TZERO
IF TP NE 1 THEN DD = BYTE(DD)
END
(CT EQ 2): BEGIN
;; Type-cast may be needed if we used TSCAL/TZERO
IF TP NE 2 THEN DD = FIX(DD)
IF NOT KEYWORD_SET(NOIEEE) THEN $
SWAP_ENDIAN_INPLACE, DD,/SWAP_IF_LITTLE
END
(CT EQ 3): BEGIN
;; Type-cast may be needed if we used TSCAL/TZERO
IF TP NE 3 THEN DD = LONG(DD)
IF NOT KEYWORD_SET(NOIEEE) THEN $
SWAP_ENDIAN_INPLACE, DD,/SWAP_IF_LITTLE
END
(ct eq 14): begin
;; Type-cast may be needed if we used TSCAL/TZERO
IF TP NE 14 THEN DD = LONG(DD)
IF NOT KEYWORD_SET(NOIEEE) THEN $
SWAP_ENDIAN_INPLACE, DD,/SWAP_IF_LITTLE
end
;; Floating and complex types
(CT GE 4 AND CT LE 6 OR CT EQ 9): BEGIN
IF NOT KEYWORD_SET(NOIEEE) THEN BEGIN
IF N_ELEMENTS(NANVALUE) EQ 1 THEN BEGIN
W=WHERE(DD EQ NANVALUE,COUNT)
NAN = REPLICATE('FF'XB,16)
NAN = CALL_FUNCTION(DTYPENAMES,NAN,0,1)
ENDIF
SWAP_ENDIAN_INPLACE, DD,/SWAP_IF_LITTLE
IF COUNT GT 0 THEN DD[W] = NAN
ENDIF
END
;; String type, needs to be padded with spaces
(CT EQ 7): BEGIN
N_CHAR = N_DIMS[1,ICOL[I],ILUN]
;; Largest string determines size of array
MAXLEN = MAX(STRLEN(DD)) > 1
;; Convert to bytes
DD = BYTE(TEMPORARY(DD))
IF N_ELEMENTS(DD) EQ 1 THEN DD = [DD]
DD = REFORM(DD, MAXLEN, NR, /OVERWRITE)
;; Put it into the output array
IF MAXLEN GT N_CHAR THEN BEGIN
DD = DD[0:(N_CHAR-1),*]
ENDIF ELSE BEGIN
DB = BYTARR(N_CHAR, NR)
DB[0:(MAXLEN-1),*] = TEMPORARY(DD)
DD = TEMPORARY(DB)
ENDELSE
;; Pad any zeroes with spaces
WB = WHERE(DD EQ 0b, WCOUNT)
IF WCOUNT GT 0 THEN DD[WB] = 32B
;; Pretend that it is a byte array
CT = 1
END
ENDCASE
IF CT NE 1 THEN $
DD = BYTE(TEMPORARY(DD),0,(BOFF2[I]-BOFF1[I]+1),NR)
IF N_ELEMENTS(DD) EQ 1 THEN DD = [DD]
DD = REFORM(DD, BOFF2[I]-BOFF1[I]+1, NR, /OVERWRITE)
;; Now place the data into the byte array
BB[BOFF1[I],0] = DD
OUTSTATUS[I] = 1
LOOP_END_WRITE:
END
;; Finally, write byte array to output file
POINT_LUN, UNIT, OFFSET0+OFFSET1
BB = REFORM(BB, N_ELEMENTS(BB), /OVERWRITE)
WRITEU, UNIT, BB
NROWS = NROWS - NR
POS = POS + NR
ENDWHILE
;
IF N_ELEMENTS(ERRMSG) NE 0 THEN ERRMSG = ''
RETURN
END
|