Differences

This shows you the differences between two versions of the page.

--- bufr.pm:bufrextract.pl_help [2016-12-02 08:53:51]
pals
+++ bufr.pm:bufrextract.pl_help [2026-03-26 18:00:48] (current)
pals
@@ Line 3: / Line 3: @@
       bufrextract.pl <bufr file(s)>
           [--ahl <ahl_regexp>]
-          [--only_ahl] | [--without_ahl]
+          [--only_ahl | --without_ahl | --gts]
+          [--filter <metadata criteria>]
           [--outfile <filename>]
-          [--reuse_ahl n]
           [--help]
           [--verbose n]
@@ Line 12: / Line 12: @@
        --ahl <ahl_regexp> Extract BUFR messages and/or AHLs with AHL
                           matching <ahl_regexp> only
+       --gts              Include full gts message envelope if present
        --only_ahl         Extract AHLs only
        --without_ahl      Extract BUFR messages only
+       --filter <metadata criteria>
+                          Extract BUFR messages matching the <metadata criteria> only
        --outfile <filename>
                           Will print to <filename> instead of STDOUT
-       --reuse_ahl n  n=0 (default) AHL is considered belonging to a BUFR message
-                          only if immediately preceding
-                      n=1 When filtering using --ahl: Reuse last AHL found if current
-                          BUFR message has no immediately preceding AHL
        --help             Display Usage and explain the options used. For even
                           more info you might prefer to consult perldoc bufrextract.pl
@@ Line 27: / Line 26: @@
     For option "--ahl" the <ahl_regexp> should be a Perl regular expression.
-    E.g. "--ahl 'ISS... ENMI'" will decode only BUFR SHIP (ISS) from
+    E.g. "--ahl 'ISS... ENMI'" will decode only SHIP BUFR (ISS) from
     CCCC=ENMI.
-    If the BUFR file(s) are known to consist solely of GTS bulletins, you
+    Use option "--gts" if you want the full GTS message envelope (if
-    might consider setting "--reuse 1" when applying "--ahl", in order to
+    present) to be included in output. There are 2 main variations on this
-    extract all (and not only the first) BUFR messages in multi message
+    envelope (SOH/ETX and ZCZC notation), for details see the Manual on the
-    bulletins. Such bulletins are very rare nowadays, however, and see also
+    GTS: Attachment II-4. Format of Meteorological Messages.
-    the "CAVEAT" for more on this option. Note that the corresponding AHL is
-    still extracted (and printed) only once.
-    No bufrtables are needed for running bufrextract.pl, since section 4 in
+    Using "--filter" makes it possible to filter based on almost any of the
-    BUFR message will not be decoded (which also speeds up execution quite a
+    metadata present in section 1 (and 0) of the BUFR messages. Some few
-    bit).
+    examples which hopefully are enough to illustrate how to write the
+    <metadata criteria>: according to Common Code Table C-13 of WMO-no. 306,
+    "dc=0 ic=0,1,2,6" should take care of synoptic and one-hour observations
+    from fixed-land stations, while "dc=1 ic=0,6" should do the same for
+    marine stations. If you want to extract both, use for <metadata
+    criteria>: "dc=0 ic=0,1,2,6 | dc=1 ic=0,6".
+    Here is the full list of metadata available for filtering (the first
+-letter abbreviation is what should be used in the <metadata
+    criteria>):
+      be = BUFR edition
+      oc = Originating centre
+      os = Originating subcentre
+      dc = Data category (table A)
+      ic = International data subcategory
+      lc = Local data subcategory
+      mt = Master table version number
+      lt = Local table version number
+      ye = Year
+      mo = Month
+      da = Day
+      ho = Hour
+      mi = Minute
+      se = Second
+    Note that no bufrtables are needed for running bufrextract.pl, since
+    section 4 in BUFR message will not be decoded (which also speeds up
+    execution quite a bit).
 </code>