IsolateOrders

class ansys.sound.core.spectrogram_processing.IsolateOrders(signal=None, rpm_profile=None, orders=None, fft_size=1024, window_type='HANN', window_overlap=0.5, width_selection=10)

Isolates the orders of a signal.

This class isolates the order of a signal that has an associated RPM profile.

Class instantiation takes the following parameters.

Parameters:

signalFieldsContainer | Field, default: None

One or more input signals on which to isolate orders.

rpm_profileField, default: None

RPM signal associated with the time-domain signals. It is assumed that the signal’s unit is rpm. If this is not the case, inaccurate behavior might occur during the conversion from RPM to frequency.

orderslist, default: None

List of the order numbers to isolate. The list must contain at least one value.

fft_sizeint, default: 1024

Size of the FFT used to compute the STFT.

window_typestr, default: ‘HANN’

Window type used for the FFT computation. Options are 'TRIANGULAR', 'BLACKMAN', 'BLACKMANHARRIS', 'HAMMING', 'HANN', 'GAUSS', 'FLATTOP',

and 'RECTANGULAR'.

window_overlapfloat, default: 0.5

Overlap value between two successive FFT computations. Values can range from 0 to 1. For example, 0 means no overlap, and 0.5 means 50% overlap.

width_selectionint, default: 10

Width in Hz of the area used to select each individual order. Note that its precision depends on the FFT size.

Methods

IsolateOrders.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
IsolateOrders.get_output()	Get the temporal signal of the isolated orders as a DPF field or fields container.
IsolateOrders.get_output_as_nparray()	Get the temporal signal of the isolated orders as a NumPy array.
IsolateOrders.plot()	Plot the signal after order isolation.
IsolateOrders.process()	Isolate the orders of the signal.

Attributes

IsolateOrders.fft_size	Number of FFT points.
IsolateOrders.orders	List of the order numbers to isolate.
IsolateOrders.rpm_profile	RPM profile.
IsolateOrders.signal	Input signal.
IsolateOrders.width_selection	Width in Hz of each individual order selection.
IsolateOrders.window_overlap	Window overlap in %.
IsolateOrders.window_type	Window type.