Message filter options based on the BUFR header section
MESSAGE_INDEX
Specifies the indices of the messages (message indexing starts at 1). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
EDITION
Specifies the BUFR edition of the message (represented by the edition ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
CENTRE
Specifies the centre who generated the BUFR message (represented by the bufrHeaderCentre ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored. Both the integer and string representation of the centre be used here, e.g. for ECMWF both 98 and ecmf can be used.
SUBCENTRE
Specifies the subcentre who generated the BUFR message (represented by the bufrHeaderSubCentre ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
MASTER_TABLE
Specifies the version number of the master table used for BUFR message (represented by the masterTablesVersionNumber ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
LOCAL_TABLE
Specifies the version number of the local table used for the BUFR message (represented by the localTablesVersionNumber ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
TYPE
Specifies the data category of the BUFR message (represented by the dataCategory ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
SUBTYPE
Specifies the data subcategory of the BUFR message (represented by the dataSubCategory ecCodes key in the message header). Can be a single value or a list. The default value is ANY, meaning this option is ignored.
Message filter options based on the BUFR data section
DATE_MODE
Specifies the date mode used for temporal filtering. In Window mode a date and time and a time window around it is give. In Period mode the start and end date and time of a period is specified. The default mode is Window.
Please note that time filtering is based on the first date and time values present in the data section of the BUFR message.
DATE
Specifies the date of the middle of the time window when DATE_MODE = Window. The date is given in yyyymmdd format. Can be a single value or a list.The default value is ANY, meaning this option is ignored.
TIME
Specifies the time of the middle of the time window when DATE_MODE = Window. The time is given in hh[mm[ss]] format. The leading zero from the hour part can be omitted. Can be a single value or a list.The default value is ANY, meaning this option is ignored.
WINDOW_IN_MINUTES
Specifies the half length of the time window (in minutes) when DATE_MODE = Window. The default value is 0, meaning the time window is restricted to a singe date and time.
DATE_1
Specifies the starting date of the time period when DATE_MODE = Period. The date is given in yyyymmdd format. Can be a single value or a list.The default value is ANY, meaning this option is ignored.
TIME_1
Specifies the starting date of the time period when DATE_MODE = Period. The time is given in hh[mm[ss]] format. The leading zero from the hour part can be omitted. The default value is ANY, meaning this option is ignored.
DATE_2
Specifies the ending date of the time period when DATE_MODE = Period. The date is given in yyyymmdd format. Can be a single value or a list.The default value is ANY, meaning this option is ignored.
TIME_2
Specifies the ending time of the time period when DATE_MODE = Period. The time is given in hh[mm[ss]] format. The leading zero from the hour part can be omitted. The default value is ANY, meaning this option is ignored.
AREA
Specifies the geographical area for the location filter.
Please note that location filtering is based on the first location values present in the data section of the BUFR message.
IDENTIFIER
Specifies an identifier key that can be used with the IDENTIFIER_VALUE to filter messages. The default value is WMO station.
Please note that WMO station is not a valid ecCodes BUFR key but a compound one used for convenience. It is defined as follows:
WMO station = blockNumber * 1000 + stationNumber
IDENTIFIER_VALUE
Specifies the identifier value used with IDENTIFIER.
CUSTOM_CONDITION_COUNT
Specifies the number of custom conditions used to filter messages. The default value is 0. A custom condition can be used with any BUFR key to filter messages. The example below illustrates how it works:
Let us suppose we have radiosonde data and we want to filter the messages which have any temperature value greater 300 K (the message contains multiple temperature values). The custom filter should look like this:
CUSTOM_CONDITION_COUNT: 1
CUSTOM_KEY: airTemperature
CUSTOM_RANK: ANY
CUSTOM_OPERATOR: <
CUSTOM_VALUE: 300
If we would like to find the messages where the first temperature value is above 300 K the rank should be set accordingly:
CUSTOM_CONDITION_COUNT: 1
CUSTOM_KEY: airTemperature
CUSTOM_RANK: 1
CUSTOM_OPERATOR: <
CUSTOM_VALUE: 300
CUSTOM_KEY_N
Specify the ecCodes BUFR key used in the given custom condition.
CUSTOM_RANK_N
Specify the rank of the key used in the given custom condition. The default value is ANY, meaning that the rank is not used in the condition,
CUSTOM_OPERATOR_N
Specify the operator used in the given custom condition. The possible values are as follows:
| Operator | Types accepted | Remarks |
|---|---|---|
| = | numeric, string | also works for lists |
| != | numeric, string | also works for lists |
| <= | numeric | |
| < | numeric | |
| >= | numeric | |
| > | numeric | |
| in range | numeric | the interval is specified as a list. E.g. 1/2 |
| not in range | numeric | the interval is specified as a list. E.g. 1/2 |
CUSTOM_VALUE_N
Specify the operator used in the given custom condition. The possible values are as follows:
Data extraction
k;k;jk;