Welcome to TESFDMtools’s documentation!¶
Using TESFDMtools software for the first time¶
Before you install or use the software for the first time, please make sure that the packages mentioned in Standard python3 Debian packages are installed.
If you are running TESFDMtools on an SRON machine, please see “Initialize TESFDMtools software” below for instructions how to run the software.
Initialize TESFDMtools software¶
To make all executables and modules of TESFDMtools available in your terminal type:
- For bash shells:
“source /opt/local/TN/env/tesfdmtools.sh”
- For csh shells:
“source /opt/local/TN/env/tesfdmtools.csh”
These files set the PATH variable for executables and the PYTHONPATH variable for python modules. In principle, the source command can be added to the .bashrc or .cshrc file in your home directory to set these variables automatically. However, be aware that this environment could conflict with other software packages.
TESFDMtools pipeline processing scripts and tools¶
Your path should include “/opt/local/TN/tesfdmtools/bin” to use these scripts. (This path will be automatically set when sourcing the above .csh or .sh files)
Contents:
- TESFDMtools pipeline scripts and interactive tools
- HDF_Eventpar : processing of FDM X-ray measurements to get energy resolutions
- mHDF_Eventpar : run the HDF_Eventpar script using multiple cpu’s
- XHDF_Eventpar : processing of FDM X-ray measurements to get energy resolutions
- mXHDF_Eventpar : run the HDF_Eventpar script using multiple cpu’s
- HDF_NEP : Compute NEP for HDF5 X-ray and noise files.
- mHDF_NEP : run the HDF_NEP script using multiple cpu’s
- HDF_SQUIDnoise : plot SQUID measurement noise plots
- HDF_SQUIDspectrum : plot individual SQUID noise spectrum
- HDF_Crosstalk : Crosstalk analysis
- mHDF_Crosstalk : run the HDF_Crosstalk script using multiple cpu’s
- HDF_view : view HDF5 X-ray dataset
- SQUID_view : view HDF5 SQUID-noise dataset
- HDF_average: plot average raw data and spectrum of all records
- HDF_showattributes: Show attributes of HDF5 file
- Crosstalkmatrix: plot crosstalk data in matrix
- Xdf2Hdf: convert xdf datasets into hdf datasets
- Hdf2Xdf: convert hdf datasets into xdf datasets
- mhfit: Manual interactive fit of the Holzer profile to evenlist data
- shvfit: Fit spectrum using the Holzer profile and a Voigt profile convolution
- event_surface_spectrum: Make a spectrum of the events (pulse) surface data
- PCA_analysis: Principal Component Analysis of X-ray pulse records
- HDF_Bfit: Optimal baseline fit.
- mHDF_Bfit : run the HDF_Bfit script using multiple cpu’s
- Processing scripts for asellus
TESFDMtools Python3 module library¶
The PYTHONPATH environment variable must be set to “/opt/local/TN/tesfdmtools/lib/python3.5/site-packages” to make the tesfdmtools module library available.
Contents:
- HDF5 read/write utility classes
- Algorithms and methods for TES/FDM analysis
- holzer : Compute and fit Mn,[Cr,Cu] K-alpha/K-beta lines according to Holzer
- holzerv : Fit Mn,[Cr,Cu] K-alpha/K-beta lines according to Holzer using Voigt profile convolution
- TDoptfilter : Optimal filter fit of TES pulses in the time domain
- TDMoptfilter : Optimal filter fit of TES pulses in the time domain using alternate filters
- TMoptfilter : Optimal filter fit of TES pulses with alternate optimal filters
- Moptfilter : Optimal filter fit of TES pulses using mutiple templates
- MTDoptfilter : Optimal filter fit of TES pulses in the time domain, using multiple templates
- IQrotate : Rotations of TES pulse in IQ plane
- spectrumfit : fit Mn55 K-alpha lines in given spectrum
- MCeventlist : Monte-Carlo event list for Mn,[Cu,Cr] Alpha/Beta lines spectrum
- HDF_Eventutils : Algorithms used for X-ray event processing
- HDF_NEPutils : Algorithms used for X-ray events NEP computation
- HDF_SQUIDutils : utility functions used for the SQUID noise measurements processing
- HDF_Cutils : Algorithms used for crosstalk analysis
- fitcor : fit correlation of two parameters
- filterect : Exclude records with positive electric crosstalk pulses
- gaussfit: fit gauss function to data
- expfit: fit exponential function to data
- shiftarr: shift a numpy array, extending the edges by averaging
- xcorplot: plot crosscorrelation plots as images to speedup pdf display
- positivepulse: determine for data file if pulse is positive or negative
- specfit : fit multi-line spectrum
- mxsspec: fit mxs(Cr,Cu)+Mn55 spectrum to data
- brems : provide model Bremsstrahlung-spectrum based on MXS spectrum
- aldtimes : get delta times to previous event from all pixels
- PCA : Principal Component Analysis (PCA)
- Bfit_Utils: Utilities for baseline optimal fit
- GTK widgets for graphical interface
- General utility functions