Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: optional rectangular window dims for velocity texture analysis and bug fixes to the load_kazr method #1446

Merged
merged 9 commits into from
Aug 17, 2023
2 changes: 1 addition & 1 deletion pyart/aux_io/arm_vpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ def read_kazr(

v_nq = float(ncobj.nyquist_velocity.split()[0])
nyquist_velocity = filemetadata("nyquist_velocity")
nyquist_velocity["data"] = (v_nq * np.ones(ncvars["time"].size, dtype=np.float32),)
nyquist_velocity["data"] = v_nq * np.ones(ncvars["time"].size, dtype=np.float32)
samples = int(ncobj.num_spectral_averages)
n_samples = filemetadata("n_samples")
n_samples["data"] = samples * np.ones(ncvars["time"].size, dtype=np.int32)
Expand Down
18 changes: 11 additions & 7 deletions pyart/retrieve/simple_moment_calculations.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ def compute_cdr(radar, rhohv_field=None, zdr_field=None, cdr_field=None):


def calculate_velocity_texture(
radar, vel_field=None, wind_size=4, nyq=None, check_nyq_uniform=True
radar, vel_field=None, wind_size=3, nyq=None, check_nyq_uniform=True
):
"""
Derive the texture of the velocity field.
Expand All @@ -252,9 +252,11 @@ def calculate_velocity_texture(
vel_field : str, optional
Name of the velocity field. A value of None will force Py-ART to
automatically determine the name of the velocity field.
wind_size : int, optional
The size of the window to calculate texture from. The window is
defined to be a square of size wind_size by wind_size.
wind_size : int or 2-element tuple, optional
The size of the window to calculate texture from.
If an integer, the window is defined to be a square of size wind_size
by wind_size. If tuple, defines the m x n dimensions of the filter
window.
nyq : float, optional
The nyquist velocity of the radar. A value of None will force Py-ART
to try and determine this automatically.
Expand All @@ -274,6 +276,10 @@ def calculate_velocity_texture(
if vel_field is None:
vel_field = get_field_name("velocity")

# Set wind_size as a tuple if input is int
if isinstance(wind_size, int):
wind_size = (wind_size, wind_size)

# Allocate memory for texture field
vel_texture = np.zeros(radar.fields[vel_field]["data"].shape)

Expand All @@ -300,7 +306,5 @@ def calculate_velocity_texture(
vel_texture_field["standard_name"] = (
"texture_of_radial_velocity" + "_of_scatters_away_from_instrument"
)
vel_texture_field["data"] = ndimage.median_filter(
vel_texture, size=(wind_size, wind_size)
)
vel_texture_field["data"] = ndimage.median_filter(vel_texture, size=wind_size)
return vel_texture_field
16 changes: 11 additions & 5 deletions pyart/util/sigmath.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ def angular_texture_2d(image, N, interval):
image : 2D array of floats
The array containing the velocities in which to calculate
texture from.
N : int
This is the window size for calculating texture. The texture will be
calculated from an N by N window centered around the gate.
N : int or 2-element tuple
If int, this is the window size for calculating texture. The
texture will be calculated from an N by N window centered
around the gate. If tuple N defines the m x n dimensions of
the window centered around the gate.
interval : float
The absolute value of the maximum velocity. In conversion to
radial coordinates, pi will be defined to be interval
Expand All @@ -33,6 +35,10 @@ def angular_texture_2d(image, N, interval):
Texture of the radial velocity field.

"""
# Set N as a tuple if input is int
if isinstance(N, int):
N = (N, N)

# transform distribution from original interval to [-pi, pi]
interval_max = interval
interval_min = -interval
Expand All @@ -45,10 +51,10 @@ def angular_texture_2d(image, N, interval):
y = np.sin(im)

# Calculate convolution
kernel = np.ones((N, N))
kernel = np.ones(N)
xs = signal.convolve2d(x, kernel, mode="same", boundary="symm")
ys = signal.convolve2d(y, kernel, mode="same", boundary="symm")
ns = N**2
ns = np.prod(N)

# Calculate norm over specified window
xmean = xs / ns
Expand Down
Loading