pyart.aux_io.read_odim_grid_h5#

pyart.aux_io.read_odim_grid_h5(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, include_fields=None, offset=0.0, gain=1.0, nodata=nan, undetect=nan, use_file_conversion=True, time_ref='start', **kwargs)[source]#

Read a ODIM_H5 grid file.

Parameters:

  • filename (str) – Name of the ODIM_H5 file to read.

  • field_names (dict, optional) – Dictionary mapping ODIM_H5 field 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 introduct 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 use the MDV data type names for the field names. If this case the field_names parameter is ignored. The field dictionary will likely only have a ‘data’ key, unless the fields are defined in additional_metadata.

  • 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.

  • offset, gain, nodata, undetect (float) – offset, gain and nodata values to use to convert from binary to float. Used when the what attribute is not available or when the user forces them

  • use_file_conversion (bool) – If True uses the parameters specified in the what attribute to convert the data into physical units. Otherwise uses the parameters passed by the user

  • time_ref (str) – Time reference in the /what/time attribute. Can be either ‘start’, ‘mid’ or ‘end’. If ‘start’ the attribute is expected to be the starttime of the scan, if ‘mid’, the middle time, if ‘end’ the endtime.

Returns:

grid (Grid) – Grid object containing data from ODIM_H5 file.