Metview's documentation is now on readthedocs!

Please go to https://metview.readthedocs.io/en/latest/

This page summarises the options of the BUFR filter editor.

These conditions are combined together by the logical AND operator. So a message/subset is only filtered and data extraction only happens when all the conditions match.

Message filter options based on the BUFR header section

MESSAGE_INDEX

Specifies the message indices (message indexing starts at 1). Can be a single value or a list. The default value is ANY, which means this option is ignored.

EDITION

Specifies the BUFR edition of the message  (represented by the edition BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

CENTRE

Specifies the generating centre of the BUFR message (represented by the bufrHeaderCentre BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

Both the integer and string representation of the centre be used here. E.g. for centre ECMWF both 98 and ecmf are valid options.

SUBCENTRE

Specifies the generating subcentre of the BUFR message (represented by the bufrHeaderSubCentre BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

MASTER_TABLE

Specifies the version number of the master table used for BUFR message (represented by the masterTablesVersionNumber BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

LOCAL_TABLE

Specifies the version number of the local table used for the BUFR message (represented by the localTablesVersionNumber BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

TYPE

Specifies the data category of the BUFR message (represented by the dataCategory BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

SUBTYPE

Specifies the data subcategory of the BUFR message (represented by the dataSubCategory BUFR key in the message header). Can be a single value or a list. The default value is ANY, which means this option is ignored.

Message/subset 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/subset.

DATE

Specifies the date of the middle point 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, which means this option is ignored.

TIME

Specifies the time of the middle point 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, which means 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, which means 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, which means his 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, which means 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, which means 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, which means 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/subset.

IDENTIFIER

Specifies an identifier BUFR key that can be used with IDENTIFIER_VALUE to filter messages/subsets. The identifier can be chosen from a predefined list. The default value is WMO station.

Please note that WMO station is not a valid BUFR key but a compound one defined for your convenience. It is defined as follows:

WMO station = blockNumber * 1000 + stationNumber

IDENTIFIER_VALUE

Specifies the identifier value used with IDENTIFIER. The default value is ANY, which means this option is ignored.

CUSTOM_CONDITION_COUNT

Specifies the number of custom conditions for message/subset filtering. The default value is 0, which means no custom condition is defined. In custom condition any BUFR key can be used. :

CUSTOM_KEY_N

Specify the BUFR key used in the given custom condition.

CUSTOM_RANK_N

Specify the rank of the BUFR key used in the given custom condition. The default value is ANY, which means the rank is ignored 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 range is specified as a list. E.g. 1/2
not in rangenumericthe range is specified as a list. E.g. 1/2

CUSTOM_VALUE_N

Specifies the value used in the given custom condition. The default value is ANY, which must be changed to form a valid custom condition.


Data extraction

EXTRACT_VALUES

Enables data extraction when it is set to On. The default value is Off.

PARAMETER_COUNT

Specifies the number of parameters to be extracted. The default value is 1.  Data extraction can be used with any BUFR key. For each key an extraction condition can also be set.

PARAMETER_N

Specifies the BUFR key to be extracted. The default value is ANY that must be changed to make the data extraction work.

PARAMETER_RANK_N

Specifies the rank of the BUFR key used for the given parameter. The default value is ANY, which means that the rank is ignored in the condition,

PARAMETER_OPERATOR_N

Specifies the operator used in the given parameter condition.

PARAMETER_VALUE_N

Specifies the value used in the given parameter condition. The default value is ANY, which means no value condition is set on the parameter.

COORDINATE_CONDITION_COUNT

Specifies the number of coordinate conditions set for the data extraction. The default value is 0 (no coordinate conditions).

COORDINATE_N

Specifies the BUFR key used for the given coordinate condition.

COORDINATE_RANK_N

Specifies the rank of the BUFR key used for the given coordinate condition. Can be a single value or a list. The default value is ANY, which means that the rank is ignored in the condition.

COORDINATE_OPERATOR_N

Specifies the operator used in the given coordinate condition.

COORDINATE_VALUE_N

Specifies the value used in the given coordinate condition. The default value is ANY,  which means no condition is set on the coordinate.

EXTRACT_MODE

Specifies how many resulting table rows (aligned parameter values) can be extracted from a given message/subset. When it is set to First only the first parameter values matching all the conditions are collected. The other possible value is All, which means that all the values matching the conditions are extracted. The default value is First.

EXTRACT_COORDINATE

Specifies if the coordinate values (if coordinate conditions are defined) should be presented in the resulting table data. The possible values are On and Off. The default value is On.

EXTRACT_DATE

Specifies if the date and time values (if available) should be presented in the resulting table data. The possible values are On and Off. The default value is On.

MISSING_DATA

Specifies if missing data should be included in the data extraction results. The possible values are Ignore and Include. The default value is Ignore.