pyart.xradar.Xradar#

class pyart.xradar.Xradar(xradar, default_sweep='sweep_0', scan_type=None)[source]#

Wraps an xradar DataTree into a Py-ART Radar-like object.

Optional Radar attributes (None when absent in the source file): antenna_transition, rays_are_indexed, ray_angle_res, target_scan_rate, scan_rate, altitude_agl, rotation, tilt, roll, drift, heading, pitch, georefs_applied and radar_calibration are populated from the DataTree when the corresponding variable/group is present, and are None otherwise (never fabricated) – matching how Radar treats these attributes for files that lack them.

add_field(field_name, dic[, replace_existing])

Add a field to the object.

add_field_like(existing_field_name, ...[, ...])

Add a field to the object with metadata from a existing field.

add_filter(gatefilter[, replace_existing, ...])

Updates the radar object with an applied gatefilter provided by the user that masks values in fields within the radar object.

check_field_exists(field_name)

Check that a field exists in the fields dictionary.

extract_sweeps(sweeps)

Create a new radar that contains only the data from select sweeps.

find_instrument_parameters()

get_azimuth(sweep[, copy])

Return an array of azimuth angles for a given sweep.

get_elevation(sweep[, copy])

Return an array of elevation angles for a given sweep.

get_end(sweep)

Return the ending ray for a given sweep.

get_field(sweep, field_name[, copy])

Return the field data for a given sweep.

get_gate_area(sweep)

Return the area of each gate in a sweep.

get_gate_lat_lon_alt(sweep[, ...])

Return the longitude, latitude and altitude gate locations.

get_gate_x_y_z(sweep[, edges, ...])

Return the x, y and z gate locations in meters for a given sweep.

get_nyquist_vel(sweep[, check_uniform])

Return the Nyquist velocity in meters per second for a given sweep.

get_projparams()

get_slice(sweep)

Return a slice for selecting rays for a given sweep.

get_start(sweep)

Return the starting ray index for a given sweep.

get_start_end(sweep)

Return the starting and ending ray for a given sweep.

info([level, out])

Print information on radar.

init_gate_alt()

init_gate_altitude()

init_gate_longitude_latitude()

Initialize or reset the gate_longitude and gate_latitude attributes.

init_gate_x_y_z()

Initialize or reset the gate_{x, y, z} attributes.

init_rays_per_sweep()

Initialize or reset the rays_per_sweep attribute.

iter_azimuth()

Return an iterator which returns sweep azimuth data.

iter_elevation()

Return an iterator which returns sweep elevation data.

iter_end()

Return an iterator over the sweep end indices.

iter_field(field_name)

Return an iterator which returns sweep field data.

iter_slice()

Return an iterator which returns sweep slice objects.

iter_start()

Return an iterator over the sweep start indices.

iter_start_end()

Return an iterator over the sweep start and end indices.