-
Notifications
You must be signed in to change notification settings - Fork 1
/
v_qubepds.pro
1121 lines (918 loc) · 43.4 KB
/
v_qubepds.pro
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
function V_QUBEPDS, filename, label, qub, NOSCALE = noscale, SILENT = silent, SUFFIX = suffix
;+ $Id: v_qubepds.pro,v 1.18 2013/11/05 13:04:02 sophie Exp $
;
; NAME:
; V_QUBEPDS
;
; PURPOSE:
; Read one qube object in a PDS file
; Intended for use with VIRTIS (Rosetta and VEx) data files
;
; CALLING SEQUENCE:
; Result=V_QUBEPDS (Filename,Label, Qub[,/NOSCALE,/SILENT] )
;
; INPUTS:
; FILENAME = Scalar string containing the name of the PDS data file (used only
; with attached labels).
; Label = String array containing the PDS label itself (as read by v_headpds)
; Qub = "pointer" from v_objpds defining the object/qube to be read
;
; OUTPUTS:
; Result = qube (3D) data array read from file, according to format described in label.
;
; OPTIONAL OUTPUT KEYWORDS:
; SUFFIX - A named variable that will contain the suffixes in the Qubes.
;
; OPTIONAL KEYWORDS:
;
; NOSCALE - If present and non-zero, then the ouput data (core and suffix)
; will not be scaled using the parameters in the PDS label.
; Default is to scale if parameters are present in label.
;
; SILENT - Skip console messages
;
; EXAMPLE:
; Read a PDS file TEST.PDS into an IDL array, im. Do not scale
; the data with BSCALE and BZERO.
;
; IDL> qub = V_QUBEPDS( 'TEST.PDS', lbl, Qub, SUFFIX = suf, /NOSCALE )
;
; RESTRICTIONS
; - Assume Qubes with 3-axes among the 6 possible axes for QUBE objects
; (spectral image-cubes, no images).
; - Only std architectures are supported (BSQ, BIL, BIP, + ISIS [b,l,s] )
; - Extra data can be contained in the sideplane, backplane or bottomplane,
; but only some associations are supported:
; SUFFIX_ITEMS = '(b,s,0)' or '(b,0,l)'
; - ISIS storage handled only when no suffix present
; BSQ storage handled only when no bottomplane present
; - All parameters are assumed to have the same variable type
; inside a given suffix (the first type in the list *_SUFFIX_ITEM_TYPE)
; - Unsigned integers are stored in signed integers variables in IDL < 5.2
; (but core data are always handled correctly).
;
; FURTHER COMMENTS
; - Suffix tags are derived fom BIP order (caution when editing)
; - V_QUBEPDS handles both MSB and LSB architectures
; - Handle ISM Qubes correctly (the suffix is actually a prefix).
; - Suffixes are converted to real if they need scaling with a floating coefficient.
; (can result in double array size).
; - If the file contains an empty qube core, only one suffix is allowed and
; the qube dimensions are used to define two of the suffix dimensions:
; X = 0 => Y and Z NE 0, and SX NE 0
; Y = 0 => X and Z NE 0, and SY NE 0
; (the two cases are exclusive)
; Ex:
; CORE_ITEMS = (0,25,24) Core is empty
; SUFFIX_ITEMS = (14,0,0) Suffix is a backplane (14,25,24)
;
; ROUTINES USED:
; V_PDSPAR, V_STR2NUM, V_LISTPDS, V_swapData,
; v_vaxtoIEEE, V_TYPEPDS...
;
; MODIFICATION HISTORY:
; Sept 2000 : Stephane Erard, IAS.
; Adapted from IMAGEPDS by John D. Koch
; (from version in SBNIDL 2.0, last modif 27 July 1999 by M. Barker)
; Updated, Nov 2000 (SE):
; - accepts suffixes with a single plane
; - Fixed suffix type (from SUFFIX_BYTES)
; - Fixed suffix reading, transfer to correct integer type
; (from *_SUFFIX_ITEM_BYTES)
; - Reads VIMS flight qubes correctly
; - Reads qubes with empty core and one suffix (ISM coordinate files)
; Updated, March 2001 (SE):
; - now reads qube with no suffix at all (as written by vv_writepds.pro)
; Updated, Sept 2001 (SE):
; - Fixed pb with suffix dimensions (now returns 1D suffix as cube, not array)
; Updated, Oct 2002 (SE):
; - Now reads BSQ Qube with no suffix (THEMIS)
; - In this case, does not require the SUFFIX_ITEM keyword
; Updated, Oct 2003 (SE):
; - Now returns both suffixes in a structure when present (OMEGA, VIMS)
; - Small fix related to Band suffix type
; Updated, June 2005 (SE, LESIA):
; - Use modern swapping methods, much faster
; - Now support PC_REAL types
; - Now process Vax floats and LSB integers independently!
; Updated, Oct 2005 (SE, LESIA):
; - Object pointer parsing now in v_pointpds (+ fixed object pointers given in bytes)
; - Now can read qubes mixed with other objects correctly
; - Data file must still contain either Qubes or Spectral_Qubes
; - Implemented basic bitmasking (in v_bmaskpds.pro)
; Updated, Nov 2005 (F. Henry, LESIA):
; - Passes SILENT option systematically to subroutines
; Updated, Dec 2005 (SE, LESIA):
; - Fix bitmask reading if not provided between "
; Updated, Feb 2006 (SE, LESIA):
; - Fixed bitmask handling (applied to cube core only)
; - Fixed structure length for I/O (solves rare EOF errors depending on dimensions)
; - Second thought: changed reading scheme (assoc replaced by readu). This should
; make it possible to read gizep files ~as fast as previously.
; - Optimized memory handling a bit.
; Updated, May 2006 (SE, LESIA):
; - Now returns scalar suffix (0B) if no suffix present (previously returned an ambiguous structure)
; Updated, June 2006 (SE):
; - Now performs IEEE float swapping (required to read floats on Intel)
; Updated, August 2006 (SE):
; - Fixed reading of suffices if multiple cubes in a single file (VEx M-calibrated files).
; Beware that it still does not parse individual suffix types (should be equal).
; Updated, Jan. 2007 (SE):
; - Can now read Qubes defined with composite names, allowing several qubes with
; different object names in the same file
; (includes SPECTRAL_QUBE, but also REF_QUBE, QUBE_1, etc...
; Apparently all/only names such as prefix_QUBE are alllowed)
; - Fixed to close all files when multiple cubes with attached label
; Stephane Erard, LESIA, Feb 2007:
; - New handles detached labels (OK from IDL 5.5)
; - Fixed multiple cubes, each with suffix (ISM)
; Stephane Erard, LESIA, Feb 2008:
; - Tentative support for bottomplanes in BIP and BIL storage
; Pb: suffix_byte is apparently expected to be uniform in PDS (not really stated...)
; so the code is expecting this
; Application to virtis : the suffix is half empty...
; Stephane Erard, LESIA, Oct 2008:
; - Fixed opening from detached label (as suggested by AC)
; B. Laurent, OVParis, 8/2012
; - Simplified to process a single qube
; S Erard, 8/2012:
; - Fixes, consistency + uses v_ojbpds
; - Implemented X and Y suffices in BSQ order
; S Erard, 10/2012:
; - Added quick and dirty support for Band/Line/Sample order (Cassini UVIS)
; Will work only if no suffix is present (to be updated)
; S Erard, 5/2013:
; - Implemented bottomplane/Z suffix in BSQ + Fixed sideplane type/coeff in BSQ
; S Erard, 10/2018:
; - Use default value (4) if SUFFIX_BYTES is missing (fix for VIMS detached labels)
;-
;
;###########################################################################
;
; LICENSE
;
; Copyright (c) 1999-2008, Stephane Erard, CNRS - Observatoire de Paris
; All rights reserved.
; Non-profit redistribution and non-profit 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, the following disclaimer, and
; all the modifications history.
; Redistributions in binary form must reproduce the above copyright
; notice, this list of conditions, the following disclaimer and all the
; modifications history in the documentation and/or other materials
; provided with the distribution.
; Neither the name of the CNRS and Observatoire de Paris 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 THE REGENTS AND CONTRIBUTORS ``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 THE REGENTS AND CONTRIBUTORS 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; 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.
;
On_error,0 ;2 = Return to user 0 = debug
; If there is no input file name, abort:
if N_params() LT 2 then begin
print,'Syntax - result = V_QUBEPDS(filename,label,qub[,/NOSCALE,/SILENT])'
return, -1
endif
; Save the input parameters:
fname = filename
noscale = keyword_Set(NOSCALE)
silent = keyword_set(SILENT)
; Get all object names, plus object number (in 'objects') and
; an array containing the line indices for each "OBJECT =" line (in 'obj_ind'),
; if there is more than one.
; object = v_pdspar(label,'OBJECT',COUNT=objects,INDEX=obj_ind)
; if !ERR EQ -1 then message, $
; 'ERROR - '+fname+' missing required OBJECT keyword'
; Identify Qube objects present from the object names in previous list, allowing for
; variations on the names (all Qube objects must contains "QUBE" in their name)
; Pointer contains the data pointer for all QUBE objects
;Qlist = where(strpos(object,'QUBE') GT -1, Qcount)
;If Qcount EQ 0 then message, 'ERROR - No pointers to QUBE data found in '+fname
;for Qi= 0, Qcount-1 do begin
; temp = v_pdspar(label,'^'+object(Qlist(Qi)))
; If Qi EQ 0 then pointer = temp else pointer = [pointer,temp]
;endfor
; Checkout image pointer
if (qub.pointer EQ '') then begin
if not (SILENT) then message, /cont, 'ERROR - No pointer to qube data found in '+qub.name
return, -1
endif
; pointer = v_pdspar(label,'^QUBE')
; if !ERR EQ -1 then pointer = v_pdspar(label,'^SPECTRAL_QUBE')
; if !ERR EQ -1 then message, $
; 'ERROR - No pointers to QUBE data found in '+fname
Date = (v_pdspar(label,'PRODUCT_CREATION_TIME', count = Nc))(0)
If Nc EQ 0 then if ~(SILENT) then message, fname+' missing PRODUCT_CREATION_TIME keyword', /cont
; If we've made it this far, we know we have a QUBE object to process, so we
; collect the required keywords which we expect to be in the file:
; ...Instrument...
; (handles non-conformity in ISM qubes)
ISM = 0
Instru = v_pdspar(label,'INSTRUMENT_ID')
If strupcase(instru(0)) EQ 'ISM' then ISM = 1
; ...RECORD_BYTES...
record_bytes = long(v_pdspar(label,'RECORD_BYTES'))
if !ERR EQ -1 then message, $
'ERROR - '+fname+' missing required RECORD_BYTES keyword'
; ...QUBE parameters (these should appear once for each qube, thus the
; various COUNTs returned should always be equal):
label_qub = label[qub.start:qub.stop]
Nvar = v_pdspar( label_qub,'AXIS_NAME',COUNT=Vcount,INDEX=V_ind)
Naxes = v_pdspar( label_qub,'AXES',COUNT=Ncount,INDEX=N_ind)
if Vcount(0) NE Ncount(0) then message, $
'ERROR - '+fname+': AXIS_NAME and AXES count discrepancy.'
Xvar = v_pdspar( label_qub,'CORE_ITEMS',COUNT=xcount,INDEX=x_ind)
if xcount(0) NE Ncount(0) then message, $
'ERROR - '+fname+': CORE_ITEMS and AXES count discrepancy.'
bitpix = v_pdspar( label_qub, 'CORE_ITEM_BYTES',COUNT=pixes,INDEX=pix_ind)
if pixes(0) NE Ncount(0) then message, $
'ERROR - '+fname+': CORE_ITEM_BYTES and AXES count discrepancy.'
smp_type = v_pdspar(label_qub, 'CORE_ITEM_TYPE', COUNT=smpcount, INDEX=smp_ind)
Bmask = v_pdspar(label_qub,'SAMPLE_BIT_MASK',COUNT=maskcount,INDEX=bmk_ind, /nonum)
bscale = float(v_pdspar(label_qub, 'CORE_MULTIPLIER',INDEX=scl_ind))
if (scl_ind(0) eq -1) then bscale = 1.
bzero = float(v_pdspar(label_qub, 'CORE_BASE', INDEX=zer_ind))
if (zer_ind(0) eq -1) then bzero = 0.
if (bzero EQ 0. and bscale EQ 1.) then Noscale =1
; Check suffix parameters
Svar = v_pdspar( label_qub,'SUFFIX_ITEMS',COUNT=Scount,INDEX=suff_ind)
SSbyte = v_pdspar( label_qub, 'SAMPLE_SUFFIX_ITEM_BYTES',COUNT=Spixes,INDEX=Spix_ind)
SBbyte = v_pdspar( label_qub, 'BAND_SUFFIX_ITEM_BYTES',COUNT=SBpixes,INDEX= Bpix_ind)
SLbyte = v_pdspar( label_qub, 'LINE_SUFFIX_ITEM_BYTES',COUNT=SLpixes,INDEX= Lpix_ind)
Sbyte = v_pdspar( label_qub, 'SUFFIX_BYTES',COUNT= temp, INDEX=Suffb_ind)
If temp EQ 0 then begin ; in case it is missing (VIMS), use default value
temp = 1
Sbyte = 4
endif
; if SBpixes * Spixes NE 0 then begin ; back & side planes
; Spix_ind = [Spix_ind,T_ind]
; ind = sort(Spix_ind)
; Spix_ind = Spix_ind(ind)
; SSbyte = SSbyte(ind)
; endif
; if SBpixes * SLpixes NE 0 then begin ; back & bottom planes
; Spix_ind = [T_ind,U_ind]
; ind = sort(Spix_ind)
; Spix_ind = Spix_ind(ind)
; SSbyte = SSbyte(ind)
; endif
; if Spixes EQ 0 and SBpixes NE 0 then begin ; band suffix only
; SSbyte = SBbyte
; Spix_ind = T_ind
; endif
; Spixes = Spixes + SBpixes
; if Spixes EQ 0 and SLpixes NE 0 then begin ; bottom suffix only
; SSbyte = SLbyte
; Spix_ind = U_ind
; endif
; Spixes = Spixes + SBpixes + SLpixes
; if Spixes(0) NE Scount(0) or temp(0) NE Scount(0) then message, $
; 'ERROR - '+fname+': SUFFIX_ITEMS and *_SUFFIX_ITEM_BYTES count discrepancy.'
if temp(0) NE Scount(0) then message, $
'ERROR - '+fname+': SUFFIX_ITEMS and SUFFIX_BYTES count discrepancy.'
Ssmp_type = v_pdspar(label_qub, 'SAMPLE_SUFFIX_ITEM_TYPE', $
COUNT=Ssmpcount, INDEX=Ssmp_ind)
SBsmp_type = v_pdspar(label_qub, 'BAND_SUFFIX_ITEM_TYPE', $
COUNT=SBsmpcount, INDEX=SBsmp_ind)
SLsmp_type = v_pdspar(label_qub, 'LINE_SUFFIX_ITEM_TYPE', $
COUNT=SLsmpcount, INDEX=SLsmp_ind)
; if Ssmpcount * SBsmpcount NE 0 then $
; Ssmp_ind = ([Ssmp_ind,T_ind])(sort([Ssmp_ind,T_ind]))
; if Ssmpcount EQ 0 then Ssmp_ind = T_ind
Sbscale =(v_pdspar(label_qub, 'SAMPLE_SUFFIX_MULTIPLIER',INDEX=Sscl_ind,$
COUNT = sccount))
SBbscale =(v_pdspar(label_qub, 'BAND_SUFFIX_MULTIPLIER',INDEX= Bscl_ind,$
COUNT = SBccount))
SLbscale =(v_pdspar(label_qub, 'LINE_SUFFIX_MULTIPLIER',INDEX= Lscl_ind,$
COUNT = SLccount))
; if sccount * SBccount NE 0 then $
; Sscl_ind = ([Sscl_ind,T_ind])(sort([Sscl_ind,T_ind]))
; if sccount EQ 0 then Sscl_ind = T_ind
Sbzero =(v_pdspar(label_qub, 'SAMPLE_SUFFIX_BASE', INDEX=Szer_ind,$
COUNT = sccount))
SBbzero =(v_pdspar(label_qub, 'BAND_SUFFIX_BASE', INDEX= Bzer_ind,$
COUNT = SBccount))
SLbzero =(v_pdspar(label_qub, 'LINE_SUFFIX_BASE', INDEX= Lzer_ind,$
COUNT = SLccount))
; We can now infer the number of QUBEs. If there is >1, we'll need a
; structure to hold them:
qubes = xcount
if qubes GT 1 then begin
data = CREATE_STRUCT('qubes',qubes)
if not (SILENT) then message,'Return type will be a structure with '$
+strtrim(string(qubes+1),2)+' elements',/INFORM
endif
if scount(0) GT 0 then begin
suffix = CREATE_STRUCT('suffixes',scount(0))
endif else suffix = 0B
;___________________________________
;
; Now we're ready to read in the data for each QUBE described in the label.
; Recall that the obj_ind array contains an index into the "OBJECT =" lines
; in the PDS label array:
iter = 1 ; 'iter' is the number of processed cubes
; Next if this is not the right type of object...
; If object(i) NE 'QUBE' and object(i) NE 'SPECTRAL_QUBE' then continue
; If where(Qlist EQ i) EQ -1 then continue ; skip if not in identified Qube list
; Set the local OBJECT pointers (obj_now = current, obj_nxt = next):
;obj_now = obj_ind(i)
;if i LT objects(0)-1 then begin
; obj_nxt = obj_ind(i+1)
;endif else begin
; lblsz = size(label) ; Retrieves the dimension sizes of 'label'
; obj_nxt = lblsz(1) ; Sets obj_next = number of lines in 'label'
;endelse
; We need to gather the parameters (lines, samples, data type) for this
; particular QUBE (there may be more than one!). To do this, we use
; the pointers into the 'label' array gathered when doing the initial
; check for parameters existence. We select the parameter lines that
; fall between the pointer for the current OBJECT and that for the
; next OBJECT (or end of the 'label' array). This should always return
; a single positive scalar for each parameter (although we check this):
;ap = V_ind ; AXIS_NAME
xp = x_ind ; CORE_ITEMS
bp = pix_ind ; CORE_ITEM_BYTES
sp = smp_ind ; CORE_ITEM_TYPE
;sfp= scl_ind ; CORE_MULTIPLIER
;zp = zer_ind ; CORE_BASE
Sxp = Suff_ind ; SUFFIX_ITEMS
;Sb = Suffb_ind ; SUFFIX_BYTES
;Sbp = Spix_ind ; S_S_ITEM_BYTES
;SBbp = Bpix_ind ; B_S_ITEM_BYTES
;SLbp = Lpix_ind ; L_S_ITEM_BYTES
;Ssp = Ssmp_ind ; S_S_ITEM_TYPE
;SBsp = SBsmp_ind ; B_S_ITEM_TYPE
;SLsp = SLsmp_ind ; L_S_ITEM_TYPE
;Ssfp= Sscl_ind ; S_S_MULTIPLIER
;Szp = Szer_ind ; S_S_BASE
;Bsfp= Bscl_ind ; B_S_MULTIPLIER
;Bzp = Bzer_ind ; B_S_BASE
;Lsfp= Lscl_ind ; L_S_MULTIPLIER
;Lzp = Lzer_ind ; L_S_BASE
Bm = bmk_ind ; BIT MASK
if xp GT -1 AND bp GT -1 AND sp GT -1 then begin
; Extract the three dimension sizes from CORE_ITEMS
temp = Nvar
axes_N=v_listpds(temp, count=as, silent = silent)
if as NE 3 then message,'ERROR - Qube should have exactly 3 dimensions'
Case 1 of
axes_N(0) eq 'BAND' and axes_N(1) eq 'SAMPLE' and axes_N(2) eq 'LINE': order=0 ; BIP (ISM, VIRTIS)
axes_N(0) eq 'SAMPLE' and axes_N(1) eq 'BAND' and axes_N(2) eq 'LINE': order=1 ; BIL (VIMS, OMEGA)
axes_N(0) eq 'SAMPLE' and axes_N(1) eq 'LINE' and axes_N(2) eq 'BAND': order=2 ; BSQ (Themis)
axes_N(0) eq 'BAND' and axes_N(1) eq 'LINE' and axes_N(2) eq 'SAMPLE': order=3 ; ISIS std? (Cassini UVIS)
Else: message, 'ERROR - '+fname+' has non-standard interleave mode'
EndCase
if order EQ 2 then begin
;message, 'ERROR - BSQ mode not handled so far'
; message, 'INFO - BSQ mode handled with no suffix only (so far), trying', /cont
nosuffix =1
endif
Dimen = Xvar
X=v_listpds(Dimen, count=cs, silent = silent)
if cs NE 3 then message,'ERROR - Qube core is not 3D'
Z=long(X(2))
Y=long(X(1))
X=long(X(0))
; If we're not running in SILENT mode, we print the array dimensions:
nocube = 0
if X*Y*Z NE 0 then begin ; if one dimension is zero, no cube
if not (SILENT) then begin
text = string(X,Y,Z, format='(I4, " by",I4," by",I4," Qube")')
message,'Now reading ' + text ,/INFORM
endif
endif else begin
message, "INFO - "+fname+" has an empty qube core",/CON
nocube = 1
noscale = 1 ; inhibits core scaling
endelse
; Grab the appropriate value for CORE_ITEM_BYTES and convert it to a scalar:
bits = v_str2num(bitpix)
bits = bits(0) ; warning : this is given in BYTES for Qubes
; Determine the byte ordering by checking the CORE_ITEM_TYPE value:
sample_type = smp_type
Stype = sample_type(0)
Core_type = v_typepds(Stype, bits, ITYPE = integer_type, $
Stype = sample_type)
; retrieve bitmask if present
if bm GT -1 then Mask = Bmask
;==================================================================
; Now look at suffix area
; Suffix = 0
if Sxp GT -1 then begin
; Extract dimensions from SUFFIX_ITEMS
nosuffix = 0
Dimen = Svar
SX=v_listpds(Dimen, count=cs, silent = silent)
if cs NE 3 then message,'ERROR - Inconsistent suffix dimensions'
SZ=long(SX(2)) ; bottomplane
SY=long(SX(1)) ; sideplane
SX=long(SX(0)) ; backplane
; If SZ NE 0 then $
; message,fname+' Ñ Bottom plane present, not read', /INFO
If nocube then $
If Z EQ 0 or (X EQ 0 and SX*Y EQ 0) or (Y EQ 0 and X*SY EQ 0) then $
message,'ERROR - Inconsistent suffix dimensions for an empty core'
If SZ EQ 0 and SY EQ 0 and SX EQ 0 then nosuffix = 1 ; no suffix in the file
if SX GE 0 then begin
if not (SILENT) then begin
text = string(SX,SY,SZ, format='(I4, " by",I4," by",I4)')
message,'Suffix area is ' + text,/INFORM
endif
endif else begin
message,fname+" has improper suffix dimensions, no data array read"
endelse
if nosuffix NE 1 then begin
; Grab the appropriate value for SUFFIX_BYTES
; and convert it to scalar:
Sbits = v_str2num(Sbyte)
temp = Sbits(0) ; warning : this is given in BYTES for Qubes
Sbits=temp ; keep only the first element so far...
if cs EQ -1 then Sbits = temp(0) ; if only one value
If Sbits NE 2 and Sbits NE 4 then $
message,fname+" has non-standard suffix bytes", /info
; suffix items are now processed independently
; SSbits = v_str2num(SSbyte(Sbp(0)), silent = silent) ; UNCHECKED, SE 11/2000
; temp = Ssbits(0) ; warning : this is given in BYTES for Qubes
; Ssbits=(v_listpds(temp, count=cs, silent = silent))(0) ; keep only the first element so far...
; if cs EQ -1 then Ssbits = temp(0) ; if only one value
; If Ssbits GT Sbits then begin
; message,fname+" has inconsistent suffix bytes", /info
; Ssbits = sbits
; endif
; Determine the byte ordering by checking the S_ITEM_TYPE value + scaling
if SY GT 0 then begin ; backplane
case order of
0: SSbits = v_str2num(SSbyte, silent = silent) ; bip
1: SSbits = v_str2num(SBbyte, silent = silent) ; bil
2: SSbits = v_str2num(SLbyte, silent = silent) ; bsq
endcase
temp = Ssbits(0) ; warning : this is given in BYTES for Qubes
Ssbits=(v_listpds(temp, count=cs, silent = silent))(0) ; keep only the first element so far...
if cs EQ -1 then Ssbits = temp(0) ; if only one value
If SSbits GT Sbits then begin
message,fname+" has inconsistent suffix bytes", /info
Ssbits = sbits
endif
case order of
0: SSuffix_type = Ssmp_type
1: SSuffix_type = SBsmp_type
2: SSuffix_type = SLsmp_type
; 2: message, 'BSQ with suffix, not implemented'
3: message, 'ISIS with suffix, not implemented'
endcase
Stype = (v_listpds(SSuffix_type, count=cs, silent = silent))(0) ;use only first element, should be all the same
if cs EQ -1 then Stype = Ssuffix_type(0) ; if only one value
Ssuffix_type = v_typepds(Stype, Sbits, ITYPE = Sinteger_type, $
Stype = SSample_type)
case order of
0: bid = Sbscale
1: bid = SBbscale
2: bid = SLbscale
endcase
SSscale = (v_listpds(bid, count=cs, silent = silent))
If cs EQ 1 then SSscale = replicate(SSscale(0),SY) ;use only first element, should be all the same
If cs EQ 0 then SSscale = replicate(1.,SY) ;no scaling
case order of
0: bid = Sbzero
1: bid = SBbzero
2: bid = SLbzero
endcase
SSzero = (v_listpds(bid, count=cs, silent = silent))
If cs EQ 1 then SSzero = replicate(SSzero(0),SY) ;use only first element, should be all the same
If cs EQ 0 then SSzero = replicate(0., SY) ;no scaling
endif
if SX GT 0 then begin ; sideplane
case order of
0: SBbits = v_str2num(SBbyte, silent = silent)
1: SBbits = v_str2num(SSbyte, silent = silent)
2: SBbits = v_str2num(SSbyte, silent = silent) ; fixed, 5/2013
endcase
temp = SBbits(0) ; warning : this is given in BYTES for Qubes
SBbits=(v_listpds(temp, count=cs, silent = silent))(0) ; keep only the first element so far...
if cs EQ -1 then SBbits = temp(0) ; if only one value
If SBbits GT Sbits then begin
message,fname+" has inconsistent suffix bytes", /info
SBbits = sbits
endif
case order of
0: BSuffix_type = SBsmp_type
1: BSuffix_type = Ssmp_type
2: BSuffix_type = Ssmp_type ; fixed, 5/2013
3: message, 'ISIS with suffix, not implemented'
endcase
Stype = (v_listpds(Bsuffix_type, count=cs, silent = silent))(0) ;use only first element, should be all the same
if cs EQ -1 then Stype = Bsuffix_type(0) ; if only one value
Bsuffix_type = v_typepds(Stype, Sbits, ITYPE = Binteger_type, $
Stype = Bsample_type)
case order of
0: bid = SBbscale
1: bid = Sbscale
2: bid = Sbscale ; fixed, 5/2013
endcase
BSscale = (v_listpds(bid, count=cs, silent = silent))
If cs EQ 1 then BSscale = replicate(BSscale(0), SX) ;use only first element, should be all the same
If cs EQ 0 then BSscale = replicate(1., SX) ;no scaling
case order of
0: bid = SBbzero
1: bid = Sbzero
2: bid = Sbzero ; fixed, 5/2013
endcase
BSzero = (v_listpds(bid, count=cs, silent = silent))
If cs EQ 1 then BSzero = replicate(BSzero(0),SX) ;use only first element, should be all the same
If cs EQ 0 then BSzero = replicate(0., SX) ;no scaling
endif
if SZ GT 0 then begin ; bottomplane
case order of
0: SLbits = v_str2num(SLbyte, silent = silent)
1: SLbits = v_str2num(SLbyte, silent = silent)
2: SLbits = v_str2num(SBbyte, silent = silent) ; 5/2013
endcase
temp = SLbits(0) ; warning : this is given in BYTES for Qubes
SLbits=(v_listpds(temp, count=cs, silent = silent))(0) ; keep only the first element so far...
if cs EQ -1 then SLbits = temp(0) ; if only one value
If SLbits GT Sbits then begin
message,fname+" has inconsistent suffix bytes", /info
SLbits = sbits
endif
case order of
0: LSuffix_type = SLsmp_type
1: LSuffix_type = SLsmp_type
2: LSuffix_type = SBsmp_type ; 5/2013
3: message, 'ISIS with suffix, not implemented'
endcase
Stype = (v_listpds(Lsuffix_type, count=cs, silent = silent))(0) ;use only first element, should be all the same
if cs EQ -1 then Stype = Lsuffix_type(0) ; if only one value
Lsuffix_type = v_typepds(Stype, Sbits, ITYPE = Linteger_type, Stype = Lsample_type)
case order of
0: bid = SLbscale
1: bid = SLbscale
2: bid = SBbscale
endcase
LSscale = (v_listpds(bid, count=cs, silent = silent))
If cs EQ 1 then LSscale = replicate(LSscale(0), SZ) ;use only first element, should be all the same
If cs EQ 0 then LSscale = replicate(1., SZ) ;no scaling
case order of
0: bid = SLbzero
1: bid = SLbzero
2: bid = SBbzero
endcase
LSzero = (v_listpds(bid, count=cs, silent = silent))
If cs EQ 1 then LSzero = replicate(LSzero(0),SZ) ;use only first element, should be all the same
If cs EQ 0 then LSzero = replicate(0., SZ) ;no scaling
endif
endif else suffix = 0B ; reset return value
endif else begin
nosuffix = 1
SX = (SY = (SZ = 0 ))
suffix = 0B ; reset return value
endelse
;==================================================================
; Open file, retrieve offset to object
PtObj = V_POINTPDS(qub.pointer,record_bytes)
datafile_found = (PtObj.filename NE '')
if datafile_found NE 0 then begin ; detached label
fname = file_search(PtObj.filename, /fold) ; works from IDL 5.5 and up
temp = file_info(fname)
; If not found in current directory, try in label directory
if not(temp.exists) or fname eq "" then begin
DirName = v_getpath(filename, FBname) ; get path to label under IDL ³ 5.4
fname = file_search(Dirname+PtObj.filename, /fold)
temp = file_info(fname)
endif
if not(temp.exists) or (fname eq "") then message, 'ERROR - Could not open file: '+ PtObj.filename
openr, unit, fname, ERROR=err, /GET_LUN, /Compress
endif else begin ; attached label
openr, unit, fname, ERROR=err, /GET_LUN, /Compress
if err NE 0 then begin
message, 'ERROR - Could not re-open '+fname
endif
endelse
; PtObj = V_POINTPDS(pointer(iter),record_bytes)
; If datafile name found, assume it is in the same directory as the label
; Retrieve possible indication of directory in label filename.
; datafile_found = (PtObj.filename NE '')
; if datafile_found NE 0 then begin
;; requires IDL 6.0!
;; dir = File_DirName(fname, /mark) ; look in label directory if set
;; cd, current = bid
;; Probably does not work Ñ SE Feb 2006
; CASE !version.os_family OF
; 'unix' :Pathsep="/"
; 'MacOS' :Pathsep =":"
; 'Win' :Pathsep ="\"
; ELSE: Pathsep ="" ; assumes data in the same directory
; ENDCASE
; dir = ''
; fname = dir + PtObj.filename
; openr, unit, fname, ERROR=err, /GET_LUN, /Compress
; ; If the exact file name didn't work, try change case:
; if err NE 0 then begin
; fname = dir + strlowcase(PtObj.filename)
; ; requires IDL 5.5
; fname = dir + file_search(fname, /fold)
; openr, unit, fname, ERROR=err, /GET_LUN, /Compress
; endif
; If we still haven't successfully opened a file, signal an error and
; give up:
; if err NE 0 then begin
; message, 'ERROR - could not open data file: '+dir+ PtObj.filename
; endif
; endif else begin
; If there was no data file name, then we must have an offset from the
; beginning of the input file. In this case we just re-open the input
; file, the name of which is still in 'fname':
; openr, unit, fname, ERROR=err, /GET_LUN, /BLOCK, /Compress
; if err NE 0 then begin
; message, 'ERROR - Could not re-open '+fname
; endif
; endelse
;====================================================================
; OK, now we're ready to read the QUBE data. We'll associate the opened
; data file unit with an array of the appropriate type based on BYTES per
; pixel, in 'bits', and the sample type, in 'sample_type':
; (SE warning: type length is given in bytes, not bits, in the Qube object -
; the variable name 'bits' is inherited from Imagepds.pro).
; check that this IDL can handle unsigned integer types
If core_type GE 12 and !version.release LT 5.2 then $
core_type = core_type -10
If SX GT 0 then $
If Bsuffix_type GE 12 and !version.release LT 5.2 then $
Bsuffix_type = Bsuffix_type -10
If SY GT 0 then $
If Ssuffix_type GE 12 and !version.release LT 5.2 then $
Ssuffix_type = Ssuffix_type -10
; Declare a single structure for any suffix configuration
; Set suffix to zero (some bytes are not used)
; + adjust ISM files configuration (suffix is a prefix)
If nocube then begin ; Qube core empty
If SX NE 0 then begin
S_line = Make_array(SX, Type = BSuffix_type)
F_line = {S_line: S_line}
F_frame = {F_line:replicate(F_line,Y)}
S_line = 0B
F_line = 0B
endif
;else F_line = {C_line: C_line}
If SY NE 0 then begin
SS_frame = reform(Make_array(X, SY, Type = SSuffix_type), X, SY)
F_frame = {SS_frame: SS_frame}
SS_frame = 0B
endif
;else F_frame = {F_line:replicate(F_line,Y)}
F_Qube= replicate(F_frame,Z)
F_frame = 0B
; bottomplane read separately, should work
endif else begin ; Qube core present
C_line = Make_array(X, Type = Core_type, /nozero)
If SX NE 0 then begin
S_line = Make_array(SX, Type = BSuffix_type, /nozero)
If ISM then F_line = {S_line: S_line, C_line: C_line} else $
F_line = {C_line: C_line, S_line: S_line}
endif else F_line = {C_line: C_line}
S_line = 0B
If SY NE 0 then begin
SS_frame = reform(Make_array(X, SY, Type = SSuffix_type, /nozero), X, SY)
F_frame = {F_line:replicate(F_line,Y), SS_frame: SS_frame}
endif else F_frame = {F_line:replicate(F_line,Y)}
SS_frame = 0B
F_line = 0B
F_Qube= replicate(F_frame,Z)
F_frame = 0B
; No: Bottom plane is read separately afterward if present!
; Appends bottom plane at the end when present
; If SZ NE 0 then begin
; S_qube = Make_array(X, Y, SZ, Type = LSuffix_type, /nozero)
; F_Qube= {F_Qube:F_Qube,S_qube:S_qube}
; endif
; S_qube = 0B
endelse
; Read data, place core and suffix in different qubes, release space
; file = assoc(unit, F_Qube, PtObj.offset, /packed)
; F_Qube = 0B
; element = file(0)
; free_lun, unit
; file =0B
If PtObj.offset NE 0 then temp = bytarr(PtObj.offset)
If PtObj.offset NE 0 then readu, unit, temp
temp = 0B
readu, unit, F_qube
If SZ NE 0 then begin ; read bottom plane if present
LSuffix = reform(Make_array(X, Y, SZ, Type = LSuffix_type, /nozero), X, Y, SZ)
readu, unit, LSuffix
endif
;help, /mem
; removed in Feb 2008, seems to duplicate V_swapData
; (this initially handled SUFFIX_BYTES > *_SUFFIX_ITEM_BYTES after reading - to be done, but after swap)
If not(nocube) then Core = F_Qube.F_line.C_line else core = 0B
If SX NE 0 then begin
BSuffix = F_Qube.F_line.S_line
; If Sbits EQ 2 and Sbbits EQ 1 then BSuffix = BSuffix / 256
; If Sbits EQ 4 and Sbbits EQ 2 then BSuffix = BSuffix / 256L^2
endif
If SY NE 0 then begin
SSuffix = reform(F_Qube.SS_frame, X, SY, Z)
; If Sbits EQ 2 and Ssbits EQ 1 then SSuffix = SSuffix / 256
; If Sbits EQ 4 and Ssbits EQ 2 then SSuffix = SSuffix / 256L^2
endif
If SZ NE 0 then begin
; LSuffix = reform(F_Qube.S_qube, X, Y, SZ) ; done already
; If Sbits EQ 2 and SLbits EQ 1 then LSuffix = LSuffix / 256
; If Sbits EQ 4 and SLbits EQ 2 then LSuffix = LSuffix / 256L^2
endif
; element = 0B
F_Qube = 0B
;help, /mem
; If we didn't get a data type we can work with, convert it:
CASE sample_type OF
'MSB': V_swapData, core, SILENT = silent
'LSB': V_swapData, core, /LSB, SILENT = silent
'IEEE': V_swapData, core, SILENT = silent
'PC': V_swapData, core, /LSB, SILENT = silent
'VAX': v_vaxtoIEEE, core ; always floats
else: begin
message,'WARNING - Unrecognized SAMPLE_TYPE ('+smp_type+'), no conversion performed', /INF
end
ENDCASE
If SX NE 0 then begin
CASE Bsample_type OF
'MSB': V_swapData, Bsuffix, SILENT = silent
'LSB': V_swapData, Bsuffix, /LSB, SILENT = silent
'IEEE': V_swapData, Bsuffix, SILENT = silent
'PC': V_swapData, Bsuffix, /LSB, SILENT = silent
'VAX': v_vaxtoIEEE, Bsuffix ; always floats
else: begin
message,'WARNING - Unrecognized SUFFIX_TYPE ('+Bsample_type+'), no conversion performed', /INF
end
ENDCASE
endif
If SY NE 0 then begin
CASE Ssample_type OF
'MSB': V_swapData, SSuffix, SILENT = silent
'LSB': V_swapData, SSuffix, /LSB, SILENT = silent
'IEEE': V_swapData, SSuffix, SILENT = silent
'PC': V_swapData, SSuffix, /LSB, SILENT = silent
'VAX': v_vaxtoIEEE, SSuffix ; always floats
else: begin
message,'WARNING - Unrecognized SUFFIX_TYPE ('+Ssample_type+'), no conversion performed', /INF
end
ENDCASE
endif
If SZ NE 0 then begin
CASE Lsample_type OF
'MSB': V_swapData, LSuffix, SILENT = silent
'LSB': V_swapData, LSuffix, /LSB, SILENT = silent
'IEEE': V_swapData, LSuffix, SILENT = silent
'PC': V_swapData, LSuffix, /LSB, SILENT = silent
'VAX': v_vaxtoIEEE, LSuffix ; always floats
else: begin
message,'WARNING - Unrecognized SUFFIX_TYPE ('+Lsample_type+'), no conversion performed', /INF
end
ENDCASE
endif
; Performs bit masking before conversions if required
; (may cause problems with unconventional IDL types)
if bm GT -1 then begin
core = v_bmaskpds( core, mask)
endif
; Convert signed bytes, not an IDL type in 5.3
if (core_type EQ 1 AND integer_type EQ 'SIGNED') then begin
; Allocate an array of 2-byte integers to hold the final values:
core = fix(core)
fixitlist = WHERE(core GT 127)
if fixitlist[0] GT -1 then begin
core[fixitlist] = core[fixitlist] - 256
endif
endif
; Perform conversion to unsigned integers in IDL versions < 5.2
if (!version.release LT 5.2) then begin
if (core_type EQ 2 AND integer_type EQ 'UNSIGNED') then begin
core = long(core)
fixitlist = WHERE(core LT 0)
if fixitlist[0] GT -1 then begin
core[fixitlist] = core[fixitlist] + 65536
endif
endif else if (core_type EQ 3 AND integer_type EQ 'UNSIGNED') then begin
; These must be converted to real numbers. In order to preserve as
; much precision as possible, we convert to double-precision reals:
; (should now convert to long64)
core = double(core)
fixitlist = WHERE(core LT 0.D0)
if fixitlist[0] GT -1 then begin
core[fixitlist] = core[fixitlist] + 4.294967296D+9
endif
endif
endif
; Now we scale the data we've read in using the corresponding
; CORE_MULTIPLIER and CORE_BASE values from the label, unless the
; user has indicated /NOSCALE. Use fast function if IDL permits.
if NOT keyword_set(NOSCALE) then begin
if (!version.release GE 5.2) then begin ; supposed to be faster