def convert(self, values, unit, is_norm, axes_list):
"""Returns the values of the field transformed or converted.
Parameters
----------
self: Data
a Data object
values: ndarray
array of the field
unit: str
Unit requested by the user ("SI" by default)
is_norm: bool
Boolean indicating if the field must be normalized (False by default)
Returns
-------
values: ndarray
values of the field
"""
if unit == self.unit or unit == "SI":
if is_norm:
try:
values = values / self.normalizations.get("ref")
except:
raise NormError(
"ERROR: Reference value not specified for normalization")
elif unit == "dB":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
values = to_dB(np_abs(values), self.unit, ref_value)
elif unit == "dBA":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
for axis in axes_list:
is_match = False
if axis.name == "freqs" or axis.corr_name == "freqs":
index = axis.index
values = apply_along_axis(to_dBA, index, values, axis.values,
self.unit, ref_value)
is_match = True
elif axis.name == "frequency":
index = axis.index
values = apply_along_axis(to_dBA, index, values, axis.values,
self.unit, ref_value)
is_match = True
if not is_match:
raise UnitError(
"ERROR: dBA conversion only available for fft with frequencies"
)
elif unit in self.normalizations:
values = values / self.normalizations.get(unit)
else:
values = convert_unit(values, self.unit, unit)
return values
def get_magnitude_along(self, *args, unit="SI", is_norm=False, axis_data=[]):
"""Returns the ndarray of the magnitude of the FT, using conversions and symmetries if needed.
Parameters
----------
self: Data
a Data object
*args: list of strings
List of axes requested by the user, their units and values (optional)
unit: str
Unit requested by the user ("SI" by default)
is_norm: bool
Boolean indicating if the field must be normalized (False by default)
axis_data: list
list of ndarray corresponding to user-input data
Returns
-------
list of 1Darray of axes values, ndarray of magnitude values
"""
return_dict = self.get_along(args, axis_data=axis_data)
values = return_dict[self.symbol]
# Compute magnitude
values = np_abs(values)
# Convert into right unit (apart because of dBA conversion)
if unit == self.unit or unit == "SI":
if is_norm:
try:
values = values / self.normalizations.get("ref")
except:
raise NormError(
"ERROR: Reference value not specified for normalization")
elif unit == "dB":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
values = to_dB(values, self.unit, ref_value)
elif unit == "dBA":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
if "freqs" in return_dict.keys():
values = to_dBA(values, return_dict["freqs"], self.unit, ref_value)
else:
raise UnitError(
"ERROR: dBA conversion only available for fft with frequencies"
)
elif unit in self.normalizations:
values = values / self.normalizations.get(unit)
else:
values = convert(values, self.unit, unit)
return_dict[self.symbol] = values
return return_dict
def get_magnitude_along(
self, *args, unit="SI", is_norm=False, axis_data=[], is_squeeze=True
):
"""Returns the ndarray of the magnitude of the FT, using conversions and symmetries if needed.
Parameters
----------
self: Data
a Data object
*args: list of strings
List of axes requested by the user, their units and values (optional)
unit: str
Unit requested by the user ("SI" by default)
is_norm: bool
Boolean indicating if the field must be normalized (False by default)
axis_data: list
list of ndarray corresponding to user-input data
Returns
-------
list of 1Darray of axes values, ndarray of magnitude values
"""
if len(args) == 1 and type(args[0]) == tuple:
args = args[0] # if called from another script with *args
return_dict = self.get_along(
args, axis_data=axis_data, is_squeeze=is_squeeze, is_magnitude=True
)
values = return_dict[self.symbol]
# 1/nth octave band
for axis in return_dict["axes_list"]:
if axis.name == "freqs" or axis.corr_name == "freqs":
index = axis.index
if axis.noct is not None:
(values, foct) = apply_along_axis(
to_noct, index, values, return_dict["freqs"], noct=axis.noct
)
return_dict[axis.name] = foct
# Convert into right unit (apart because of dBA conversion)
if unit == self.unit or unit == "SI":
if is_norm:
try:
values = values / self.normalizations.get("ref")
except:
raise NormError(
"ERROR: Reference value not specified for normalization"
)
elif unit == "dB":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
values = to_dB(values, self.unit, ref_value)
elif unit == "dBA":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
if "freqs" in return_dict.keys():
for axis in return_dict["axes_list"]:
if axis.name == "freqs" or axis.corr_name == "freqs":
index = axis.index
values = apply_along_axis(
to_dBA, index, values, return_dict["freqs"], self.unit, ref_value
)
else:
raise UnitError(
"ERROR: dBA conversion only available for fft with frequencies"
)
elif unit in self.normalizations:
values = values / self.normalizations.get(unit)
else:
values = convert(values, self.unit, unit)
return_dict[self.symbol] = values
return return_dict
def convert(self, values, unit, is_norm, is_squeeze, is_magnitude, axes_list):
"""Returns the values of the field transformed or converted.
Parameters
----------
self: Data
a Data object
values: ndarray
array of the field
unit: str
Unit requested by the user ("SI" by default)
is_norm: bool
Boolean indicating if the field must be normalized (False by default)
Returns
-------
values: ndarray
values of the field
"""
# Take magnitude before summing
if is_magnitude:
values = np_abs(values)
# Apply sums, means, etc
for axis_requested in axes_list:
# sum over sum axes
if axis_requested.extension == "sum":
values = np_sum(values, axis=axis_requested.index, keepdims=True)
# root sum square over rss axes
elif axis_requested.extension == "rss":
values = sqrt(
np_sum(values**2, axis=axis_requested.index, keepdims=True))
# mean value over mean axes
elif axis_requested.extension == "mean":
values = np_mean(values, axis=axis_requested.index, keepdims=True)
# RMS over rms axes
elif axis_requested.extension == "rms":
values = sqrt(
np_mean(values**2, axis=axis_requested.index, keepdims=True))
# integration over integration axes
elif axis_requested.extension == "integrate":
values = trapz(
values, x=axis_requested.values,
axis=axis_requested.index) / (np_max(axis_requested.values) -
np_min(axis_requested.values))
if is_squeeze:
values = squeeze(values)
if unit == self.unit or unit == "SI":
if is_norm:
try:
values = values / self.normalizations.get("ref")
except:
raise NormError(
"ERROR: Reference value not specified for normalization")
elif unit == "dB":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
values = to_dB(np_abs(values), self.unit, ref_value)
elif unit == "dBA":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
for axis in axes_list:
is_match = False
if axis.name == "freqs" or axis.corr_name == "freqs":
index = axis.index
values = apply_along_axis(to_dBA, index, values, axis.values,
self.unit, ref_value)
is_match = True
elif axis.name == "frequency":
index = axis.index
values = apply_along_axis(to_dBA, index, values, axis.values,
self.unit, ref_value)
is_match = True
if not is_match:
raise UnitError(
"ERROR: dBA conversion only available for fft with frequencies"
)
elif unit in self.normalizations:
values = values / self.normalizations.get(unit)
else:
values = convert_unit(values, self.unit, unit)
return values
def get_harmonics(self,
N_harm,
*args,
unit="SI",
is_norm=False,
is_flat=False):
"""Returns the complex Fourier Transform of the field, using conversions and symmetries if needed.
Parameters
----------
self: Data
a Data object
N_harm: int
Number of largest harmonics to be extracted
args: list
Axes names, ranges and units
unit: str
Unit demanded by the user ("SI" by default)
is_norm: bool
Boolean indicating if the field must be normalized (False by default)
is_flat: bool
Boolean if the output data remains flattened (for 2D cases)
Returns
-------
list of 1Darray of axes values, ndarray of magnitude of FT
"""
# Read the axes input in args
if len(args) == 1 and type(args[0]) == tuple:
args = args[0] # if called from another script with *args
axes_list = read_input_strings(args, [])
# Extract the requested axes (symmetries + unit)
for axis_requested in axes_list:
if axis_requested[3] == "values":
# Get original values of the axis
axis_requested.append(
self.get_FT_axis(axis_requested[0] + axis_requested[1]))
# Interpolate axis with input data
if str(axis_requested[4]) == "whole":
axis_requested[4] = axis_requested[5]
axis_requested[5] = "whole"
else:
axis_requested[4] = get_common_base(axis_requested[5],
axis_requested[4])
# Change fft name for the slices of the field
if axis_requested[0] == "freqs":
axis_requested[0] = "time"
elif axis_requested[0] == "wavenumber":
axis_requested[0] = "angle"
# Check if the requested axis is defined in the Data object
for axis_requested in axes_list:
axis_name = axis_requested[0]
is_match = False
for index, axis in enumerate(self.axes):
if axis.name == axis_name:
is_match = True
if not is_match:
axes_list.remove(axis_requested)
# Rebuild symmetries of field if axis is extracted
values = self.values
for index, axis in enumerate(self.axes):
for axis_requested in axes_list:
if axis.name in self.symmetries.keys(
) and axis.name == axis_requested[0]:
values = rebuild_symmetries(values, index,
self.symmetries.get(axis.name))
# Extract the slices of the field (single values)
for index, axis in enumerate(self.axes):
is_match = False
for axis_requested in axes_list:
if axis.name == axis_requested[0]:
is_match = True
if axis_requested[3] == "indices" and axis_requested[
2] == "single":
values = take(values, axis_requested[4], axis=index)
if not is_match: # Axis was not specified -> take slice at the first value
values = take(values, [0], axis=index)
# Interpolate over axis values (single values)
for index, axis in enumerate(self.axes):
for axis_requested in axes_list:
if (axis.name == axis_requested[0]
and axis_requested[3] == "values"
and axis_requested[2] == "single"):
values = apply_along_axis(
get_interpolation,
index,
values,
axis_requested[5],
axis_requested[4],
)
# Perform Fourier Transform
values = np_abs(comp_fft(values))
# Extract slices again (intervals)
for index, axis in enumerate(self.axes):
for axis_requested in axes_list:
if axis.name == axis_requested[0]:
if axis_requested[2] == "indices" and axis_requested[
2] == "interval":
values = take(values, axis_requested[4], axis=index)
# Interpolate over axis values again (intervals)
for index, axis in enumerate(self.axes):
for axis_requested in axes_list:
if axis.name == axis_requested[0]:
if axis_requested[3] == "values" and axis_requested[
2] == "interval":
values = apply_along_axis(
get_interpolation,
index,
values,
axis_requested[5],
axis_requested[4],
)
# Eliminate dimensions=1
values = squeeze(values)
# Test if data is 1D or 2D
if len(values.shape) > 2:
raise AxisError("ERROR: only 1D or 2D implemented")
else:
# Convert into right unit
if unit == self.unit or unit == "SI":
if is_norm:
try:
values = values / self.normalizations.get("ref")
except:
raise NormError(
"ERROR: Reference value not specified for normalization"
)
elif unit == "dB":
ref_value = 1.0
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
values = to_dB(values, self.unit, ref_value)
elif unit == "dBA":
ref_value = 1.0
is_match = False
if "ref" in self.normalizations.keys():
ref_value *= self.normalizations.get("ref")
for axis_requested in axes_list:
if axis_requested[0] == "time":
is_match = True
values = to_dBA(values, axis_requested[4], self.unit,
ref_value)
if not is_match:
raise UnitError(
"ERROR: dBA conversion only available for fft with frequencies"
)
elif unit in self.normalizations:
values = values / self.normalizations.get(unit)
else:
values = convert(values, self.unit, unit)
# 1D case
if len(values.shape) == 1:
for axis_requested in axes_list:
if axis_requested[2] == "interval":
axis_values = axis_requested[4]
indices = argsort(negative(values))
indices = indices[:N_harm]
axis_values = axis_values[indices]
values = values[indices]
return [axis_values, values]
# 2D case
else:
for axis_requested in axes_list:
if axis_requested[0] == "angle":
r = axis_requested[4]
elif axis_requested[0] == "time":
f = axis_requested[4]
# Flatten the data
values_flat = values.flatten()
R, F = meshgrid(r, f)
f = F.flatten()
r = R.flatten()
# Get the N_harm largest peaks
indices = argsort(negative(values_flat))
indices = indices[:N_harm]
values = values_flat[indices]
f = f[indices]
r = r[indices]
if len(values.shape) == 2 and not is_flat:
f.reshape((N_harm, N_harm))
r.reshape((N_harm, N_harm))
values.reshape((N_harm, N_harm))
return [f, r, values]