pyart.io.read_rsl

pyart.io.read_rsl(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, radar_format=None, callid=None)[source]

Read a file supported by RSL

Parameters :

filename : str or RSL_radar

Name of file whose format is supported by RSL.

field_names : dict, optional

Dictionary mapping RSL data type 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 RSL 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.

radar_format : str or None

Format of the radar file. Must be ‘wsr88d’ or None.

callid : str or None

Four letter NEXRAD radar Call ID, only used when radar_format is ‘wsr88d’.

Returns :

radar : Radar

Radar object.

Previous topic

pyart.io.read

Next topic

pyart.io.read_mdv

This Page