-
Notifications
You must be signed in to change notification settings - Fork 0
/
AvFitsDataSet.cc
1831 lines (1639 loc) · 48.8 KB
/
AvFitsDataSet.cc
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
//# Copyright (C) 1995-2003 Board of Trustees of the University of Illinois
//#
//# This software, both binary and source, is copyrighted by The
//# Board of Trustees of the University of Illinois. Ownership
//# remains with the University. You should have received a copy
//# of a licensing agreement with this software. See the file
//# "AIPSVIEW_COPYRIGHT", or contact the University at this address:
//#
//# The NCSA AipsView Visualization System
//# National Center for Supercomputing Applications
//# University of Illinois
//# 405 North Mathews Ave.
//# Urbana, IL 61801
//# --------------------------------------------------
//
//
// $Header: /home/cvs/aips++/code/trial/apps/aipsview/Attic/AvFitsDataSet.cc,v 19.2 2003/09/26 16:35:56 hravlin Exp $
//
// $Log: AvFitsDataSet.cc,v $
// Revision 19.2 2003/09/26 16:35:56 hravlin
// For Darwin, added extern "C" to find isnan().
// made error_out() a dummy function.
//
// Revision 19.1 2003/09/02 21:11:21 hravlin
// Added dataSetTypeName(), isDataSet and other support for factory info.
//
// Revision 19.0 2003/07/16 05:47:49 aips2adm
// exhale: Base release 19.000.00
//
// Revision 18.0 2002/06/07 21:29:25 aips2adm
// exhale: Base release 18.000.00
//
// Revision 17.6 2002/01/23 19:42:48 hravlin
// Changed several off_t's to size_t's in MapSegment to make picky compilers
// happy.
//
// Revision 17.5 2002/01/22 21:55:01 hravlin
// The IsNaNf macro wasn't working with 64 bit compilers.
// header_len_ and the variable index are size_t.
//
// Revision 17.3 2002/01/09 18:12:01 hravlin
// Changed the way existence of ieeefp.h is checked for.
// Changed references to MAXVALUE to FLOATMAX which is defined in Av.h.
// Changed maximum # of pages to be mapped to 16384. (64MB on many systems).
// Apple's OS X uses getpagesize().
//
// Revision 17.2 2002/01/07 22:52:20 hravlin
// Removed check for __P.
// Included <float.h> to get FLT_MAX
//
// Revision 17.1 2002/01/03 21:07:17 hravlin
// Define M_PI if it isn't alread defined.
//
// Revision 17.0 2001/11/12 19:42:54 aips2adm
// exhale: Base release 17.000.00
//
// Revision 16.0 2001/05/03 01:43:00 aips2adm
// exhale: Base release 16.000.00
//
// Revision 15.0 2000/10/26 17:12:16 aips2adm
// exhale: Base release 15.000.00
//
// Revision 14.1 2000/07/18 16:55:24 hravlin
// Assume result of strrchr is const char *.
//
// Revision 14.0 2000/03/23 16:08:55 aips2adm
// exhale: Base release 14.000.00
//
// Revision 13.2 1999/09/29 16:49:48 hravlin
// Fixed compiler warnings.
//
// Revision 13.1 1999/08/25 19:53:56 hravlin
// Edits (mostly casts) to remove compiler warnings.
//
// Revision 13.0 1999/08/10 18:40:44 aips2adm
// exhale: Base release 13.000.00
//
// Revision 12.0 1999/07/15 00:23:56 aips2adm
// exhale: Base release 12.000.00
//
// Revision 11.1 1999/04/30 09:45:40 gvandiep
// Moved part of the code in the attach_ function to an initattach_ function.
// egcs 1.1.1/2 gave an internal compiler error and separating this
// part of the code cured the problem.
//
// Revision 11.0 1998/10/03 07:01:36 aips2adm
// exhale: Base release 11.000.00
//
// Revision 10.1 1998/08/14 17:59:55 hr
// Minor format change to error message in get(string)keyword.
//
// Revision 10.0 1998/07/20 17:55:45 aips2adm
// exhale: Base release 10.000.00
//
// Revision 9.5 1998/06/11 17:32:09 hr
// Changes in MapSegment to handle cases where off_t is long long (SGI).
//
// Revision 9.4 1998/02/18 21:59:56 hr
// Changed couts to cerr.
//
// Revision 9.3 1997/11/21 18:26:06 hr
// In attach_(), if the value of CDELT in the file is 0.0, reset it to 1.0
// so we don't get a singular matrix when it's multiplied by the PC matrix.
//
// Revision 9.2 1997/10/29 19:55:40 hr
// attach_() Added support for CD matrices. Fixed a problem with reading
// PC matrix keywords.
//
// Revision 9.1 1997/10/22 19:33:21 hr
// Changed attach_() to use defaults and print a warning message if any
// of CRPIX, CDELT or CRVAL keywords are missing. Turned off an initialization
// done for Sun's memory checker.
//
// Revision 9.0 1997/08/25 21:30:38 aips2adm
// exhale: Base release 09.000.00
//
// Revision 8.1 1997/05/07 15:53:16 hr
// Changes for DEC alpha including start of FITSTRACE.
//
// Revision 8.0 1997/02/20 03:16:51 aips2adm
// exhale: Base release 08.000.00
//
// Revision 7.19 1997/02/18 21:27:16 jpixton
// corrected pcmatrix bug.
//
// Revision 7.18 1997/02/17 11:27:15 gvandiep
// added __hpux__ switch to prevent inclusion of ieeefp.h
//
// Revision 7.17 1997/02/11 16:32:22 bglenden
// Minor linux fixup.
//
// Revision 7.16 1997/02/11 16:11:47 jpixton
// CTYPE keyword no longer mandatory - aipsview needs a label, so
// AxisN was chosen as a default ctype, where N is in 1,2,...NAXIS.
//
// Revision 7.15 1997/02/10 16:01:24 hr
// Under g++ M_PI wasn't being defined and g++ complained about a
// signed/unsigned comparision.
//
// Revision 7.14 1997/02/06 19:29:47 hr
// setMinMax() now sets min = max = 0.0 if it thinks the file is completely
// blanked.
//
// Revision 7.13 1997/01/31 21:32:31 jpixton
// Added support for CROTA FITS keyword for long/lat axis pair.
//
// Revision 7.12 1997/01/13 09:36:40 gvandiep
// _SC_PAGESIZE is called _SC_PAGE_SIZE by HP; extended #if switch
//
// Revision 7.11 1997/01/09 20:47:05 hr
// The SGI compiler under 5.3 couldn't find isnan() in math.h.
//
// Revision 7.10 1997/01/09 03:34:30 bglenden
// Add an ifdef so all AIPS++ little endian machines are automagicall
// discovered
//
// Revision 7.9 1997/01/07 23:00:15 hr
// Removed close() function and replaced calls to close with calls to detach_()
// which now resets pointers to NULL.
//
// Revision 7.8 1996/12/28 00:27:39 bglenden
// Set a deleted pointer to zero so it won't be deleted twice.
//
// Revision 7.7 1996/12/18 16:49:16 droberts
// Explicitly cast MAP_FAILED to char*.
//
// Revision 7.6 1996/12/17 17:08:59 droberts
// Replaced call to isnand() with isnan().
//
// Revision 7.5 1996/12/12 09:20:21 droberts
// Added Polarization axis name recognition. Removed message: 'cant map header'
//
// Revision 1.13 1996/11/06 22:44:25 hr
// Had previously misspelled __SVR4 as __SVR.
//
// Revision 1.12 1996/11/06 17:12:18 hr
// For SunOS 4.1.3
// isnand() is not defined. ulong was undefined. _SC_PAGE_SIZE is not defined.
//
// Revision 1.11 1996/10/10 20:04:12 pixton
// missing initializer.
//
// Revision 1.10 1996/09/25 21:23:19 hr
// Added close() function.
//
// Revision 1.9 1996/09/20 20:19:35 pixton
// Prefixed all classes with Av
//
// Revision 1.8 1996/09/17 16:33:49 hr
// Clear "kword" to 0 if running on a Sun to make memory checker happy.
//
// Revision 1.7 1996/09/12 17:00:18 hr
// getMinMax() wasn't checking for blanked data.
//
// Revision 1.6 1996/09/12 15:19:20 hr
// Turned on hack to get around apparent bug in Sun's memory checker.
// getBuffer() was computing "toMap" incorrectly.
//
// Revision 1.5 1996/08/23 17:00:09 pixton
// fixed dataUnits()
//
// Revision 1.4 1996/08/13 21:53:22 pixton
// added delete for pcmatrix in attach
//
// Revision 1.3 1996/08/12 22:48:04 pixton
// bad delete call fixed.
//
// Revision 1.2 1996/08/12 21:32:25 pixton
// modified IJKToWorld...
//
// Revision 1.1 1996/08/12 14:49:07 pixton
// Initial revision
//
// Revision 1.1 1996/08/02 16:53:19 hr
// Initial revision
//
//
//---------------------------------------------------------------------------
/* AvFitsDataSet.cc
Handles reading of FITS files for aipsview. Files are memory mapped using
a moving "window" so very large files may be accessed. The window is usually
set large enough so that "reasonable" sized files will fit in one window.
*/
#include <stdio.h>
#include <math.h>
// It appears that only IRIX and Solaris have ieeefp.h.
#if defined(__sgi) || defined(__sun)
#include <ieeefp.h>
#define isnan(x) isnanf((x))
#endif
#include <iostream.h>
#include <stdlib.h>
#include <fcntl.h>
#include <unistd.h>
#include <string.h>
#include <assert.h>
#ifdef __GNUC__
extern "C" {
#endif
#include <sys/mman.h>
#ifdef __GNUC__
}
#endif
#include <sys/stat.h>
#if defined(__APPLE_CC__) && defined(__POWERPC__)
// This needs to be after some above include file.
extern "C" { int isnan(double x); }
#endif
#include "AvString.h"
#include "AvFitsDataSet.h"
#include "Av.h"
#if !defined(M_PI)
#define M_PI 3.14159265358979323846
#endif
// Constants are different on different systems.
#ifndef MAP_FAILED
#define MAP_FAILED (void *)-1
#endif
// Types of data files AvFitsDataSet understands.
enum { TYPE_FLOAT, TYPE_16INT, TYPE_32INT, TYPE_UCHAR, TYPE_DOUBLE};
// The maximum number of pages that will be mapped at one time.
// This is currently a compile time constant, but it may become a resource
// someday.
// Note: The actual mapping may be up to two pages longer than this due to
// rounding to page boundaries.
//static const int MAXPAGES=4096; // ~ 16MB.
static const int MAXPAGES=16384; // ~ 64MB. (with 4k pages).
//static const int MAXPAGES=1;
// Simple class to handle memory mapping read only files.
class MapSegment {
public:
// Create a mapping object for the file descriptor.
// fd is an open file descriptor.
// The 'zero' will be where index 0 accesses data into the file and
// the maximum allowable mapped length will be the minimum of
// maxlength bytes and an internally generated maximum.(See MAXPAGES).
MapSegment(const int fd, size_t zero=0, size_t maxlength=0);
// Does not close the file descriptor.
virtual ~MapSegment();
Boolean mapped()const{return mapped_;}
// Create a mapping length elements long starting at offset
// elements from the zero point of the file. (Note: offset is >= 0).
// The actual map will be made by rounding offset down to the nearest
//page boundary and rounding length up to the next page boundary.
// Returns TRUE if the mapping succeeded. map will fail if
// the mmap fails or the length is greater than the maximum allowed
// length.
// Request is ignored if currently mapped and the requested mapping
// is valid. Otherwise, it will call unmap first. (Returns TRUE).
// If length is 0, the maximum length will be used.
Boolean map(const size_t offset, const size_t length=0,
const size_t elementSize=1);
void unmap(); // Gets rid of current mapping.
// Return a pointer to a value index elements into the file.
// The mapped segment will be (at least) nelements long. Returns
// NULL if the mapping can't be done.
// If nelements is 0, the maximum length will be used.
// NOTE: Since each call to pointer may result in a different mapping
// old pointers may not be valid and pointer comparisons may
// not work!
void *pointer(const size_t index=0,
const size_t nelements=0,
const size_t elementSize=1);
// Pointer to start of mapped segment. (Offset from file start).
inline char *segmentStart()const{return base_;}
// Length of actual segment.
inline size_t segmentLength()const
{return length_;}
// Is ptr a valid pointer for current mapping?
// (It may not point to what it pointed to initially).
inline Boolean validPointer(const char *ptr)const
{ return (mapped() &&
(ptr >= segmentStart()) &&
(ptr < segmentStart()+segmentLength()))
? TRUE : FALSE;}
// Is index valid for current mapping?
// Index is indexed from 'zero', not the start of the file.
// size is the element size.
inline Boolean validIndex(const size_t index, const size_t size=1)const
{ size_t idx = index*size + zero_; // To character offset.
return ((idx >= baseOffset_) && (idx < baseOffset_+length_))
? TRUE : FALSE;
}
// Returns TRUE if the range is valid for current mapping.
inline Boolean validRange(const size_t start, const size_t length,
const size_t size=1)const
{ if(length == 0) // No zero length ranges.
return FALSE;
return validIndex(start,size) && validIndex((start+length)-1,size);
}
// Round up to the next page boundary.
// (This isn't static to make sure pagesize_ is set).
inline size_t roundToPage(const size_t n)const
{ return (n/pagesize_ + ((n % pagesize_) ? 1 : 0))*pagesize_;}
// The maximum allowed # of elements to map.
inline size_t maxElements(const size_t elementSize=1)
const{return (maxlength_)/elementSize;}
// Offset parameter from last map().
inline size_t offset()const{return offset_;}
// Actual offset (index from start) of mapped data.
inline size_t baseOffset()const{return baseOffset_;}
private:
void init(const int fd, const size_t zero, const size_t maxlength);
int fd_;
Boolean mapped_; // True when there is a mapping.
size_t offset_; // Requested offset.
size_t baseOffset_; // What actually got passed to mmap.
char *pointer_; // Requested start of mapping.
char *base_; // Actual start of mapping.
size_t length_; // Actual length of mapped segment.
size_t zero_; // Index (in bytes) from start of file to
// beginning of data. (pointer(0)).
size_t filesize_; // No mapping past this.
size_t maxlength_; // Max # of bytes to map at a time.
// (Default is min of filesize_ - zero_
// and pagesize_*MAXPAGES.)
static int pagesize_; // System page size. Memory mapping has to
// be in chunks of this.
};
int MapSegment::pagesize_ = 0;
void MapSegment::init(const int fd, const size_t zero, const size_t maxlength)
{
fd_ = fd;
filesize_ = AvFitsDataSet::fileSize(fd);
length_ = offset_ = baseOffset_ = 0;
base_ = pointer_ = NULL;
if(zero < filesize_)
zero_ = zero;
else // Should make a stink here!
zero_ = filesize_ -1;
mapped_ = FALSE;
if(pagesize_ == 0)
#if defined(sparc) && ! defined(__SVR4)
pagesize_ = 4096; // For SunOS 4.1.3 compiler.
#elif defined(__hpux__)
pagesize_ = sysconf(_SC_PAGE_SIZE);
#elif defined(__APPLE__)
pagesize_ = getpagesize(); // Mac OS X. (BSD).
#else
pagesize_ = (int)sysconf(_SC_PAGESIZE);
#endif
// The maximum allowable map length request is the minimum of the
// data size, the maxlength parameter and the compiled maximum.
// (There is an implicit assumption that these values will hold
// an integral number of elements).
size_t max1 = filesize_ - zero_;
size_t max2 = pagesize_*MAXPAGES;
maxlength_ = (max1 <= max2) ? max1 : max2;
if((maxlength > 0) && (maxlength < maxlength_))
maxlength_ = maxlength;
}
MapSegment::MapSegment(const int fd, size_t zero, size_t maxlength)
{
init(fd, zero, maxlength);
}
MapSegment::~MapSegment()
{
unmap();
}
// Create a mapping starting at Offset elements from the zero point that
// is Length elements long. Returns TRUE if the mapping succeeded or the
// request was already mapped.
// Note: The actual mapping may be up to two pages longer than the request
// due to rounding to page boundaries.
Boolean MapSegment::map(const size_t Offset, const size_t Length,
const size_t elementSize)
{
char *ptr;
int prot, flags;
size_t offset;
size_t length, len;
length = (Length > 0) ? Length : maxElements(elementSize);
if(validRange(Offset, length, elementSize))
return TRUE;
offset = Offset*elementSize + zero_; // Offset in bytes.
length *= elementSize; // Length in bytes.
// Is length too big?
if(length > maxlength_)
{
cerr << "MapSeg::map: request too long.\n";
return FALSE;
}
// Make sure new mapping would stay within file.
if(offset+length > filesize_)
{
cerr << "MapSeg::map: request too long for file\n";
return FALSE;
}
if(mapped())
unmap();
prot = PROT_READ;
flags = MAP_SHARED;
// Round offset down to a page boundary.
off_t off = (off_t)(offset/pagesize_)*pagesize_;
// Round length up to next page boundary.
// (length + the extra from rounding down).
len = roundToPage(length + (offset-off));
ptr = (char *) mmap(0,len, prot, flags, fd_, off);
if(ptr != (char*)MAP_FAILED)
{
length_ = len; // Length of mapping.
offset_ = offset; // Caller's offset from start of file.
baseOffset_ = off; // Actual offset.
base_ = ptr; // Start of mapping.
// What caller expects.
pointer_ = base_ + (offset - baseOffset_);
mapped_ = TRUE;
#if 0
if(zero_ > 0)
cerr << "Mapped " << len << " bytes starting at " << off
<< " Offset " << Offset << " offset " << offset_ << " baseOffset "
<< baseOffset_ << endl;
#endif
#if 0
printf("Start = 0x%X End = 0x%X Pointer = 0x%X (+%d)\n",
base_, base_ + len-1, pointer_, pointer_ - base_);
//printf("|%8.8s| |%8.8s|\n", base_, pointer_);
fflush(stdout);
#endif
}
return mapped();
}
void MapSegment::unmap()
{
if(mapped())
{ munmap(base_, length_);
pointer_ = base_ = NULL;
baseOffset_ = 0;
length_ = offset_ = 0;
mapped_ = FALSE;
// (Don't reset zero_).
}
}
// Return a pointer index elements from the zero point or NULL.
void *MapSegment::pointer(const size_t index,
const size_t nelements,
const size_t elementSize)
{
if(!map((long)index, nelements, elementSize))
return NULL;
else
{ void *ptr = pointer_ + index*elementSize - offset_ + zero_;
return ptr;
}
}
// If this is defined, it will enable turning on tracing. Currently, only
// numerical kewords are traced.
//#define FITSTRACE
#ifdef FITSTRACE
static Boolean getBooleanEnv(const char *name, const Boolean def=FALSE)
{
if(name == NULL)
return def;
char *val = getenv(name);
if(val == NULL)
return def;
switch(*val) {
case 'T':
case 'Y':
case 't':
case 'y':
return TRUE;
default:
return FALSE;
}
}
static Boolean traceFits_ = FALSE;
static inline Boolean traceFits(){return traceFits_;}
static void checkFitsTrace()
{
traceFits_ = getBooleanEnv("AV_TRACEFITS", FALSE);
}
#endif
//================================================================
// Do we need to swap bytes? The assumption is made that if we do, 4 byte
// variables (ints and floats) need to have the high and low bytes exchanged
// and the middle two exchanged.
#if defined(__alpha) || defined(AIPS_LITTLE_ENDIAN)
// '__alpha' is defined by both DEC's cc and g++. Hopefully, it is also
// defined by DEC's c++ compiler.
#ifndef NEEDSWAP
#define NEEDSWAP
#endif
#endif
#ifdef NEEDSWAP
#define swap2(x) ( (((x)<<8) & 0xff00) | (((x)>>8) & 0xff))
#define swap4(x) ( ((((unsigned)(x))<<24) & 0xff000000)\
|((((unsigned)(x)) << 8) & 0x00ff0000) \
|((((unsigned)(x))>>8) & 0xff00) \
|((((unsigned)(x)) >> 24) & 0xff) )
// Reverses the order of bytes of a floating point number. Assumes
// that 'unsigned' and 'float' are the same length.
static inline float swapf(const float f)
{
union {
float f;
unsigned u;
} y;
y.f = f;
y.u = swap4(y.u);
return (y.f);
}
// Reverses the order of bytes of a double. Assumes that 2 'unsigned long's
// and 'double' are the same length.
static inline double swapd(const double d)
{ register unsigned long tmp;
union {
double d;
unsigned long a[2];
} y;
y.d = d;
tmp = y.a[0];
y.a[0] = swap4(y.a[1]);
y.a[1] = swap4(tmp);
return (y.d);
}
// Macros to get swapped values. They turn into NOPs if swapping is not
// needed.
#define GET2(x) (swap2(x))
#define GET4(x) (swap4(x))
#define GETF(x) swapf(x)
#define GETD(x) swapd(x)
#else
#define GET2(x) (x)
#define GET4(x) (x)
#define GETF(x) (x)
#define GETD(x) (x)
#endif
// Normally we use a macro to check for NaN rather than calling a function
// for every data point. If 'USEISNANF' is defined, the function will be used.
// NOTE: If the date are displayed as all WHITE, USEISNANF may need to
// be defined.
//#define USEISNANF
#ifndef USEISNANF
// Macro from ieeefp.h to test floats for NaN.
// (replaced 'long' with uInt and removed 'L' suffix on constants since
// longs are 64 bits in some circumstances).
#define isNaNf(x) (((*(uInt *)&(x) & 0x7f800000) == 0x7f800000) && \
((*(uInt *)&(x) & 0x007fffff) != 0x00000000))
#else
#define isNaNf(x) isnanf(x)
#endif
// FITS header constants.
static const int CARD_LEN = 80; // Length of a card.
static const int KEY_LEN = 8; // Length of a keyword.
static const int LOGIC_POSIT = 29; // T or F in column 30
AvFitsDataSet::AvFitsDataSet()
{
fits_init();
}
Boolean AvFitsDataSet::attached()const
{ return (fd_ >= 0) ? TRUE : FALSE;
}
// Force variables to 0 value.
void AvFitsDataSet::fits_init()
{
#ifdef FITSTRACE
checkFitsTrace();
#endif
fd_ = -1;
fileName_ = NULL;
dataSetName_ = NULL;
dataUnits_ = "";
header_len_ = 0;
filelength_ = 0;
bitpix_ = 0;
bytesPerElement_ = 0;
type_ = -1;
blanking_ = FALSE; // TRUE if integral data type and have blankval
blankval_ = 0;
dataMin_ = FLOATMAX;
dataMax_ = -FLOATMAX;
headerseg_ = dataseg_ = NULL;
cs_ = NULL;
}
AvFitsDataSet::~AvFitsDataSet()
{
detach_();
}
// Detach from file if attached. Cleanup and reset pointers.
// May be called internally after a failed attach to clean up.
void AvFitsDataSet::detach_()
{
if (fileName_) delete [] fileName_;
if (dataSetName_) delete [] dataSetName_;
if (headerseg_) delete headerseg_;
if (dataseg_) delete dataseg_;
if (cs_) delete cs_;
if(fd_ >= 0)
::close(fd_);
fits_init(); // Reset all the pointers.
}
// Error logging routines.
#if 0
void AvFitsDataSet::error_out(const char *funcname, const char *msg,
const char *param)const
{
cerr << "AvFitsDataSet::" << funcname << ": ";
if(fileName()!= NULL)
cerr << "(" << fileName() << ") ";
cerr << msg;
if(param != NULL)
cerr << param << endl;
else
cerr << endl;
}
#else
void AvFitsDataSet::error_out(const char *, const char *,
const char *)const
{
}
#endif
void AvFitsDataSet::error_out(const char *funcname, const char *msg,
int param)const
{
cerr << "AvFitsDataSet::" << funcname << ": ";
if(fileName()!= NULL)
cerr << "(" << fileName() << ") ";
cerr << msg << param << endl;
}
void AvFitsDataSet::error_out(const char *funcname, const char *msg,
const AvIPosition ¶m)const
{
cerr << "AvFitsDataSet::" << funcname << ": ";
if(fileName()!= NULL)
cerr << "(" << fileName() << ") ";
cerr << msg << param << endl;
}
////////////////////////////////////////////////////////////////
// FITS keyword routines.
////////////////////////////////////////////////////////////////
// Search for a keyword and return a pointer to the card containing it.
// Pointer may not be valid after another call to search.
const char * AvFitsDataSet::search(const char *keyword)const
{
char *ptr;
int keylen, index;
if((keyword == NULL) || (headerseg_ == NULL))
return NULL;
if((keylen = (int)strlen(keyword)) <= 0)
return NULL;
index = 0;
while((ptr = (char *)headerseg_->pointer(index, CARD_LEN,1)) != NULL)
{ if(strncmp(ptr, keyword, keylen)== 0)
return ptr; // Found card.
else
if(strncmp(ptr, "END", 3)== 0)
return NULL; // Found "END" card.
index += CARD_LEN;
}
return NULL; // Ran off end;
}
// Return the value of a keyword. If the keyword doesn't exist,
// returns the default and FALSE.
Boolean AvFitsDataSet::getKeyword(const char *keyword, int &value,
int def)const
{
const char *card = search(keyword);
Boolean result;
if(card != NULL)
{char *ptr;
const char *iptr = card+KEY_LEN+2; // (2 for "= ").
long lval = strtol(iptr, &ptr, 10);
if(ptr == iptr)
result = FALSE;
else
{ value = (int) lval;
result = TRUE;
}
}
else
result = FALSE;
if(!result)
value = def;
#ifdef FITSTRACE
if(traceFits())
{ cerr << "AvFitsDataSet::getKeyword(I): "
<< (result ? "T" : "F")
<< " " << keyword
<< " " << value << endl;
}
#endif
return result;
}
Boolean AvFitsDataSet::getKeyword(const char *keyword, float &fvalue,
float def)const
{
const char *card = search(keyword);
Boolean result;
if(card != NULL)
{
double value;
char *eptr;
const char *sptr = card + KEY_LEN + 2;
value = strtod(sptr, &eptr);
if(eptr == sptr)
result = FALSE;
else
{
fvalue = (float) value;
result = TRUE;
}
}
else
result = FALSE;
if(!result)
fvalue = def;
#ifdef FITSTRACE
if(traceFits())
{ cerr << "AvFitsDataSet::getKeyword(F): "
<< (result ? "T" : "F")
<< " " << keyword
<< " " << fvalue << endl;
}
#endif
return result;
}
// get double, float and int assume that strto{l,d} will stop even if the
// card is really messed up. This should always be the case since there
// will be an "END" card somewhere, if nothing else.
Boolean AvFitsDataSet::getKeyword(const char *keyword, double &value,
double def)const
{
const char *card = search(keyword);
Boolean result;
if(card != NULL)
{char *eptr;
const char *sptr = card + KEY_LEN + 2;
value = strtod(sptr, &eptr);
if(eptr == sptr)
result = FALSE;
else
result = TRUE;
}
else
result = FALSE;
if(!result)
value = def;
#ifdef FITSTRACE
if(traceFits())
{ cerr << "AvFitsDataSet::getKeyword(D): "
<< (result ? "T" : "F")
<< " " << keyword
<< " " << value << endl;
}
#endif
return result;
}
static void Strcpy(char *out, const char *in)
{ if((out!= NULL) && (in != NULL))
strcpy(out, in);
}
static const char QUOTE_CHAR = '\'';
static const char *QUOTE_STR = "\'";
// Value should be at least 73 characters long.
// Also returns FALSE if value is NULL.
Boolean AvFitsDataSet::getKeyword(const char *keyword, char *value,
const char *def)const
{
if(value == NULL) // No place to store value.
return FALSE;
const char *card = search(keyword);
if(card == NULL) // Didn't find keyword.
{ Strcpy(value, def);
return FALSE;
}
int len;
// Have to copy to temporary buffer to make sure strchr will stop.
char *start, buf[80];
memcpy(buf, card+KEY_LEN, CARD_LEN-KEY_LEN);
buf[CARD_LEN-KEY_LEN] = '\0';
// find pointer to first quote then point past it.
start = strchr(buf, QUOTE_CHAR);
if(start == NULL)
{ error_out("getKeyword (string)",
"Leading quote char not found for string keyword: ",
keyword);
Strcpy(value, def);
return FALSE;
}
start += 1;
// find distance till next quote (or end of card).
len = (int)strcspn(start, QUOTE_STR);
// Trim trailing blanks.
while( (start[--len] == ' ') && (len >= 0));
len++;
// copy into value
strncpy(value, start, len);
// null terminate
value[len] = '\0';
return TRUE;
}
// FITS' Logical keywords.
Boolean AvFitsDataSet::getKeyword(const char *keyword, Boolean &value,
const Boolean def)const
{const char *ptr = search(keyword);
if(ptr != NULL)
{ switch (ptr[LOGIC_POSIT]) {
case 'T':
value = TRUE;
break;
case 'F':
value = FALSE;
break;
default:
error_out("readCard",
"Invalid LOGICAL value for ", keyword);
value = def;
return FALSE;
}
return TRUE;
}
else
{ value = def;
return FALSE;
}
}
////////////////////////////////////////////////////////////////
/// AvDataSet related functions
////////////////////////////////////////////////////////////////
const char *AvFitsDataSet::dataSetName()const {return dataSetName_;}
const char *AvFitsDataSet::fileName()const { return fileName_;}
// Size along each axis.
AvIPosition AvFitsDataSet::shape() const
{
return shape_;
}
float AvFitsDataSet::dataMin()const { return dataMin_; }
float AvFitsDataSet::dataMax()const { return dataMax_; }
// Type an error message saying a keyword wasn't found then detach
// and return FALSE.
// Used only by attach_.
Boolean AvFitsDataSet::noKW(const char *kw)
{
char buf[128];
sprintf(buf, "Could not find keyword: %s", kw);
error_out("attach_", buf);
detach_();
return FALSE;
}
Boolean AvFitsDataSet::initattach_(const char* pname)
{
char *card;
if(attached())
{
error_out("attach_", "Already attached.");
return FALSE;
}
fits_init();
fd_ = ::open(pname, O_RDONLY);
if(fd_ < 0) {
error_out("attach_", "Can't open file: ", pname);
return FALSE;
}
const char *file = strrchr(pname, '/'); // Trim path.
if(file == NULL)
fileName_ = Strdup(pname);
else
fileName_ = Strdup(file+1);
off_t filesize = fileSize(fd_);
if( filesize < 0)
{ error_out("attach_", "Could not stat file.");