pyart.io.nexrad_cdm.read_nexrad_cdm

pyart.io.nexrad_cdm.read_nexrad_cdm(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None)[source]

Read a Common Data Model (CDM) NEXRAD Level 2 file.

Parameters :

filename : str

File name or URL of a Common Data Model (CDM) NEXRAD Level 2 file. File of in this format can be created using the NetCDF Java Library tools [R5]. A URL of a OPeNDAP file on the UCAR THREDDS Data Server [R6] is also accepted the netCDF4 library has been compiled with OPeNDAP support.

field_names : dict, optional

Dictionary mapping NEXRAD moments 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 metadata 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 metadata configuration file will be used.

file_field_names : bool, optional

True to use the NEXRAD field 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.

Returns :

radar : Radar

Radar object containing all moments and sweeps/cuts in the volume. Gates not collected are masked in the field data.

References

[R5](1, 2) http://www.unidata.ucar.edu/software/netcdf-java/documentation.htm
[R6](1, 2) http://thredds.ucar.edu/thredds/catalog.html

Previous topic

pyart.io.nexrad_archive.read_nexrad_archive

Next topic

pyart.io.nexrad_cdm._scan_info

This Page