pyart.aux_io.read_mmcr#

pyart.aux_io.read_mmcr(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, include_fields=None, mode_names=None, mode_to_extract=None)[source]#

Read millimeter wavelength cloud radar (MMCR) b1 NetCDF ingest data.

Parameters:

  • filename (str) – Name of NetCDF file to read data from.

  • field_names (dict, optional) – Dictionary mapping field names in the file names to radar field names. Unlike other read functions, fields not in this dictionary or having a value of None are still included in the radar.fields dictionary, to exclude them use the exclude_fields parameter. Fields which are mapped by this dictionary will be renamed from key to value.

  • additional_metadata (dict of dicts, optional) – This parameter is not used, it is included for uniformity.

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

  • mode_names (dict) – Keys are mode dimension indices. Values are the corresponding mode abbreviations and prt. Using default values if None.

  • mode_to_extract (str or None) – Abbreviation of mode to extract. Extracting all data for all modes if None.

Returns:

radar_out (Radar or dict of Radar objects) – If mode_to_extract is None, returns a dict with keys representing operated modes and values the corresponding Radar object. If mode_to_extract is specified returning the Radar object corresponding to the that mode.