bufr.pm:bufrread_help

LDAP: couldn't connect to LDAP server

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
bufr.pm:bufrread_help [2010-09-21 08:05:47]
pals 		bufr.pm:bufrread_help [2022-05-31 09:29:31] (current)
Line 1: Line 1:
 <code> <code>
 Usage: Usage:
-      bufrdump.pl <bufr file(s)>+      bufrread.pl <bufr file(s)> 
 +          [--ahl <ahl_regexp>] 
 +          [--all_operators] 
 +          [--bitmap] 
 +          [--codetables] 
 +          [--data_only]
           [--filter <filter file>]           [--filter <filter file>]
-          [--param <parameter file> [--csv]] +          [--help] 
-          [--sort | --sort_on <parameter>[-]] +          [--nodata] 
-          [--transform <transformation file>] +          [--noqc] 
-          [--lon1 x1] +          [--on_error_stop] 
-          [--lat1 y1] +          [--optional_section] 
-          [--lon2 x2] +          [--outfile <filename>] 
-          [--lat2 x2]+          [--param <descriptor file>] 
 +          [--strict_checking n] 
 +          [--tableformat <BUFRDC|ECCODES>]
           [--tablepath <path to BUFR tables>]           [--tablepath <path to BUFR tables>]
-          [--help]+          [--verbose n] 
 +          [--width n]
  
 Options: Options:
-      --filter <filter file> +       --ahl <ahl_regexp> 
-                      Decode observations meeting criteria in <filter file> only +                       Decode BUFR messages with AHL matching <ahl_regexp> only 
-      --param <parameter file> [--csv] +       --all_operators Show all operator descriptors when printing section 4 
-                      Print parameters in <parameter file> only, in same order +       --bitmap        Display bit-mapped values on same line 
-                      as they occur in <parameter file>. If --csv, the parameters +       --codetables    Use code and flag tables to resolve values when unit 
-                      vill be printed using the CSV (comma separated values) format +                       is [CODE TABLE] or [FLAG TABLE] 
-      --sort          Sort the decoded observations on station identification; +       --data_only     Print section 4 (data section) only 
-                      first stations with wmonr, then stations with call sign, +       --filter <filter file> 
-                      then stations with buoy_id (others left out) +                       Decode observations meeting criteria in <filter file> only 
-      --sort_on <parameter>[-] Sort the decoded observations on increasing +       --help          Display Usage and explain the options used. For even 
-                      values of <parameter>, or decreasing values if a '-' +                       more info you might prefer to consult perldoc bufrread.pl 
-                      follows the parameter name. Observations not containing +       --nodata        Do not print (nor decode) section 4 (data section) 
-                      the parameter at all will be printed lastly. E.g. +       --noqc          Do not decode quality control 
-                      --sort_on TA- will sort on decreasing temperatures +                       (or any descriptors following 222000) 
-      --transform <transformation file> +       --on_error_stop Stop processing as soon as an error occurs during decoding 
-                      Do the transformations of parameter values listed in +       --outfile <filename> 
-                      <transformation file> +                       Will print to <filename> instead of STDOUT 
-      --lon1 x1       Decode observations with longitude >= x1 only +       --optional_section 
-      --lat1 y1       Decode observations with latitude >= y1 only +                       Display a hex dump of optional section if present 
-      --lon2 x2       Decode observations with longitude <= x2 only +       --param <descriptor file> 
-      --lat2 y2       Decode observations with latitude <= y2 only +                       Display parameters with descriptors in <descriptor file> only 
-                      x1,y1,x2,y2 should be decimal degrees +       --strict_checking n n=0 (default) Disable strict checking of BUFR format 
-      --tablepath <path to BUFR tables> +                           n=1 Issue warning if (recoverable) error in 
-                      Set path to BUFR tables (overrides ENV{BUFR_TABLES}) +                               BUFR format 
-      --help          Print this Usage+                           n=2 Croak if (recoverable) error in BUFR format. 
 +                               Nothing more in this message/subset will be decoded. 
 +       --tableformat   Currently supported are BUFRDC and ECCODES (default is BUFRDC) 
 +       --tablepath <path to BUFR tables> 
 +                       Set path to BUFR tables (overrides ENV{BUFR_TABLES}) 
 +       --verbose n     Set verbose level to n, 0<=n<=6 (default 0). n=1 will 
 +                       show the tables loaded. 
 +       --width n       Set width of field used for data values to n characters 
 +                       (default is 15)
  
-    Options may be abbreviated, e.g. --h or -h for --help.+    Options may be abbreviated, e.g. "--h" or "-h" for "--help".
  
     To avoid having to use the "--tablepath" option, you are adviced to set     To avoid having to use the "--tablepath" option, you are adviced to set
-    the invironment variable BUFR_TABLES to the directory where your BUFR +    the environment variable BUFR_TABLES to the directory where your BUFR 
-    tables are located (unless the default path provided by bufrdump.pl +    tables are located (unless the default path provided by bufrread.pl 
-    works for you).+    works for you). For tableformat ECCODES, se 
 +    <http://search.cpan.org/dist/Geo-BUFR/lib/Geo/BUFR.pm#BUFR-TABLE-FILES> 
 +    for more info on how to set "--tablepath" (or BUFR_TABLES).
  
-    The lines in <parameter file> should be name of the parameters you want +    For option "--ahl" the <ahl_regexp> should be a Perl regular expression. 
-    to be printed. For example, if you want only station identification and +    E.g. "--ahl "ISS... ENMI"" will decode only BUFR SHIP (ISS) from 
-    temperature to be printed for a BUFR SYNOP file, the <parameter file> +    CCCC=ENMI. This is the only case where a little knowledge of Perl might 
-    should look like this:+    possibly be required when using the utility programs included in 
 +    Geo::BUFR.
  
-      wmonr +    For option "--param" each line in <descriptor file> should start with a 
-      call_sign +    BUFR descriptor (6 digits). Rest of line will be ignored. bufrread.pl 
-      TA+    will display values for these descriptors only.
  
-    If you want "parameter=value" to be printed also when value is missing +    Using "--filter" will decode only those observations that meet one of 
-    in BUFR message, precede the parameter name with an exclamation mark +    the criteria in <filter file> (and all of those criteria marked D!). 
-    (e.g. '!TA'). Missing values will then be displayed as -32767.+    Comments (starting with #) are ignored. An example of a filter file is
  
-    If --csv is used in conjunction with --param, all values will be printed +      D: 001001 
-    using the CSV format, with first line listing the parameters, and with +      1 
-    missing fields printed as -32767 if the parameter is marked with '!' in +      D: 001001 001002 
-    parameter file. With the parameter file above, the listing may for +      3 895 
-    example start like +      6 252 
- +      D: 001011 
-      wmonr,call_sign,TA +      LF5U       # Ekofisk 
-      01001,,-1.5 +      D!: 004004 
-      ,LF5U,9.0 +      6 
- +      7
-    Using --filter will decode only those observations that meet at least +
-    one of the BUFR descriptor criteria and all of the parameter criteria in +
-    <filter file>, where the BUFR descriptor criteria should come first in +
-    filter file followed by a blank line, then comes the parameter criteria +
-    which should match <param> or <param> <operator> <value> where operator +
-    is one of =, !=, <, <=, > and >=. An example filter file is +
- +
-      D: 001001 I2.2 +
-      01 +
-      D: 001001 I2.2 001002 I3.3 +
-      03 895 +
-      06 252 +
-      D: 001011 A9 +
-      LF5U +
- +
-      type = Manned +
-      NN != 8 +
-      TA >= 5 +
-      TA < 9.5 +
-      RR_24+
  
     which decodes all observations with block number 01, two other specific     which decodes all observations with block number 01, two other specific
-    wmo stations and one specific ship, being manned stations and having +    WMO stations and one specific ship, all of which having hour (004004) 
-    cloud cover different from 8 (but NN must be part of the message) and +    equal to 6 or 7. If there is no value line after a descriptor line, it 
-    temperature between 5 and 9.5 degrees Celsius and containing +    is enough that the observation contains the descriptor(s), whatever the 
-    precipitation for last 24 hours. Comment lines starting with # will be +    values are. So to extract all ship messages from a BUFR file, the filter 
-    ignored. +    file should contain this single line only:
- +
-    Another example: the simple filter file (starting with a blank line!) +
- +
-      wmonr +
- +
-    will print only those observations containing a wmonr (skipping ships). +
- +
-    The --transform option is provided mainly to be able to use other units +
-    than what is default in bufrdump.pl. The transformation file should list +
-    the transformations wanted, one per line as +
- +
-      <parameter> = <perl expression involving $x> +
- +
-    where $x is original value of the parameter. +
- +
-    For example, the following transformation file will display wind speed +
-    FF and wind gust FG in knots instead of m/s, rounded to one decimal, and +
-    cloud cover NN in % (instead of the default which is using WMO code +
-    table 2700, roughly counting octas):+
  
-      FF = sprintf("%.1f", $x*1.9438) +      D: 001011
-      FG = sprintf("%.1f", $x*1.9438) +
-      NN = int($x*12.5 + .5)+
  
-    If --transform is combined with --filter, the filter criteria should +    If an error occurs during decoding (typically because the required BUFR 
-    refer to the transformed values. E.g. if the above NN transform to % is +    table is missing or message is corrupt), the BUFR message is skipped 
-    to be applied for sky not all covered by clouds, you should use NN != +    with an error message printed to STDERR, and processing then continues 
-    100 instead of NN != 8 in filter file.+    with the next BUFR message. You can change this default behaviour, 
 +    however, by setting "--on_error_stop".
  
 </code> </code>
  • bufr.pm/bufrread_help.1285056347.txt.gz
  • Last modified: 2022-05-31 09:23:11
  • (external edit)