-
Notifications
You must be signed in to change notification settings - Fork 173
/
backend_common.c
888 lines (829 loc) · 34 KB
/
backend_common.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
#include <sys/types.h>
#include <pwd.h>
#include <ctype.h>
#include "backend_common.h"
#include "misc_utils.h"
#include "fftw3.h"
static long long currentspectra = 0;
static int using_MPI = 0;
#define SWAP(a,b) tmpswap=(a);(a)=(b);(b)=tmpswap;
extern int clip_times(float *rawdata, int ptsperblk, int numchan,
float clip_sigma, float *good_chan_levels);
extern void float_dedisp(float *data, float *lastdata,
int numpts, int numchan,
int *delays, float approx_mean, float *result);
extern void dedisp_subbands(float *data, float *lastdata,
int numpts, int numchan,
int *delays, int numsubbands, float *result);
extern short transpose_float(float *a, int nx, int ny, unsigned char *move,
int move_size);
extern double DATEOBS_to_MJD(char *dateobs, int *mjd_day, double *mjd_fracday);
extern void read_filterbank_files(struct spectra_info *s);
extern void read_PSRFITS_files(struct spectra_info *s);
extern fftwf_plan plan_transpose(int rows, int cols, float *in, float *out);
extern int *ranges_to_ivect(char *str, int minval, int maxval, int *numvals);
void psrdatatype_description(char *outstr, psrdatatype ptype)
{
if (ptype == SIGPROCFB)
strcpy(outstr, "SIGPROC filterbank");
else if (ptype == PSRFITS)
strcpy(outstr, "PSRFITS");
else if (ptype == SCAMP)
strcpy(outstr, "SCAMP 1-bit filterbank");
else if (ptype == BPP)
strcpy(outstr, "GBT BCPM");
else if (ptype == WAPP)
strcpy(outstr, "GBT/Caltech Spigot");
else if (ptype == SPIGOT)
strcpy(outstr, "WAPP");
else if (ptype == SUBBAND)
strcpy(outstr, "PRESTO subband");
else if (ptype == DAT)
strcpy(outstr, "PRESTO time series of floats");
else if (ptype == SDAT)
strcpy(outstr, "PRESTO time series of shorts");
else if (ptype == EVENTS)
strcpy(outstr, "Event list");
else
strcpy(outstr, "Unknown");
return;
}
void set_using_MPI(void)
{
using_MPI = 1;
}
void close_rawfiles(struct spectra_info *s)
{
int ii;
if (s->datatype == PSRFITS) {
int status = 0;
for (ii = 0; ii < s->num_files; ii++)
fits_close_file(s->fitsfiles[ii], &status);
free(s->fitsfiles);
} else {
for (ii = 0; ii < s->num_files; ii++)
fclose(s->files[ii]);
free(s->files);
}
}
void read_rawdata_files(struct spectra_info *s)
{
if (s->datatype == SIGPROCFB)
read_filterbank_files(s);
else if (s->datatype == PSRFITS)
read_PSRFITS_files(s);
else if (s->datatype == SCAMP)
exit(1);
else if (s->datatype == BPP)
exit(1);
else if (s->datatype == WAPP)
exit(1);
else if (s->datatype == SPIGOT)
exit(1);
return;
}
void add_padding(float *fdata, float *padding, int numchan, int numtopad)
{
int ii;
for (ii = 0; ii < numtopad; ii++)
memcpy(fdata + ii * numchan, padding, numchan * sizeof(float));
}
void identify_psrdatatype(struct spectra_info *s, int output)
{
char *root, *suffix, ctmp[40];
/* Split the filename into a rootname and a suffix */
if (split_root_suffix(s->filenames[0], &root, &suffix) == 0) {
fprintf(stderr,
"Error!: The input filename (%s) must have a suffix!",
s->filenames[0]);
exit(-1);
} else {
if (strcmp(suffix, "dat") == 0)
s->datatype = DAT;
else if (strcmp(suffix, "sdat") == 0)
s->datatype = SDAT;
else if (strncmp(suffix, "sub0", 4) == 0)
s->datatype = SUBBAND;
else if (strcmp(suffix, "events") == 0)
s->datatype = EVENTS;
else if (strcmp(suffix, "bcpm1") == 0 || strcmp(suffix, "bcpm2") == 0)
s->datatype = BPP;
else if (strcmp(suffix, "fil") == 0 || strcmp(suffix, "fb") == 0)
s->datatype = SIGPROCFB;
else if ((strcmp(suffix, "fits") == 0) || (strcmp(suffix, "sf") == 0)) {
if (strstr(root, "spigot_5") != NULL)
s->datatype = SPIGOT;
// else if (is_PSRFITS(s->filenames[0])) s->datatype = PSRFITS;
else
s->datatype = PSRFITS;
} else if (strcmp(suffix, "pkmb") == 0)
s->datatype = SCAMP;
else if (isdigit(suffix[0]) && isdigit(suffix[1]) && isdigit(suffix[2]))
s->datatype = WAPP;
else
s->datatype = UNSET;
}
psrdatatype_description(ctmp, s->datatype);
if (output)
printf("Assuming the data are %s format...\n", ctmp);
free(root);
free(suffix);
}
void spectra_info_set_defaults(struct spectra_info *s)
{
strcpy(s->telescope, "unset");
strcpy(s->observer, "unset");
strcpy(s->source, "unset");
strcpy(s->frontend, "unset");
strcpy(s->backend, "unset");
strcpy(s->project_id, "unset");
strcpy(s->date_obs, "unset");
strcpy(s->ra_str, "unset");
strcpy(s->dec_str, "unset");
strcpy(s->poln_type, "unset");
strcpy(s->poln_order, "unset");
s->datatype = UNSET;
s->N = 0;
s->T = 0.0;
s->dt = 0.0;
s->fctr = 0.0;
s->lo_freq = 0.0;
s->hi_freq = 0.0;
s->orig_df = 0.0;
s->chan_dm = 0.0;
s->df = 0.0;
s->BW = 0.0;
s->ra2000 = 0.0;
s->dec2000 = 0.0;
s->azimuth = 0.0;
s->zenith_ang = 0.0;
s->beam_FWHM = 0.0;
s->time_per_subint = 0.0;
s->scan_number = 0;
s->tracking = 1;
s->orig_num_chan = 0;
s->num_channels = 0;
s->num_polns = 0;
s->num_beams = 1;
s->beamnum = 0;
s->summed_polns = 1;
s->FITS_typecode = 0;
s->bits_per_sample = 0;
s->bytes_per_spectra = 0;
s->samples_per_spectra = 0;
s->bytes_per_subint = 0;
s->spectra_per_subint = 0;
s->samples_per_subint = 0;
s->min_spect_per_read = 0;
s->num_files = 0;
s->offs_sub_col = 0;
s->dat_wts_col = 0;
s->dat_offs_col = 0;
s->dat_scl_col = 0;
s->data_col = 0;
s->apply_scale = 0;
s->apply_offset = 0;
s->apply_weight = 0;
s->apply_flipband = 0;
s->remove_zerodm = 0;
s->use_poln = 0;
s->flip_bytes = 0;
s->num_ignorechans = 0;
s->zero_offset = 0.0;
s->clip_sigma = 0.0;
s->start_MJD = NULL;
s->files = NULL;
s->fitsfiles = NULL;
s->padvals = NULL;
s->header_offset = NULL;
s->start_subint = NULL;
s->num_subint = NULL;
s->ignorechans = NULL;
s->ignorechans_str = NULL;
s->start_spec = NULL;
s->num_spec = NULL;
s->num_pad = NULL;
};
void print_spectra_info(struct spectra_info *s)
// Output a spectra_info structure in human readable form
{
char ctmp[40];
psrdatatype_description(ctmp, s->datatype);
printf("From the %s file '%s':\n", ctmp, s->filenames[0]);
if (strcmp(s->telescope, "unset") != 0)
printf(" Telescope = %s\n", s->telescope);
if (strcmp(s->observer, "unset") != 0)
printf(" Observer = %s\n", s->observer);
if (strcmp(s->source, "unset") != 0)
printf(" Source Name = %s\n", s->source);
if (strcmp(s->frontend, "unset") != 0)
printf(" Frontend = %s\n", s->frontend);
if (strcmp(s->backend, "unset") != 0)
printf(" Backend = %s\n", s->backend);
if (strcmp(s->project_id, "unset") != 0)
printf(" Project ID = %s\n", s->project_id);
if (strcmp(s->date_obs, "unset") != 0)
printf(" Obs Date String = %s\n", s->date_obs);
if (s->datatype == PSRFITS) {
int itmp;
double dtmp;
DATEOBS_to_MJD(s->date_obs, &itmp, &dtmp);
sprintf(ctmp, "%.14f", dtmp);
printf(" MJD start time (DATE-OBS) = %5i.%14s\n", itmp, ctmp + 2);
printf(" MJD start time (STT_*) = %19.14Lf\n", s->start_MJD[0]);
} else {
printf(" MJD start time = %19.14Lf\n", s->start_MJD[0]);
}
printf(" RA J2000 = %s\n", s->ra_str);
printf(" RA J2000 (deg) = %-17.15g\n", s->ra2000);
printf(" Dec J2000 = %s\n", s->dec_str);
printf(" Dec J2000 (deg) = %-17.15g\n", s->dec2000);
printf(" Tracking? = %s\n", s->tracking ? "True" : "False");
printf(" Azimuth (deg) = %-.7g\n", s->azimuth);
printf(" Zenith Ang (deg) = %-.7g\n", s->zenith_ang);
if (strcmp(s->poln_type, "unset") != 0)
printf(" Polarization type = %s\n", s->poln_type);
if (s->num_polns >= 2 && !s->summed_polns)
printf(" Number of polns = %d\n", s->num_polns);
else if (s->summed_polns)
printf(" Number of polns = 2 (summed)\n");
else
printf(" Number of polns = 1\n");
if (strcmp(s->poln_order, "unset") != 0)
printf(" Polarization order = %s\n", s->poln_order);
printf(" Sample time (us) = %-17.15g\n", s->dt * 1e6);
printf(" Central freq (MHz) = %-17.15g\n", s->fctr);
printf(" Low channel (MHz) = %-17.15g\n", s->lo_freq);
printf(" High channel (MHz) = %-17.15g\n", s->hi_freq);
printf(" Channel width (MHz) = %-17.15g\n", s->df);
printf(" Number of channels = %d\n", s->num_channels);
if (s->chan_dm != 0.0) {
printf(" Orig Channel width (MHz) = %-17.15g\n", s->orig_df);
printf(" Orig Number of channels = %d\n", s->orig_num_chan);
printf(" DM used for chan dedisp = %-17.15g\n", s->chan_dm);
}
printf(" Total Bandwidth (MHz) = %-17.15g\n", s->BW);
if (s->num_beams > 0)
printf(" Beam = %d of %d\n", s->beamnum, s->num_beams);
printf(" Beam FWHM (deg) = %.3f\n", s->beam_FWHM);
printf(" Spectra per subint = %d\n", s->spectra_per_subint);
if (s->start_subint != NULL && s->datatype != SIGPROCFB)
printf(" Starting subint = %d\n", s->start_subint[0]);
if (s->num_subint != NULL && s->datatype != SIGPROCFB)
printf(" Subints per file = %d\n", s->num_subint[0]);
printf(" Spectra per file = %lld\n", s->num_spec[0]);
printf(" Time per subint (sec) = %-.12g\n", s->time_per_subint);
printf(" Time per file (sec) = %-.12g\n", s->num_spec[0] * s->dt);
printf(" bits per sample = %d\n", s->bits_per_sample);
if (s->bits_per_sample==8)
printf(" Are bytes signed? = %s\n",
s->signedints ? "True" : "False");
{
int fact = 1;
if ((s->datatype == PSRFITS) && (s->bits_per_sample < 8))
fact = 8 / s->bits_per_sample;
printf(" bytes per spectra = %d\n", s->bytes_per_spectra / fact);
printf(" samples per spectra = %d\n", s->samples_per_spectra);
printf(" bytes per subint = %d\n", s->bytes_per_subint / fact);
printf(" samples per subint = %d\n", s->samples_per_subint);
}
printf(" zero offset = %-17.15g\n", s->zero_offset);
printf(" Invert the band? = %s\n",
(s->apply_flipband > 0) ? "True" : "False");
if (s->header_offset != NULL)
printf(" bytes in file header = %d\n", s->header_offset[0]);
if (s->datatype == PSRFITS) {
int ii, numhdus, hdutype, status = 0;
char comment[120];
printf(" PSRFITS Specific info:\n");
fits_get_num_hdus(s->fitsfiles[0], &numhdus, &status);
printf(" HDUs = primary, ");
for (ii = 2; ii < numhdus + 1; ii++) {
fits_movabs_hdu(s->fitsfiles[0], ii, &hdutype, &status);
fits_read_key(s->fitsfiles[0], TSTRING, "EXTNAME", ctmp, comment,
&status);
printf("%s%s", ctmp, (ii < numhdus) ? ", " : "\n");
}
printf(" FITS typecode = %d\n", s->FITS_typecode);
printf(" DATA column = %d\n", s->data_col);
printf(" Apply scaling? = %s\n",
s->apply_scale ? "True" : "False");
printf(" Apply offsets? = %s\n",
s->apply_offset ? "True" : "False");
printf(" Apply weights? = %s\n",
s->apply_weight ? "True" : "False");
}
}
void print_spectra_info_summary(struct spectra_info *s)
// Print the basic details of the files that are being processed
{
int ii, nn;
printf(" Number of files = %d\n", s->num_files);
if (s->num_polns >= 2 && !s->summed_polns)
printf(" Num of polns = %d\n", s->num_polns);
else if (s->summed_polns)
printf(" Num of polns = 2 (summed)\n");
else
printf(" Num of polns = 1\n");
printf(" Center freq (MHz) = %.8g\n", s->fctr);
printf(" Num of channels = %d\n", s->num_channels);
printf(" Sample time (s) = %-14.14g\n", s->dt);
printf(" Spectra/subint = %d\n", s->spectra_per_subint);
printf(" Total points (N) = %lld\n", s->N);
printf(" Total time (s) = %-14.14g\n", s->T);
printf(" Clipping sigma = %.3f\n", s->clip_sigma);
if (s->zero_offset != 0.0)
printf(" zero offset = %-17.15g\n", s->zero_offset);
printf(" Invert the band? = %s\n", (s->apply_flipband > 0) ? "True" : "False");
printf(" Byteswap? = %s\n", s->flip_bytes ? "True" : "False");
printf(" Remove zeroDM? = %s\n", s->remove_zerodm ? "True" : "False");
if (s->datatype == PSRFITS) {
printf(" Apply scaling? = %s\n", s->apply_scale ? "True" : "False");
printf(" Apply offsets? = %s\n", s->apply_offset ? "True" : "False");
printf(" Apply weights? = %s\n", s->apply_weight ? "True" : "False");
}
if (s->num_ignorechans)
printf(" Ignoring channels = %s\n", s->ignorechans_str);
printf("\nFile Start Spec Samples Padding Start MJD\n");
printf("---- ---------- ---------- ---------- --------------------\n");
if (s->datatype == SUBBAND || s->datatype == DAT ||
s->datatype == EVENTS || s->datatype == SDAT)
nn = 1;
else
nn = s->num_files;
for (ii = 0; ii < nn; ii++)
printf("%-4d %10lld %10lld %10lld %19.14Lf\n", ii + 1,
s->start_spec[ii], s->num_spec[ii], s->num_pad[ii], s->start_MJD[ii]);
printf("\n");
}
void spectra_info_to_inf(struct spectra_info *s, infodata * idata)
// Convert a spectra_info structure into an infodata structure
{
int ii, index = 2;
char ctmp[100];
struct passwd *pwd;
strcpy(idata->object, s->source);
hours2hms(s->ra2000 / 15.0, &(idata->ra_h), &(idata->ra_m), &(idata->ra_s));
deg2dms(s->dec2000, &(idata->dec_d), &(idata->dec_m), &(idata->dec_s));
strcpy(idata->telescope, s->telescope);
strcpy(idata->instrument, s->backend);
idata->num_chan = s->num_channels;
idata->dt = s->dt;
// DATEOBS_to_MJD(s->date_obs, &(idata->mjd_i), &(idata->mjd_f));
idata->mjd_i = (int) (s->start_MJD[0]);
idata->mjd_f = s->start_MJD[0] - idata->mjd_i;
idata->N = s->N;
idata->freqband = s->BW;
idata->chan_wid = s->df;
idata->freq = s->lo_freq;
idata->fov = s->beam_FWHM * 3600.0; // in arcsec
idata->bary = 0;
idata->numonoff = 0;
strcpy(idata->band, "Radio");
pwd = getpwuid(geteuid());
strcpy(idata->analyzer, pwd->pw_name);
strcpy(idata->observer, s->observer);
if (s->summed_polns)
sprintf(ctmp,
"2 polns were summed. Samples have %d bits.", s->bits_per_sample);
else
sprintf(ctmp, "%d polns were not summed. Samples have %d bits.",
s->num_polns, s->bits_per_sample);
sprintf(idata->notes, "Project ID %s, Date: %s.\n %s\n",
s->project_id, s->date_obs, ctmp);
// If we have more than one input file, see it we need onoff bins
if (s->num_files == 1 && s->num_pad[0] == 0) {
idata->numonoff = 0;
return;
}
/* Determine the topocentric onoff bins */
idata->numonoff = 1;
idata->onoff[0] = 0.0;
idata->onoff[1] = s->num_spec[0] - 1.0;
for (ii = 1; ii < s->num_files; ii++) {
if (s->num_pad[ii - 1]) {
idata->onoff[index] = idata->onoff[index - 1] + s->num_pad[ii - 1];
idata->onoff[index + 1] = idata->onoff[index] + s->num_spec[ii];
idata->numonoff++;
index += 2;
} else {
idata->onoff[index - 1] += s->num_spec[ii];
}
}
if (s->num_pad[s->num_files - 1]) {
idata->onoff[index] = idata->onoff[index - 1] + s->num_pad[s->num_files - 1];
idata->onoff[index + 1] = idata->onoff[index];
idata->numonoff++;
}
}
long long offset_to_spectra(long long specnum, struct spectra_info *s)
// This routine offsets into the raw data files to the spectra
// 'specnum'. It returns the current spectra number.
{
long long retval;
retval = s->offset_to_spectra(specnum, s);
currentspectra = retval;
return retval;
}
void set_currentspectra(long long specnum)
// Set the static variable currentspectra to specnum. This is used
// 'by mpiprepsubband for the non-master CPUs to know what spectra they
// are getting for masking.
{
currentspectra = specnum;
}
int read_rawblocks(float *fdata, int numsubints, struct spectra_info *s,
int *padding)
// This routine reads numsubints rawdata blocks from raw radio pulsar
// data. The floating-point filterbank data is returned in rawdata
// which must have a size of numsubints * s->samples_per_subint. The
// number of blocks read is returned. If padding is returned as 1,
// then padding was added and statistics should not be calculated.
{
long long ii, loffset;
int retval = 0, gotblock = 0, pad = 0, numpad = 0, numvals;
static float *rawdata = NULL;
static int firsttime = 1;
numvals = s->spectra_per_subint * s->num_channels;
if (firsttime) {
// Needs to be twice as large for buffering if adding observations together
rawdata = gen_fvect(2 * numvals);
firsttime = 0;
}
*padding = 0;
for (ii = 0; ii < numsubints; ii++) {
gotblock = s->get_rawblock(rawdata, s, &pad);
if (gotblock == 0)
break;
retval += gotblock;
loffset = ii * numvals;
memcpy(fdata + loffset, rawdata, numvals * sizeof(float));
if (pad)
numpad++;
}
if (gotblock == 0) { // Now fill the rest of the data with padding
for (; ii < numsubints; ii++) {
long long jj, loffset2;
loffset = ii * numvals;
for (jj = 0; jj < s->spectra_per_subint; jj++) {
loffset2 = loffset + jj * s->num_channels;
memcpy(fdata + loffset2, s->padvals,
s->num_channels * sizeof(float));
}
}
numpad++;
}
/* Return padding 'true' if any block was padding */
if (numpad)
*padding = 1;
return retval;
}
int read_psrdata(float *fdata, int numspect, struct spectra_info *s,
int *delays, int *padding,
int *maskchans, int *nummasked, mask * obsmask)
// This routine reads numspect from the raw pulsar data defined in
// "s". Time delays and a mask are applied to each channel. It
// returns the # of points read if successful, 0 otherwise. If
// padding is returned as 1, then padding was added and statistics
// should not be calculated. maskchans is an array of length numchans
// contains a list of the number of channels that were masked. The #
// of channels masked is returned in nummasked. obsmask is the mask
// structure to use for masking.
{
int numread = 0;
double starttime = 0.0;
long long ii, jj, templen, loffset;
static float *tmpswap, *rawdata1, *rawdata2;
static float *currentdata, *lastdata;
static int firsttime = 1, numsubints = 1, allocd = 0, mask = 0;
static double duration = 0.0;
*nummasked = 0;
if (firsttime) {
if (numspect % s->spectra_per_subint) {
fprintf(stderr,
"Error!: numspect %d must be a multiple of %d in read_psrdata()!\n",
numspect, s->spectra_per_subint);
exit(-1);
} else
numsubints = numspect / s->spectra_per_subint;
if (obsmask->numchan)
mask = 1;
// The following can overflow a regular int
templen = ((long long) numsubints) * s->spectra_per_subint * s->num_channels;
if (templen > 1000000000L) {
printf("\nWARNING: Trying to allocate %.2f GB of RAM in read_psrdata()!!\n",
templen*8L/1e9);
printf(" This will possibly fail. Is the dispersive delay across the\n");
printf(" band longer than (or comparable to) the duration of the input file??\n");
}
rawdata1 = gen_fvect(templen);
rawdata2 = gen_fvect(templen);
allocd = 1;
duration = numsubints * s->time_per_subint;
currentdata = rawdata1;
lastdata = rawdata2;
}
/* Read, convert and de-disperse */
if (allocd) {
while (1) {
starttime = currentspectra * s->dt;
numread = read_rawblocks(currentdata, numsubints, s, padding);
if (mask)
*nummasked = check_mask(starttime, duration, obsmask, maskchans);
currentspectra += numread * s->spectra_per_subint;
/* Clip nasty RFI if requested and we're not masking all the channels */
if ((s->clip_sigma > 0.0) && !(mask && (*nummasked == -1)))
clip_times(currentdata, numspect, s->num_channels, s->clip_sigma,
s->padvals);
if (mask) {
if (*nummasked == -1) { /* If all channels are masked */
for (ii = 0; ii < numspect; ii++) {
loffset = ii * s->num_channels;
memcpy(currentdata + loffset,
s->padvals, s->num_channels * sizeof(float));
}
} else if (*nummasked > 0) { /* Only some of the channels are masked */
int channum;
for (ii = 0; ii < numspect; ii++) {
loffset = ii * s->num_channels;
for (jj = 0; jj < *nummasked; jj++) {
channum = maskchans[jj];
currentdata[loffset + channum] = s->padvals[channum];
}
}
}
}
if (s->num_ignorechans) { // These are channels we explicitly zero
int channum;
for (ii = 0; ii < numspect; ii++) {
loffset = ii * s->num_channels;
for (jj = 0; jj < s->num_ignorechans; jj++) {
channum = s->ignorechans[jj];
currentdata[loffset + channum] = 0.0;
}
}
}
if (!firsttime)
float_dedisp(currentdata, lastdata, numspect, s->num_channels,
delays, 0.0, fdata);
SWAP(currentdata, lastdata);
if (firsttime)
firsttime = 0;
else {
if (numread != numsubints) {
vect_free(rawdata1);
vect_free(rawdata2);
allocd = 0;
}
break;
}
}
return numsubints * s->spectra_per_subint;
} else {
return 0;
}
}
void get_channel(float chandat[], int channum, int numsubints, float rawdata[],
struct spectra_info *s)
// Return the values for channel 'channum' in 'chandat' of a block of
// 'numsubints' floating-point spectra data stored in 'rawdata'.
// 'rawdata' should have been initialized and then filled using
// read_rawblocks(), and 'chandat' must have at least 'numsubints' *
// 's->spectra_per_subint' spaces. Channel 0 is assumed to be the
// lowest freq channel.
{
long long ii, jj, numspec = numsubints * s->spectra_per_subint;
if (channum > s->num_channels || channum < 0) {
fprintf(stderr, "Error!: channum = %d is out of range in get_channel()!\n",
channum);
exit(-1);
}
/* Check to see if we are explicitly zeroing this channel */
if (s->num_ignorechans) {
for (ii = 0; ii < s->num_ignorechans; ii++) {
if (channum==s->ignorechans[ii]) { // zero it
for (jj = 0; jj < numspec; jj++)
chandat[jj] = 0.0;
return;
}
}
}
/* Else select the correct channel */
for (ii = 0, jj = channum; ii < numspec; ii++, jj += s->num_channels)
chandat[ii] = rawdata[jj];
}
int prep_subbands(float *fdata, float *rawdata, int *delays, int numsubbands,
struct spectra_info *s, int transpose,
int *maskchans, int *nummasked, mask * obsmask)
// This routine preps a block of raw spectra for subbanding. It uses
// dispersion delays in 'delays' to de-disperse the data into
// 'numsubbands' subbands. It stores the resulting data in vector
// 'fdata' of length 'numsubbands' * 's->spectra_per_subint'. The low
// freq subband is stored first, then the next highest subband etc,
// with 's->spectra_per_subint' floating points per subband. It
// returns the # of points read if succesful, 0 otherwise.
// 'maskchans' is an array of length numchans which contains a list of
// the number of channels that were masked. The # of channels masked
// is returned in 'nummasked'. 'obsmask' is the mask structure to use
// for masking. If 'transpose'==0, the data will be kept in time
// order instead of arranged by subband as above.
{
int ii, jj, offset;
double starttime = 0.0;
static float *tmpswap, *rawdata1, *rawdata2;
static float *currentdata, *lastdata;
static int firsttime = 1, mask = 0;
static fftwf_plan tplan1, tplan2;
*nummasked = 0;
if (firsttime) {
if (obsmask->numchan)
mask = 1;
rawdata1 = gen_fvect(s->spectra_per_subint * s->num_channels);
rawdata2 = gen_fvect(s->spectra_per_subint * s->num_channels);
currentdata = rawdata1;
lastdata = rawdata2;
// Make plans to do fast transposes using FFTW
tplan1 = plan_transpose(s->spectra_per_subint, s->num_channels,
currentdata, currentdata);
tplan2 = plan_transpose(numsubbands, s->spectra_per_subint, fdata, fdata);
}
/* Read and de-disperse */
memcpy(currentdata, rawdata,
s->spectra_per_subint * s->num_channels * sizeof(float));
starttime = currentspectra * s->dt; // or -1 subint?
if (mask)
*nummasked = check_mask(starttime, s->time_per_subint, obsmask, maskchans);
/* Clip nasty RFI if requested and we're not masking all the channels */
if ((s->clip_sigma > 0.0) && !(mask && (*nummasked == -1)))
clip_times(currentdata, s->spectra_per_subint, s->num_channels,
s->clip_sigma, s->padvals);
if (mask) {
if (*nummasked == -1) { /* If all channels are masked */
for (ii = 0; ii < s->spectra_per_subint; ii++)
memcpy(currentdata + ii * s->num_channels,
s->padvals, s->num_channels * sizeof(float));
} else if (*nummasked > 0) { /* Only some of the channels are masked */
int channum;
for (ii = 0; ii < s->spectra_per_subint; ii++) {
offset = ii * s->num_channels;
for (jj = 0; jj < *nummasked; jj++) {
channum = maskchans[jj];
currentdata[offset + channum] = s->padvals[channum];
}
}
}
}
if (s->num_ignorechans) { // These are channels we explicitly zero
int channum;
for (ii = 0; ii < s->spectra_per_subint; ii++) {
offset = ii * s->num_channels;
for (jj = 0; jj < s->num_ignorechans; jj++) {
channum = s->ignorechans[jj];
currentdata[offset + channum] = 0.0;
}
}
}
// In mpiprepsubband, the nodes do not call read_subbands() where
// currentspectra gets incremented.
if (using_MPI)
currentspectra += s->spectra_per_subint;
// Now transpose the raw block of data so that the times in each
// channel are the most rapidly varying index
fftwf_execute_r2r(tplan1, currentdata, currentdata);
if (firsttime) {
SWAP(currentdata, lastdata);
firsttime = 0;
return 0;
} else {
dedisp_subbands(currentdata, lastdata, s->spectra_per_subint,
s->num_channels, delays, numsubbands, fdata);
SWAP(currentdata, lastdata);
// Transpose the resulting data into spectra as a function of time
if (transpose == 0)
fftwf_execute_r2r(tplan2, fdata, fdata);
return s->spectra_per_subint;
}
}
int read_subbands(float *fdata, int *delays, int numsubbands,
struct spectra_info *s, int transpose, int *padding,
int *maskchans, int *nummasked, mask * obsmask)
// This routine reads a spectral block/subint from the input raw data
// files. The routine uses dispersion delays in 'delays' to
// de-disperse the data into 'numsubbands' subbands. It stores the
// resulting data in vector 'fdata' of length 'numsubbands' *
// 's->spectra_per_subint'. The low freq subband is stored first,
// then the next highest subband etc, with 's->spectra_per_subint'
// floating points per subband. It returns the # of points read if
// successful, 0 otherwise. If padding is returned as 1, then padding
// was added and statistics should not be calculated. 'maskchans' is
// an array of length numchans which contains a list of the number of
// channels that were masked. The # of channels masked is returned in
// 'nummasked'. 'obsmask' is the mask structure to use for masking.
// If 'transpose'==0, the data will be kept in time order instead of
// arranged by subband as above.
{
static int firsttime = 1;
static float *frawdata;
if (firsttime) {
// Check to make sure there isn't more dispersion across a
// subband than time in a block of data
if (delays[0] > s->spectra_per_subint) {
perror("\nError: there is more dispersion across a subband than time\n"
"in a block of data. Increase spectra_per_subint if possible.");
exit(-1);
}
// Needs to be twice as large for buffering if adding observations together
frawdata = gen_fvect(2 * s->num_channels * s->spectra_per_subint);
if (!s->get_rawblock(frawdata, s, padding)) {
perror("Error: problem reading the raw data file in read_subbands()");
exit(-1);
}
if (0 != prep_subbands(fdata, frawdata, delays, numsubbands, s,
transpose, maskchans, nummasked, obsmask)) {
perror("Error: problem initializing prep_subbands() in read_subbands()");
exit(-1);
}
firsttime = 0;
}
if (!s->get_rawblock(frawdata, s, padding)) {
return 0;
}
if (prep_subbands(fdata, frawdata, delays, numsubbands, s, transpose,
maskchans, nummasked, obsmask) == s->spectra_per_subint) {
currentspectra += s->spectra_per_subint;
return s->spectra_per_subint;
} else {
return 0;
}
}
void flip_band(float *fdata, struct spectra_info *s)
// Flip the bandpass
{
float ftmp;
int ii, jj, looffs, hioffs;
for (ii = 0; ii < s->spectra_per_subint; ii++) {
looffs = ii * s->num_channels;
hioffs = looffs + s->num_channels - 1;
for (jj = 0; jj < s->num_channels / 2; jj++, looffs++, hioffs--) {
ftmp = fdata[looffs];
fdata[looffs] = fdata[hioffs];
fdata[hioffs] = ftmp;
}
}
}
int *get_ignorechans(char *ignorechans_str, int minchan, int maxchan,
int *num_ignorechans, char **filestr)
// Parse an ignorechans string (or file it was from) and return it as
// a vector of length num_ignorechans. If the channel string came
// from a file, return the channel string in the file in filestr.
{
int ii;
char *parsestr, *sptr;
FILE *file;
long long filelen;
if ((file = fopen(ignorechans_str, "r")) != NULL) {
// If so, see how big it is in bytes
filelen = chkfilelen(file, 1);
// if not too big, assume that this is a string to parse
if (filelen < 100000L) {
*filestr = (char *) malloc(filelen+1);
// Now read lines of the file, until the first character
// is not a comment marker or a newline
do {
sptr = fgets(*filestr, filelen, file);
// Remove newline if needed
if ((*filestr)[strlen(*filestr)-1] == '\n')
(*filestr)[strlen(*filestr)-1] = '\0';
if (sptr != NULL &&
sptr[0] != '\n' &&
sptr[0] != '#' &&
0 != (ii = strlen(sptr))) { // This is a good line
// Copy the line read into parsestr
parsestr = (char *) malloc(strlen(*filestr)+1);
strcpy(parsestr, *filestr);
fclose(file);
break;
} else {
if (feof(file)) {
sprintf(*filestr,
"Error: end-of-file while looking for range string in get_ignorechans()\n");
perror(*filestr);
exit(EXIT_FAILURE);
}
}
} while (1);
} else {
parsestr = (char *) malloc(1000);
sprintf(parsestr,
"Error: '%s' is a file, but too big to parse in get_ignorechans()\n",
ignorechans_str);
perror(parsestr);
exit(EXIT_FAILURE);
}
} else {
// Input string name is not a file, so we will parse it directly
parsestr = ignorechans_str;
*filestr = NULL; // Not being used
}
return ranges_to_ivect(parsestr, minchan, maxchan, num_ignorechans);
}