filename : str
Name of Sigmet (IRIS) product file to read or file-like object
pointing to the beginning of such a file.
field_names : dict, optional
Dictionary mapping Sigmet 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
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 Sigmet 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.
time_ordered : ‘full’, ‘none’ or ‘roll’.
Parameter controlling the time ordering of the data. The default,
‘none’ keep the data ordered in the same manner as it appears in
the Sigmet file. ‘roll’ will attempt to time order the data within
each sweep by rolling the earliest collected ray to be the beginning.
Sequential ordering of the rays is maintained but strict time
increasing order is not guaranteed. ‘full’ will place data within
each sweep in a strictly time increasing order, but the rays will
likely become non-sequential. The ‘full’ option is not recommended
unless strict time increasing order is required.
debug : bool, optional
|