pyart.io.read_uf

pyart.io.read_uf(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, include_fields=None, delay_field_loading=False, **kwargs)[source]

Read a UF File.

Parameters

  • filename (str or file-like) – Name of Universal format file to read data from.

  • field_names (dict, optional) – Dictionary mapping UF data type names to radar field names. If a data type found in the file does not appear in this dictionary or has a value of None it will not be placed in the radar.fields dictionary. A value of None, the default, will use the mapping defined in the Py-ART configuration file.

  • additional_metadata (dict of dicts, optional) – Dictionary of dictionaries to retrieve metadata from during this read. This metadata is not used during any successive file reads unless explicitly included. A value of None, the default, will not introduce any addition metadata and the file specific or default metadata as specified by the Py-ART configuration file will be used.

  • file_field_names (bool, optional) – True to force the use of the field names from the file in which case the field_names parameter is ignored. False will use to field_names parameter to rename fields.

  • exclude_fields (list or None, optional) – List of fields to exclude from the radar object. This is applied after the file_field_names and field_names parameters. Set to None to include all fields specified by include_fields.

  • include_fields (list or None, optional) – List of fields to include from the radar object. This is applied after the file_field_names and field_names parameters. Set to None to include all fields not specified by exclude_fields.

  • delay_field_loading (bool) – This option is not implemented in the function but included for compatibility.

Returns

radar (Radar) – Radar object.