microcalorimetry.export¶
This module contains functions for exporting HDF5 datasets into different formats that aren’t the preffered format for the microcaloriemetry program.
Functions¶
|
Generate a .eff file from an effective efficiency measurement. |
Package Contents¶
- microcalorimetry.export.as_doteff(path: pathlib.Path, eta: microcalorimetry.configs.Eta, s11: microcalorimetry.configs.S11, sensor_name: str = None, connect_number: int = None, expansion_factor: int | float = 2, frequency_decimals: int = 2, eta_decimals: int = 4, s11_abs_decimals: int = 4, s11_angle_decimals: int = 2, columns: int = 7)[source]¶
Generate a .eff file from an effective efficiency measurement.
These files contain an effective efficiency measurement, as well as a reflection coefficient and an expression of uncertainty. Type A and Type B uncertainties will be inferred from the objects covariance metadata.
Exporting as a .eff file will lose covariance information about the measurement.
- Parameters:
- pathPath
File path to save to.
- etaconfigs.Eta
Effective efficiency of the sensor.
- s11configs.S11
S11 data of the sensor.
- sensor_namestr
Name of the sensor. If not provided, won’t be included in the output file.
- connect_numberint
Connect number of the sensor. If not provided, won’t be included in the comment line.
- expansion_factorint, optional
Expansion factor of the total uncertainty. If >= 1, will use that as the expansion factor. If < 1, then will calculate the confidence interval of the provided fraction (e.g 0.95 will calculate the 95% confidence interval) using metadata of the uncertainty mechanisms.
- frequency_decimalsint, optional
Decimals for reporting frequency, by default 2
- eta_decimalsint, optional
Decimals for reporting the eta parameters, by default 4.
- s11_abs_decimalsint, optional
Decimals for reporting the S11 absolute value, by default 4.
- s11_angle_decimalsint, optional
Decimals for reporting the S11 angle vakule, by default 2.
- columnsint, optional
Number of columns in the eff file. By default 7.