Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

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.Data filter

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.

...

Specifies the ending date of the time period  when DATE_MODE = Period.  The 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.

...

Specifies the geographical area for the location filter.

Note

Please note that time location filtering is based on the first date and time 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.

Info

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.

Info

A custom condition can be used any BUFR key to filter messages. E.g. if we have radiosonde data and we want to filter the messages where which have any temperature value above 300 K, the custom filter would 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:

OperatorTypes acceptedRemarks
=numeric, stringalso works for lists
!=numeric, stringalso works for lists
<=numeric
<numeric
>=numeric
>numeric
in rangenumericthe interval is specified as a list. E.g. 1/2
not in rangenumericthe 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;IDENTIFICATION