pyart.io.read_cfradial#

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

Read a Cfradial 1.4 netCDF file.

Parameters:

  • filename (str) – Name of CF/Radial 1.4 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.

  • delay_field_loading (bool) – True to delay loading of field data from the file until the ‘data’ key in a particular field dictionary is accessed. In this case the field attribute of the returned Radar object will contain LazyLoadDict objects not dict objects. Delayed field loading will not provide any speedup in file where the number of gates vary between rays (ngates_vary=True) and is not recommended.

  • use_arm_scan_name (bool) – Whether or not to get the sweep_mode information from the ARM scan_name attribute. Default is False and will use the sweep_mode information as defined in the cfradial standards.

Returns:

radar (Radar) – Radar object.

Notes

This function has not been tested on “stream” Cfradial files.

On this page

This Page