pyart.aux_io.read_gamic#

pyart.aux_io.read_gamic(filename, field_names=None, additional_metadata=None, file_field_names=False, exclude_fields=None, include_fields=None, valid_range_from_file=True, units_from_file=True, pulse_width=None, **kwargs)[source]#

Read a GAMIC hdf5 file.

Parameters:

filename (str) – Name of GAMIC HDF5 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.
valid_range_from_file (bool, optional) – True to extract valid range (valid_min and valid_max) for all field from the file when they are present. False will not extract these parameters.
units_from_file (bool, optional) – True to extract the units for all fields from the file when available. False will not extract units using the default units for the fields.
pulse_width (list or None,) – Mandatory for gamic radar processors which have pulsewidth enums. pulse_width should contain the pulsewidth’ in us.

Returns:

radar (Radar) – Radar object.