pyart.io.read_nexrad_cdm¶
- pyart.io.read_nexrad_cdm(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, include_fields=None, station=None, **kwargs)[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 1. A URL of a OPeNDAP file on the UCAR THREDDS Data Server 2 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. 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.
station (str) – Four letter ICAO name of the NEXRAD station used to determine the location in the returned radar object. This parameter is only used when the location is not contained in the file, which occur in older NEXRAD files. If the location is not provided in the file and this parameter is set to None the station name will be determined from the filename.
- Returns
radar (Radar) – Radar object containing all moments and sweeps/cuts in the volume. Gates not collected are masked in the field data.
References