v0.3.5.1

Updated requirements and fixed Nonstationary Fourier Mode Decomposition

• Changed to Igor2 package requirement
• Added fixes to enable Python 3.10, removed Python 3.7 from tests.
• Various test bugs so it's finally passing again
• Fixed NFMD so it's correctly functioning now.

v0.3.5.0

Features added

• Nonstationary Fourier Mode Decomposition (NFMD)
• Impulse response/deconvolution in frequency response
• Correct tests and documentation
• Calibration curve via simulation for correcting t_FP images

Bug fixes

• Plotting bugs
• Removed Pycroscopy dependency
• Added PyTorch dependency for NFMD
• GKPixel (G-Mode SKPM) Bug fixes

v0.3.4 .1

• Minor changes to imports
• Added version

v0.3.4

• Added NFMD to main code
• Fixed calibration curve functionality to simulation.calibration_curve to generate a scaling between measured time constant and expected
• Fixed tests
• A few related bug fixes

v0.3.3

• Several bug fixes
• Updated requirements
• Started documentation and tests but LONG way left to go :\

Future

• Adding Daniel Shea's NFMD code: https://github.com/sheadan/NFMD-ExtractionInstantaneous/tree/master/nfmd
• Further tests/documentation

v0.3.2

• Fixed Pixel and GKPFM code
• Updated GKPFM Process class
• Fixed some dependencies due to Sidpy change

SidPy and documentation

• Updated requirements to add SidPy
• Added initial documentation, still a work in progress!
• Some major bug fixes to GKPFM analysis side
• Other minor bug fixes and quality of life changes

v0.3.0

Significant rewrites of Pixel

• Added Short-Time Fourier Transform, frequency DC filter, amplitude DC filter
• Split frequency analysis (e.g. generating time-to-frequency-peak) from processing (e.g. generating instantaneous frequency)
• Added pyUSID.Process class implementation for GKPFM
• Rewrote GKPixel class
• Reorganized the subfolders and package structure to make more sense
• Edits to Create_movie function and some fixes for new pyUSID implementation
• Renamed a bunch of load functions to make sense, added a load wrapper

Roadmap

• Documentation is really lacking :\
• Enable arbitrary functions used for generating tFP, not just the hard-coded functional forms
• Rewrite Pixel to allow arbitrary arguments, auto-generate a parameters file

Simulation Corrections

• Several fixes for Simulation and Cantilever/ElectricDrive
• Changes to hot pixel corrections
• Updates to GKPixel to allow creating a transfer function internally

Roadmap:

• Broadband pulse simulation to generate a transfer function and fit to Pycroscopy SHO
• Split Pixel into analysis and processing to integrate with future developments (split wavelet, mode decomposition, STFT, etc)
• Package will need reorganization; hdf_utils is ambiguous.

Possible changes

• Adapt to pyNSID model rather than pyUSID

New simulate method

This now keeps the Cantilever as a base class with relevant implementations and allows user to implement a parent that inherits this class.

Advantages:

• Makes the code for electricDrive its own file, same with MechanicalDrive
• Allows users to allow any arbitrary change (some exotic modification of the force) but keeps all the mild bookkeeping and large init file behind the scenes.
• MechanicalDrive is now edited to allow an arbitrary function passed as the excitation OR a voltage_array