TemporalScalarFields class¶

class IMTreatment.core.temporalscalarfields.TemporalScalarFields[source]¶

Class representing a set of time-evolving scalar fields.

fill(tof='spatial', kind='linear', value=0.0, inplace=False, crop=False)[source]¶

Fill the masked part of the array in place.

Parameters:

tof (string) – Can be ‘temporal’ for temporal interpolation, or ‘spatial’ for spatial interpolation.
kind (string, optional) – Type of algorithm used to fill. ‘value’ : fill with a given value ‘nearest’ : fill with nearest available data ‘linear’ : fill using linear interpolation ‘cubic’ : fill using cubic interpolation
value (2x1 array) – Value for filling, ‘[Vx, Vy]’ (only usefull with tof=’value’)
inplace (boolean, optional) –
.
crop (boolean, optional) – If ‘True’, TVF borders are croped before filling.

get_max_field(nmb_min=1)[source]¶

Calculate the maximum scalar field, from all the fields.

Parameters:	nmb_min (integer, optional) – Minimum number of values used to take a maximum value. Else, the value is masked.

get_min_field(nmb_min=1)[source]¶

Calculate the minimum scalar field, from all the fields.

Parameters:	nmb_min (integer, optional) – Minimum number of values used to take a minimum value. Else, the value is masked.

get_phase_map(freq, tf=None, check_spec=None, verbose=True)[source]¶

Return the phase map of the temporal scalar field for the given frequency.

Parameters:	freq (number) – Wanted frequency tf (Integer) – Last time indice to use check_spec (Integer) – If not None, specify the number of spectrum to display (useful to check if choosen frequencies are relevant). verbose (Boolean) – .
Returns:	phase_map – .
Return type:	ScalarField object

get_spectral_filtering(fmin, fmax, order=2, inplace=False)[source]¶

Perform a temporal spectral filtering

Parameters:	fmax (fmin,) – Minimal and maximal frequencies order (integer, optional) – Butterworth filter order
Returns:	filt_tsf – Filtered temporal field
Return type:	TemporalScalarFields