utils
A set of useful functions
Classes
scilightcon.utils.ShotToShotData
Data object from *.s2s file, produced by the Shot-To-Shot Measurement Tool software and generated by scilightcon.utils.load_s2s_data method.
Attributes:
| Name | Type | Description |
|---|---|---|
filepath |
str
|
Absolute file path of the *.s2s file |
version |
int
|
*.s2s file format format |
temporal_data_x |
List[float]
|
Delays in nanoseconds |
temporal_data_y |
List[float]
|
Measured temporal data voltages in volts |
sml_data |
List[float]
|
All measured data, normalized to the mean value |
sml_mean |
float
|
Mean voltage of measured |
nmrsd_data_x |
List[float]
|
Time points in seconds of calculated NRMSD |
nmrsd_data_y |
List[float]
|
Values of calculated NRMSD |
outliers |
List[ShotToShotOutlier]
|
Outlier data |
device_serial_number |
str
|
Serial number of device used in the measurement |
repetition_rate |
float
|
Repetition rate in kHz |
wavelength |
float
|
Wavelength of measured light |
scilightcon.utils.ShotToShotOutlier
Outlier data for the scilightcon.utils.ShotToShotData object
Attributes:
| Name | Type | Description |
|---|---|---|
time |
float
|
Time in seconds, when the outlier was recorded |
voltage |
List[float]
|
Raw voltage data of the data chunk corresponding to the outlier. |
Functions
scilightcon.utils.interpolate_and_multiply(D1, D2)
Takes D2 array and interpolates x an y with respect to array from D1. Then takes an array form D2 and adujsts its range according to D1 and multiplies two arrays.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
D1 |
tuple
|
An array to which respect anoter array is interpolated |
required |
D2 |
tuple
|
An array which x and y values are interpolated |
required |
Returns:
| Type | Description |
|---|---|
Tuple[List[float], List[float]]
|
A tuple of two elements which is a product of |
scilightcon.utils.load_s2s_data(filepath)
Loads data from *.s2s file, produced by the Shot-To-Shot Measurement Tool software
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filepath |
str
|
An absolute path to the *.s2s file |
required |
Returns:
| Type | Description |
|---|---|
ShotToShotData
|
ShotToShotData object |