/
getcolui.c
1967 lines (1823 loc) · 73.5 KB
/
getcolui.c
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* This file, getcolui.c, contains routines that read data elements from */
/* a FITS image or table, with unsigned short datatype. */
/* The FITSIO software was written by William Pence at the High Energy */
/* Astrophysic Science Archive Research Center (HEASARC) at the NASA */
/* Goddard Space Flight Center. */
#include <math.h>
#include <stdlib.h>
#include <limits.h>
#include <string.h>
#include "fitsio2.h"
/*--------------------------------------------------------------------------*/
int ffgpvui( fitsfile *fptr, /* I - FITS file pointer */
long group, /* I - group to read (1 = 1st group) */
LONGLONG firstelem, /* I - first vector element to read (1 = 1st) */
LONGLONG nelem, /* I - number of values to read */
unsigned short nulval, /* I - value for undefined pixels */
unsigned short *array, /* O - array of values that are returned */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an array of values from the primary array. Data conversion
and scaling will be performed if necessary (e.g, if the datatype of
the FITS array is not the same as the array being read).
Undefined elements will be set equal to NULVAL, unless NULVAL=0
in which case no checking for undefined values will be performed.
ANYNUL is returned with a value of .true. if any pixels are undefined.
*/
{
long row;
char cdummy;
int nullcheck = 1;
unsigned short nullvalue;
if (fits_is_compressed_image(fptr, status))
{
/* this is a compressed image in a binary table */
nullvalue = nulval; /* set local variable */
fits_read_compressed_pixels(fptr, TUSHORT, firstelem, nelem,
nullcheck, &nullvalue, array, NULL, anynul, status);
return(*status);
}
/*
the primary array is represented as a binary table:
each group of the primary array is a row in the table,
where the first column contains the group parameters
and the second column contains the image itself.
*/
row=maxvalue(1,group);
ffgclui(fptr, 2, row, firstelem, nelem, 1, 1, nulval,
array, &cdummy, anynul, status);
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffgpfui( fitsfile *fptr, /* I - FITS file pointer */
long group, /* I - group to read (1 = 1st group) */
LONGLONG firstelem, /* I - first vector element to read (1 = 1st) */
LONGLONG nelem, /* I - number of values to read */
unsigned short *array, /* O - array of values that are returned */
char *nularray, /* O - array of null pixel flags */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an array of values from the primary array. Data conversion
and scaling will be performed if necessary (e.g, if the datatype of
the FITS array is not the same as the array being read).
Any undefined pixels in the returned array will be set = 0 and the
corresponding nularray value will be set = 1.
ANYNUL is returned with a value of .true. if any pixels are undefined.
*/
{
long row;
int nullcheck = 2;
if (fits_is_compressed_image(fptr, status))
{
/* this is a compressed image in a binary table */
fits_read_compressed_pixels(fptr, TUSHORT, firstelem, nelem,
nullcheck, NULL, array, nularray, anynul, status);
return(*status);
}
/*
the primary array is represented as a binary table:
each group of the primary array is a row in the table,
where the first column contains the group parameters
and the second column contains the image itself.
*/
row=maxvalue(1,group);
ffgclui(fptr, 2, row, firstelem, nelem, 1, 2, 0,
array, nularray, anynul, status);
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffg2dui(fitsfile *fptr, /* I - FITS file pointer */
long group, /* I - group to read (1 = 1st group) */
unsigned short nulval, /* set undefined pixels equal to this */
LONGLONG ncols, /* I - number of pixels in each row of array */
LONGLONG naxis1, /* I - FITS image NAXIS1 value */
LONGLONG naxis2, /* I - FITS image NAXIS2 value */
unsigned short *array, /* O - array to be filled and returned */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an entire 2-D array of values to the primary array. Data conversion
and scaling will be performed if necessary (e.g, if the datatype of the
FITS array is not the same as the array being read). Any null
values in the array will be set equal to the value of nulval, unless
nulval = 0 in which case no null checking will be performed.
*/
{
/* call the 3D reading routine, with the 3rd dimension = 1 */
ffg3dui(fptr, group, nulval, ncols, naxis2, naxis1, naxis2, 1, array,
anynul, status);
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffg3dui(fitsfile *fptr, /* I - FITS file pointer */
long group, /* I - group to read (1 = 1st group) */
unsigned short nulval, /* set undefined pixels equal to this */
LONGLONG ncols, /* I - number of pixels in each row of array */
LONGLONG nrows, /* I - number of rows in each plane of array */
LONGLONG naxis1, /* I - FITS image NAXIS1 value */
LONGLONG naxis2, /* I - FITS image NAXIS2 value */
LONGLONG naxis3, /* I - FITS image NAXIS3 value */
unsigned short *array, /* O - array to be filled and returned */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an entire 3-D array of values to the primary array. Data conversion
and scaling will be performed if necessary (e.g, if the datatype of the
FITS array is not the same as the array being read). Any null
values in the array will be set equal to the value of nulval, unless
nulval = 0 in which case no null checking will be performed.
*/
{
long tablerow, ii, jj;
char cdummy;
int nullcheck = 1;
long inc[] = {1,1,1};
LONGLONG fpixel[] = {1,1,1}, nfits, narray;
LONGLONG lpixel[3];
unsigned short nullvalue;
if (fits_is_compressed_image(fptr, status))
{
/* this is a compressed image in a binary table */
lpixel[0] = ncols;
lpixel[1] = nrows;
lpixel[2] = naxis3;
nullvalue = nulval; /* set local variable */
fits_read_compressed_img(fptr, TUSHORT, fpixel, lpixel, inc,
nullcheck, &nullvalue, array, NULL, anynul, status);
return(*status);
}
/*
the primary array is represented as a binary table:
each group of the primary array is a row in the table,
where the first column contains the group parameters
and the second column contains the image itself.
*/
tablerow=maxvalue(1,group);
if (ncols == naxis1 && nrows == naxis2) /* arrays have same size? */
{
/* all the image pixels are contiguous, so read all at once */
ffgclui(fptr, 2, tablerow, 1, naxis1 * naxis2 * naxis3, 1, 1, nulval,
array, &cdummy, anynul, status);
return(*status);
}
if (ncols < naxis1 || nrows < naxis2)
return(*status = BAD_DIMEN);
nfits = 1; /* next pixel in FITS image to read */
narray = 0; /* next pixel in output array to be filled */
/* loop over naxis3 planes in the data cube */
for (jj = 0; jj < naxis3; jj++)
{
/* loop over the naxis2 rows in the FITS image, */
/* reading naxis1 pixels to each row */
for (ii = 0; ii < naxis2; ii++)
{
if (ffgclui(fptr, 2, tablerow, nfits, naxis1, 1, 1, nulval,
&array[narray], &cdummy, anynul, status) > 0)
return(*status);
nfits += naxis1;
narray += ncols;
}
narray += (nrows - naxis2) * ncols;
}
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffgsvui(fitsfile *fptr, /* I - FITS file pointer */
int colnum, /* I - number of the column to read (1 = 1st) */
int naxis, /* I - number of dimensions in the FITS array */
long *naxes, /* I - size of each dimension */
long *blc, /* I - 'bottom left corner' of the subsection */
long *trc, /* I - 'top right corner' of the subsection */
long *inc, /* I - increment to be applied in each dimension */
unsigned short nulval, /* I - value to set undefined pixels */
unsigned short *array, /* O - array to be filled and returned */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read a subsection of data values from an image or a table column.
This routine is set up to handle a maximum of nine dimensions.
*/
{
long ii,i0, i1,i2,i3,i4,i5,i6,i7,i8,row,rstr,rstp,rinc;
long str[9],stp[9],incr[9];
long nelem, nultyp, ninc, numcol;
LONGLONG felem, dsize[10], blcll[9], trcll[9];
int hdutype, anyf;
char ldummy, msg[FLEN_ERRMSG];
int nullcheck = 1;
unsigned short nullvalue;
if (naxis < 1 || naxis > 9)
{
snprintf(msg, FLEN_ERRMSG,"NAXIS = %d in call to ffgsvui is out of range", naxis);
ffpmsg(msg);
return(*status = BAD_DIMEN);
}
if (fits_is_compressed_image(fptr, status))
{
/* this is a compressed image in a binary table */
for (ii=0; ii < naxis; ii++) {
blcll[ii] = blc[ii];
trcll[ii] = trc[ii];
}
nullvalue = nulval; /* set local variable */
fits_read_compressed_img(fptr, TUSHORT, blcll, trcll, inc,
nullcheck, &nullvalue, array, NULL, anynul, status);
return(*status);
}
/*
if this is a primary array, then the input COLNUM parameter should
be interpreted as the row number, and we will alway read the image
data from column 2 (any group parameters are in column 1).
*/
if (ffghdt(fptr, &hdutype, status) > 0)
return(*status);
if (hdutype == IMAGE_HDU)
{
/* this is a primary array, or image extension */
if (colnum == 0)
{
rstr = 1;
rstp = 1;
}
else
{
rstr = colnum;
rstp = colnum;
}
rinc = 1;
numcol = 2;
}
else
{
/* this is a table, so the row info is in the (naxis+1) elements */
rstr = blc[naxis];
rstp = trc[naxis];
rinc = inc[naxis];
numcol = colnum;
}
nultyp = 1;
if (anynul)
*anynul = FALSE;
i0 = 0;
for (ii = 0; ii < 9; ii++)
{
str[ii] = 1;
stp[ii] = 1;
incr[ii] = 1;
dsize[ii] = 1;
}
for (ii = 0; ii < naxis; ii++)
{
if (trc[ii] < blc[ii])
{
snprintf(msg, FLEN_ERRMSG,"ffgsvui: illegal range specified for axis %ld", ii + 1);
ffpmsg(msg);
return(*status = BAD_PIX_NUM);
}
str[ii] = blc[ii];
stp[ii] = trc[ii];
incr[ii] = inc[ii];
dsize[ii + 1] = dsize[ii] * naxes[ii];
}
if (naxis == 1 && naxes[0] == 1)
{
/* This is not a vector column, so read all the rows at once */
nelem = (rstp - rstr) / rinc + 1;
ninc = rinc;
rstp = rstr;
}
else
{
/* have to read each row individually, in all dimensions */
nelem = (stp[0] - str[0]) / inc[0] + 1;
ninc = incr[0];
}
for (row = rstr; row <= rstp; row += rinc)
{
for (i8 = str[8]; i8 <= stp[8]; i8 += incr[8])
{
for (i7 = str[7]; i7 <= stp[7]; i7 += incr[7])
{
for (i6 = str[6]; i6 <= stp[6]; i6 += incr[6])
{
for (i5 = str[5]; i5 <= stp[5]; i5 += incr[5])
{
for (i4 = str[4]; i4 <= stp[4]; i4 += incr[4])
{
for (i3 = str[3]; i3 <= stp[3]; i3 += incr[3])
{
for (i2 = str[2]; i2 <= stp[2]; i2 += incr[2])
{
for (i1 = str[1]; i1 <= stp[1]; i1 += incr[1])
{
felem=str[0] + (i1 - 1) * dsize[1] + (i2 - 1) * dsize[2] +
(i3 - 1) * dsize[3] + (i4 - 1) * dsize[4] +
(i5 - 1) * dsize[5] + (i6 - 1) * dsize[6] +
(i7 - 1) * dsize[7] + (i8 - 1) * dsize[8];
if ( ffgclui(fptr, numcol, row, felem, nelem, ninc, nultyp,
nulval, &array[i0], &ldummy, &anyf, status) > 0)
return(*status);
if (anyf && anynul)
*anynul = TRUE;
i0 += nelem;
}
}
}
}
}
}
}
}
}
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffgsfui(fitsfile *fptr, /* I - FITS file pointer */
int colnum, /* I - number of the column to read (1 = 1st) */
int naxis, /* I - number of dimensions in the FITS array */
long *naxes, /* I - size of each dimension */
long *blc, /* I - 'bottom left corner' of the subsection */
long *trc, /* I - 'top right corner' of the subsection */
long *inc, /* I - increment to be applied in each dimension */
unsigned short *array, /* O - array to be filled and returned */
char *flagval, /* O - set to 1 if corresponding value is null */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read a subsection of data values from an image or a table column.
This routine is set up to handle a maximum of nine dimensions.
*/
{
long ii,i0, i1,i2,i3,i4,i5,i6,i7,i8,row,rstr,rstp,rinc;
long str[9],stp[9],incr[9],dsize[10];
LONGLONG blcll[9], trcll[9];
long felem, nelem, nultyp, ninc, numcol;
int hdutype, anyf;
unsigned short nulval = 0;
char msg[FLEN_ERRMSG];
int nullcheck = 2;
if (naxis < 1 || naxis > 9)
{
snprintf(msg, FLEN_ERRMSG,"NAXIS = %d in call to ffgsvi is out of range", naxis);
ffpmsg(msg);
return(*status = BAD_DIMEN);
}
if (fits_is_compressed_image(fptr, status))
{
/* this is a compressed image in a binary table */
for (ii=0; ii < naxis; ii++) {
blcll[ii] = blc[ii];
trcll[ii] = trc[ii];
}
fits_read_compressed_img(fptr, TUSHORT, blcll, trcll, inc,
nullcheck, NULL, array, flagval, anynul, status);
return(*status);
}
/*
if this is a primary array, then the input COLNUM parameter should
be interpreted as the row number, and we will alway read the image
data from column 2 (any group parameters are in column 1).
*/
if (ffghdt(fptr, &hdutype, status) > 0)
return(*status);
if (hdutype == IMAGE_HDU)
{
/* this is a primary array, or image extension */
if (colnum == 0)
{
rstr = 1;
rstp = 1;
}
else
{
rstr = colnum;
rstp = colnum;
}
rinc = 1;
numcol = 2;
}
else
{
/* this is a table, so the row info is in the (naxis+1) elements */
rstr = blc[naxis];
rstp = trc[naxis];
rinc = inc[naxis];
numcol = colnum;
}
nultyp = 2;
if (anynul)
*anynul = FALSE;
i0 = 0;
for (ii = 0; ii < 9; ii++)
{
str[ii] = 1;
stp[ii] = 1;
incr[ii] = 1;
dsize[ii] = 1;
}
for (ii = 0; ii < naxis; ii++)
{
if (trc[ii] < blc[ii])
{
snprintf(msg, FLEN_ERRMSG,"ffgsvi: illegal range specified for axis %ld", ii + 1);
ffpmsg(msg);
return(*status = BAD_PIX_NUM);
}
str[ii] = blc[ii];
stp[ii] = trc[ii];
incr[ii] = inc[ii];
dsize[ii + 1] = dsize[ii] * naxes[ii];
}
if (naxis == 1 && naxes[0] == 1)
{
/* This is not a vector column, so read all the rows at once */
nelem = (rstp - rstr) / rinc + 1;
ninc = rinc;
rstp = rstr;
}
else
{
/* have to read each row individually, in all dimensions */
nelem = (stp[0] - str[0]) / inc[0] + 1;
ninc = incr[0];
}
for (row = rstr; row <= rstp; row += rinc)
{
for (i8 = str[8]; i8 <= stp[8]; i8 += incr[8])
{
for (i7 = str[7]; i7 <= stp[7]; i7 += incr[7])
{
for (i6 = str[6]; i6 <= stp[6]; i6 += incr[6])
{
for (i5 = str[5]; i5 <= stp[5]; i5 += incr[5])
{
for (i4 = str[4]; i4 <= stp[4]; i4 += incr[4])
{
for (i3 = str[3]; i3 <= stp[3]; i3 += incr[3])
{
for (i2 = str[2]; i2 <= stp[2]; i2 += incr[2])
{
for (i1 = str[1]; i1 <= stp[1]; i1 += incr[1])
{
felem=str[0] + (i1 - 1) * dsize[1] + (i2 - 1) * dsize[2] +
(i3 - 1) * dsize[3] + (i4 - 1) * dsize[4] +
(i5 - 1) * dsize[5] + (i6 - 1) * dsize[6] +
(i7 - 1) * dsize[7] + (i8 - 1) * dsize[8];
if ( ffgclui(fptr, numcol, row, felem, nelem, ninc, nultyp,
nulval, &array[i0], &flagval[i0], &anyf, status) > 0)
return(*status);
if (anyf && anynul)
*anynul = TRUE;
i0 += nelem;
}
}
}
}
}
}
}
}
}
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffggpui( fitsfile *fptr, /* I - FITS file pointer */
long group, /* I - group to read (1 = 1st group) */
long firstelem, /* I - first vector element to read (1 = 1st) */
long nelem, /* I - number of values to read */
unsigned short *array, /* O - array of values that are returned */
int *status) /* IO - error status */
/*
Read an array of group parameters from the primary array. Data conversion
and scaling will be performed if necessary (e.g, if the datatype of
the FITS array is not the same as the array being read).
*/
{
long row;
int idummy;
char cdummy;
/*
the primary array is represented as a binary table:
each group of the primary array is a row in the table,
where the first column contains the group parameters
and the second column contains the image itself.
*/
row=maxvalue(1,group);
ffgclui(fptr, 1, row, firstelem, nelem, 1, 1, 0,
array, &cdummy, &idummy, status);
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffgcvui(fitsfile *fptr, /* I - FITS file pointer */
int colnum, /* I - number of column to read (1 = 1st col) */
LONGLONG firstrow, /* I - first row to read (1 = 1st row) */
LONGLONG firstelem, /* I - first vector element to read (1 = 1st) */
LONGLONG nelem, /* I - number of values to read */
unsigned short nulval, /* I - value for null pixels */
unsigned short *array, /* O - array of values that are read */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an array of values from a column in the current FITS HDU. Automatic
datatype conversion will be performed if the datatype of the column does not
match the datatype of the array parameter. The output values will be scaled
by the FITS TSCALn and TZEROn values if these values have been defined.
Any undefined pixels will be set equal to the value of 'nulval' unless
nulval = 0 in which case no checks for undefined pixels will be made.
*/
{
char cdummy;
ffgclui(fptr, colnum, firstrow, firstelem, nelem, 1, 1, nulval,
array, &cdummy, anynul, status);
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffgcfui(fitsfile *fptr, /* I - FITS file pointer */
int colnum, /* I - number of column to read (1 = 1st col) */
LONGLONG firstrow, /* I - first row to read (1 = 1st row) */
LONGLONG firstelem, /* I - first vector element to read (1 = 1st) */
LONGLONG nelem, /* I - number of values to read */
unsigned short *array, /* O - array of values that are read */
char *nularray, /* O - array of flags: 1 if null pixel; else 0 */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an array of values from a column in the current FITS HDU. Automatic
datatype conversion will be performed if the datatype of the column does not
match the datatype of the array parameter. The output values will be scaled
by the FITS TSCALn and TZEROn values if these values have been defined.
Nularray will be set = 1 if the corresponding array pixel is undefined,
otherwise nularray will = 0.
*/
{
unsigned short dummy = 0;
ffgclui(fptr, colnum, firstrow, firstelem, nelem, 1, 2, dummy,
array, nularray, anynul, status);
return(*status);
}
/*--------------------------------------------------------------------------*/
int ffgclui( fitsfile *fptr, /* I - FITS file pointer */
int colnum, /* I - number of column to read (1 = 1st col) */
LONGLONG firstrow, /* I - first row to read (1 = 1st row) */
LONGLONG firstelem, /* I - first vector element to read (1 = 1st) */
LONGLONG nelem, /* I - number of values to read */
long elemincre, /* I - pixel increment; e.g., 2 = every other */
int nultyp, /* I - null value handling code: */
/* 1: set undefined pixels = nulval */
/* 2: set nularray=1 for undefined pixels */
unsigned short nulval, /* I - value for null pixels if nultyp = 1 */
unsigned short *array, /* O - array of values that are read */
char *nularray, /* O - array of flags = 1 if nultyp = 2 */
int *anynul, /* O - set to 1 if any values are null; else 0 */
int *status) /* IO - error status */
/*
Read an array of values from a column in the current FITS HDU.
The column number may refer to a real column in an ASCII or binary table,
or it may refer be a virtual column in a 1 or more grouped FITS primary
array or image extension. FITSIO treats a primary array as a binary table
with 2 vector columns: the first column contains the group parameters (often
with length = 0) and the second column contains the array of image pixels.
Each row of the table represents a group in the case of multigroup FITS
images.
The output array of values will be converted from the datatype of the column
and will be scaled by the FITS TSCALn and TZEROn values if necessary.
*/
{
double scale, zero, power = 1., dtemp;
int tcode, maxelem2, hdutype, xcode, decimals;
long twidth, incre;
long ii, xwidth, ntodo;
int nulcheck;
LONGLONG repeat, startpos, elemnum, readptr, tnull;
LONGLONG rowlen, rownum, remain, next, rowincre, maxelem;
char tform[20];
char message[FLEN_ERRMSG];
char snull[20]; /* the FITS null value if reading from ASCII table */
double cbuff[DBUFFSIZE / sizeof(double)]; /* align cbuff on word boundary */
void *buffer;
if (*status > 0 || nelem == 0) /* inherit input status value if > 0 */
return(*status);
buffer = cbuff;
if (anynul)
*anynul = 0;
if (nultyp == 2)
memset(nularray, 0, (size_t) nelem); /* initialize nullarray */
/*---------------------------------------------------*/
/* Check input and get parameters about the column: */
/*---------------------------------------------------*/
if ( ffgcprll( fptr, colnum, firstrow, firstelem, nelem, 0, &scale, &zero,
tform, &twidth, &tcode, &maxelem2, &startpos, &elemnum, &incre,
&repeat, &rowlen, &hdutype, &tnull, snull, status) > 0 )
return(*status);
maxelem = maxelem2;
incre *= elemincre; /* multiply incre to just get every nth pixel */
if (tcode == TSTRING) /* setup for ASCII tables */
{
/* get the number of implied decimal places if no explicit decmal point */
ffasfm(tform, &xcode, &xwidth, &decimals, status);
for(ii = 0; ii < decimals; ii++)
power *= 10.;
}
/*------------------------------------------------------------------*/
/* Decide whether to check for null values in the input FITS file: */
/*------------------------------------------------------------------*/
nulcheck = nultyp; /* by default check for null values in the FITS file */
if (nultyp == 1 && nulval == 0)
nulcheck = 0; /* calling routine does not want to check for nulls */
else if (tcode%10 == 1 && /* if reading an integer column, and */
tnull == NULL_UNDEFINED) /* if a null value is not defined, */
nulcheck = 0; /* then do not check for null values. */
else if (tcode == TSHORT && (tnull > SHRT_MAX || tnull < SHRT_MIN) )
nulcheck = 0; /* Impossible null value */
else if (tcode == TBYTE && (tnull > 255 || tnull < 0) )
nulcheck = 0; /* Impossible null value */
else if (tcode == TSTRING && snull[0] == ASCII_NULL_UNDEFINED)
nulcheck = 0;
/*----------------------------------------------------------------------*/
/* If FITS column and output data array have same datatype, then we do */
/* not need to use a temporary buffer to store intermediate datatype. */
/*----------------------------------------------------------------------*/
if (tcode == TSHORT) /* Special Case: */
{ /* no type convertion required, so read */
/* data directly into output buffer. */
if (nelem < (LONGLONG)INT32_MAX/2) {
maxelem = nelem;
} else {
maxelem = INT32_MAX/2;
}
}
/*---------------------------------------------------------------------*/
/* Now read the pixels from the FITS column. If the column does not */
/* have the same datatype as the output array, then we have to read */
/* the raw values into a temporary buffer (of limited size). In */
/* the case of a vector colum read only 1 vector of values at a time */
/* then skip to the next row if more values need to be read. */
/* After reading the raw values, then call the fffXXYY routine to (1) */
/* test for undefined values, (2) convert the datatype if necessary, */
/* and (3) scale the values by the FITS TSCALn and TZEROn linear */
/* scaling parameters. */
/*---------------------------------------------------------------------*/
remain = nelem; /* remaining number of values to read */
next = 0; /* next element in array to be read */
rownum = 0; /* row number, relative to firstrow */
while (remain)
{
/* limit the number of pixels to read at one time to the number that
will fit in the buffer or to the number of pixels that remain in
the current vector, which ever is smaller.
*/
ntodo = (long) minvalue(remain, maxelem);
ntodo = (long) minvalue(ntodo, ((repeat - elemnum - 1)/elemincre +1));
readptr = startpos + ((LONGLONG)rownum * rowlen) + (elemnum * (incre / elemincre));
switch (tcode)
{
case (TSHORT):
ffgi2b(fptr, readptr, ntodo, incre,
(short *) &array[next], status);
fffi2u2((short *) &array[next], ntodo, scale,
zero, nulcheck, (short) tnull, nulval, &nularray[next],
anynul, &array[next], status);
break;
case (TLONGLONG):
ffgi8b(fptr, readptr, ntodo, incre, (long *) buffer, status);
fffi8u2( (LONGLONG *) buffer, ntodo, scale, zero,
nulcheck, tnull, nulval, &nularray[next],
anynul, &array[next], status);
break;
case (TBYTE):
ffgi1b(fptr, readptr, ntodo, incre, (unsigned char *) buffer,
status);
fffi1u2((unsigned char *) buffer, ntodo, scale, zero, nulcheck,
(unsigned char) tnull, nulval, &nularray[next], anynul,
&array[next], status);
break;
case (TLONG):
ffgi4b(fptr, readptr, ntodo, incre, (INT32BIT *) buffer,
status);
fffi4u2((INT32BIT *) buffer, ntodo, scale, zero, nulcheck,
(INT32BIT) tnull, nulval, &nularray[next], anynul,
&array[next], status);
break;
case (TFLOAT):
ffgr4b(fptr, readptr, ntodo, incre, (float *) buffer, status);
fffr4u2((float *) buffer, ntodo, scale, zero, nulcheck,
nulval, &nularray[next], anynul,
&array[next], status);
break;
case (TDOUBLE):
ffgr8b(fptr, readptr, ntodo, incre, (double *) buffer, status);
fffr8u2((double *) buffer, ntodo, scale, zero, nulcheck,
nulval, &nularray[next], anynul,
&array[next], status);
break;
case (TSTRING):
ffmbyt(fptr, readptr, REPORT_EOF, status);
if (incre == twidth) /* contiguous bytes */
ffgbyt(fptr, ntodo * twidth, buffer, status);
else
ffgbytoff(fptr, twidth, ntodo, incre - twidth, buffer,
status);
fffstru2((char *) buffer, ntodo, scale, zero, twidth, power,
nulcheck, snull, nulval, &nularray[next], anynul,
&array[next], status);
break;
default: /* error trap for invalid column format */
snprintf(message, FLEN_ERRMSG,
"Cannot read numbers from column %d which has format %s",
colnum, tform);
ffpmsg(message);
if (hdutype == ASCII_TBL)
return(*status = BAD_ATABLE_FORMAT);
else
return(*status = BAD_BTABLE_FORMAT);
} /* End of switch block */
/*-------------------------*/
/* Check for fatal error */
/*-------------------------*/
if (*status > 0) /* test for error during previous read operation */
{
dtemp = (double) next;
if (hdutype > 0)
snprintf(message,FLEN_ERRMSG,
"Error reading elements %.0f thru %.0f from column %d (ffgclui).",
dtemp+1., dtemp+ntodo, colnum);
else
snprintf(message,FLEN_ERRMSG,
"Error reading elements %.0f thru %.0f from image (ffgclui).",
dtemp+1., dtemp+ntodo);
ffpmsg(message);
return(*status);
}
/*--------------------------------------------*/
/* increment the counters for the next loop */
/*--------------------------------------------*/
remain -= ntodo;
if (remain)
{
next += ntodo;
elemnum = elemnum + (ntodo * elemincre);
if (elemnum >= repeat) /* completed a row; start on later row */
{
rowincre = elemnum / repeat;
rownum += rowincre;
elemnum = elemnum - (rowincre * repeat);
}
}
} /* End of main while Loop */
/*--------------------------------*/
/* check for numerical overflow */
/*--------------------------------*/
if (*status == OVERFLOW_ERR)
{
ffpmsg(
"Numerical overflow during type conversion while reading FITS data.");
*status = NUM_OVERFLOW;
}
return(*status);
}
/*--------------------------------------------------------------------------*/
int fffi1u2(unsigned char *input, /* I - array of values to be converted */
long ntodo, /* I - number of elements in the array */
double scale, /* I - FITS TSCALn or BSCALE value */
double zero, /* I - FITS TZEROn or BZERO value */
int nullcheck, /* I - null checking code; 0 = don't check */
/* 1:set null pixels = nullval */
/* 2: if null pixel, set nullarray = 1 */
unsigned char tnull, /* I - value of FITS TNULLn keyword if any */
unsigned short nullval, /* I - set null pixels, if nullcheck = 1 */
char *nullarray, /* I - bad pixel array, if nullcheck = 2 */
int *anynull, /* O - set to 1 if any pixels are null */
unsigned short *output, /* O - array of converted pixels */
int *status) /* IO - error status */
/*
Copy input to output following reading of the input from a FITS file.
Check for null values and do datatype conversion and scaling if required.
The nullcheck code value determines how any null values in the input array
are treated. A null value is an input pixel that is equal to tnull. If
nullcheck = 0, then no checking for nulls is performed and any null values
will be transformed just like any other pixel. If nullcheck = 1, then the
output pixel will be set = nullval if the corresponding input pixel is null.
If nullcheck = 2, then if the pixel is null then the corresponding value of
nullarray will be set to 1; the value of nullarray for non-null pixels
will = 0. The anynull parameter will be set = 1 if any of the returned
pixels are null, otherwise anynull will be returned with a value = 0;
*/
{
long ii;
double dvalue;
if (nullcheck == 0) /* no null checking required */
{
if (scale == 1. && zero == 0.) /* no scaling */
{
for (ii = 0; ii < ntodo; ii++)
output[ii] = (unsigned short) input[ii]; /* copy input */
}
else /* must scale the data */
{
for (ii = 0; ii < ntodo; ii++)
{
dvalue = input[ii] * scale + zero;
if (dvalue < DUSHRT_MIN)
{
*status = OVERFLOW_ERR;
output[ii] = 0;
}
else if (dvalue > DUSHRT_MAX)
{
*status = OVERFLOW_ERR;
output[ii] = USHRT_MAX;
}
else
output[ii] = (unsigned short) dvalue;
}
}
}
else /* must check for null values */
{
if (scale == 1. && zero == 0.) /* no scaling */
{
for (ii = 0; ii < ntodo; ii++)
{
if (input[ii] == tnull)
{
*anynull = 1;
if (nullcheck == 1)
output[ii] = nullval;
else
nullarray[ii] = 1;
}
else
output[ii] = (unsigned short) input[ii];
}
}
else /* must scale the data */
{
for (ii = 0; ii < ntodo; ii++)
{
if (input[ii] == tnull)
{
*anynull = 1;
if (nullcheck == 1)
output[ii] = nullval;
else
nullarray[ii] = 1;
}
else
{
dvalue = input[ii] * scale + zero;
if (dvalue < DUSHRT_MIN)
{
*status = OVERFLOW_ERR;
output[ii] = 0;
}
else if (dvalue > DUSHRT_MAX)
{
*status = OVERFLOW_ERR;
output[ii] = USHRT_MAX;
}
else
output[ii] = (unsigned short) dvalue;
}
}
}
}
return(*status);
}
/*--------------------------------------------------------------------------*/
int fffi2u2(short *input, /* I - array of values to be converted */
long ntodo, /* I - number of elements in the array */
double scale, /* I - FITS TSCALn or BSCALE value */
double zero, /* I - FITS TZEROn or BZERO value */
int nullcheck, /* I - null checking code; 0 = don't check */
/* 1:set null pixels = nullval */
/* 2: if null pixel, set nullarray = 1 */
short tnull, /* I - value of FITS TNULLn keyword if any */
unsigned short nullval, /* I - set null pixels, if nullcheck = 1 */
char *nullarray, /* I - bad pixel array, if nullcheck = 2 */
int *anynull, /* O - set to 1 if any pixels are null */
unsigned short *output, /* O - array of converted pixels */
int *status) /* IO - error status */
/*
Copy input to output following reading of the input from a FITS file.
Check for null values and do datatype conversion and scaling if required.
The nullcheck code value determines how any null values in the input array