Updated manpages.

man/yapp_ft.1

@@ -5,13 +5,12 @@
 .\# Created by Jayanth Chennamangalam on 2012.10.14
 .\#
 
-.TH YAPP_FT 1 "2013-06-02" "YAPP 3.4-beta" \
+.TH YAPP_FT 1 "2013-07-06" "YAPP 3.4-beta" \
 "Yet Another Pulsar Processor"
 
 
 .SH NAME
-yapp_ft \- perform Fourier transform and optionally polyphase filtering on \
-baseband data
+yapp_ft \- perform Fourier transform or PFB on baseband data
 
 
 .SH SYNOPSIS
@@ -21,12 +20,15 @@ baseband data
 
 
 .SH DESCRIPTION
-This program performs Fourier transform and optionally polyphase filtering on \
-baseband (raw voltage time series) data. In other words, this is a software \
-spectrometer. The input is expected to be 8-bit, complex, dual-polarization \
-data. The output is written in the headerless SIGPROC .fil format, along with \
-a .fhd configuration file that can be read by yapp_viewmetadata and \
-yapp_viewdata.
+This program performs a plain old Fourier transform or a polyphase filter \
+bank operation on baseband (raw voltage time series) data. In other words, \
+this is a software spectrometer. The input is expected to be 8-bit, complex, \
+dual-polarization data, interleaved in the following manner:
+.TP
+polXre0 | polXim0 | polYre0 | polYim0 | polXre1 | polXim1 | polYre1 | polYim1 | ...
+.TP
+The output is written in the headerless SIGPROC .fil format, along with \
+a .fhd configuration file.
 
 
 .SH OPTIONS
@@ -47,7 +49,7 @@ Sampling time in seconds.
 Centre frequency of the observing band in MHz.
 .TP
 .B \-b, --pfb
-Turn polyphase filtering on.
+Do polyphase filter bank.
 .TP
 .B \-t, --ntaps \fIntaps
 Number of taps in the PFB (default is 8).
@@ -82,14 +84,14 @@ The flags \-l (or --tsamp) and \-f (or --centre-freq) are required arguments.
 
 .SH FILES
 .TP
-If running with PFB on, this program requires a filter coefficients file to \
-be present in the current directory. Filter coefficients files can be created \
-using the yapp_genpfbcoeff.py Python script.
+If doing PFB, this program requires a filter coefficients file to be present \
+in the current directory. Filter coefficients files can be created using the \
+yapp_genpfbcoeff.py Python script.
 
 
 .SH EXAMPLE
 .TP
-The following performs an 8-tap polyphase filtering followed by a 1024-point \
+The following performs an 8-tap pre-filtering followed by a 1024-point \
 Fourier transform on the data in rawdata.dat. The spectra thus produced are \
 accumulated to a length of 10, and the output is written to a headerless \
 SIGPROC filterbank file named rawdata.dat.fil, and metadata is written to a \

man/yapp_viewdata.1

@@ -5,7 +5,7 @@
 .\# Created by Jayanth Chennamangalam on 2011.03.20
 .\#
 
-.TH YAPP_VIEWDATA 1 "2013-06-02" "YAPP 3.4-beta" \
+.TH YAPP_VIEWDATA 1 "2013-07-06" "YAPP 3.4-beta" \
 "Yet Another Pulsar Processor"
 
 
@@ -29,6 +29,9 @@ are supported:
 a .fhd configuration file is present in the same directory)
 .br
 3. SIGPROC .tim time series format
+.br
+4. PRESTO .dat time series format
+
 
 .SH OPTIONS
 .TP
@@ -69,6 +72,11 @@ This run displays the contents of the SIGPROC filterbank file data.fil, with \
 8192 time samples per plot, and using the 'copper' colour map.
 .TP
 yapp_viewdata -n 8192 -m copper data.fil
+.TP
+The following displays the contents of the PRESTO dedispersed time series \
+file data.dat in the /data directory.
+.TP
+yapp_viewmetadata /data/data.dat
 
 
 .SH SEE ALSO

man/yapp_viewmetadata.1

@@ -5,7 +5,7 @@
 .\# Created by Jayanth Chennamangalam on 2010.09.23
 .\#
 
-.TH YAPP_VIEWMETADATA 1 "2013-06-02" "YAPP 3.4-beta" \
+.TH YAPP_VIEWMETADATA 1 "2013-07-06" "YAPP 3.4-beta" \
 "Yet Another Pulsar Processor"
 
 
@@ -20,9 +20,8 @@ yapp_viewmetadata \- view metadata/data header/configuration information
 
 
 .SH DESCRIPTION
-As the name indicates, this program is used to display metadata/data \
-header/configuration information associated with a data file. The following \
-file types are supported:
+As the name indicates, this program is used to display metadata associated \
+with a data file. The following file types are supported:
 .P
 1. Search-mode PSRFITS
 .br
@@ -32,6 +31,8 @@ file types are supported:
 a .fhd configuration file is present in the same directory)
 .br
 4. SIGPROC .tim time series format
+.br
+5. PRESTO .dat time series format
 
 
 .SH OPTIONS
@@ -56,10 +57,10 @@ data file.
 .TP
 yapp_viewmetadata data.fil
 .TP
-The following displays the metadata for all DAS filterbank files in the \
-current working directory.
+The following displays the metadata for all PRESTO dedispersed time series \
+files in the /data directory.
 .TP
-yapp_viewmetadata *.spec
+yapp_viewmetadata /data/*.dat
 
 
 .SH SEE ALSO

src/yapp_ft.c

@@ -13,7 +13,7 @@
  *                                          (default is all)
  *     -l  --tsamp <tsamp>                  Sampling time in s
  *     -f  --centre-freq <freq>             Centre frequency of observing band
- *     -b  --pfb                            Turn PFB on
+ *     -b  --pfb                            Do polyphase filter bank
  *     -t  --ntaps <ntaps>                  Number of taps in the PFB
  *                                          (default is 8)
  *     -n  --nfft <nfft>                    Number of points in FFT
@@ -60,7 +60,7 @@ float *g_pfSumPowX = NULL;
 float *g_pfSumPowY = NULL;
 float *g_pfSumStokesRe = NULL;
 float *g_pfSumStokesIm = NULL;
-char g_cIsPFBOn = YAPP_FALSE;
+char g_cDoPFB = YAPP_FALSE;
 char g_acFileData[LEN_GENSTRING] = {0};
 char g_acFileCoeff[LEN_GENSTRING] = {0};
 int g_iFileData = 0;
@@ -172,7 +172,7 @@ int main(int argc, char *argv[])
 
             case 'b':   /* -b or --pfb */
                 /* set option */
-                g_cIsPFBOn = YAPP_TRUE;
+                g_cDoPFB = YAPP_TRUE;
                 break;
 
             case 't':   /* -t or --ntaps */
@@ -256,7 +256,7 @@ int main(int argc, char *argv[])
         return YAPP_RET_ERROR;
     }
 
-    if ((g_cIsPFBOn) && (1 == iNTaps))
+    if ((g_cDoPFB) && (1 == iNTaps))
     {
         /* set default number of taps */
         iNTaps = NUM_TAPS;
@@ -579,7 +579,7 @@ int main(int argc, char *argv[])
         --iNumReads;
         ++iReadBlockCount;
 
-        if (g_cIsPFBOn)
+        if (g_cDoPFB)
         {
             /* do pfb */
             (void) DoPFB(iNTaps, iNFFT);
@@ -807,7 +807,7 @@ int InitPFB(int iNTaps, int iNFFT)
     int i = 0;
     int iRet = YAPP_RET_SUCCESS;
 
-    if (g_cIsPFBOn)
+    if (g_cDoPFB)
     {
         int iFileCoeff = 0;
 
@@ -1222,7 +1222,7 @@ void PrintUsage(const char *pcProgName)
     (void) printf("                                         ");
     (void) printf("in MHz\n");
     (void) printf("    -b  --pfb                            ");
-    (void) printf("Turn PFB on\n");
+    (void) printf("Do polyphase filter bank\n");
     (void) printf("    -t  --ntaps <ntaps>                  ");
     (void) printf("Number of taps in the PFB\n");
     (void) printf("                                         ");

src/yapp_makever.c

@@ -24,7 +24,7 @@
 /* TODO: read the path as argument */
 #define FILE_VERSRC         "src/yapp_version.c"
 #define VAR_VER             "*g_pcVersion"
-#define VER_BUILD_PREFIX    "YAPP-REL-3.4.4-beta"
+#define VER_BUILD_PREFIX    "YAPP-REL-3.4.5-beta"
 #define VER_BUILD_DELIM     "-"
 
 time_t GetLatestTimestamp(void);