Changelog¶
v0.2.0¶
This version includes breaking change. The align
method was renamed to apply
and the realign
method was renamed as apply
.
Please update your codebase to reflect this!
- Remove removed the
quick_shifts
parameter as it was not really used and theonly_shift
parameter does the job instead - Change the
align
method was renamed toapply
- Change the
realign
method was renamed toalign
- New added
compute
method which makes it possible to simply calculate the correction factors for signal that was not provided in thearray
attribute - Change the
array
initialization value can now beNone
and it's assumed that you plan on using thecompute
method - New added
_align
and_shift
methods that perform the correction methods. These can be handy if you are using thecompute
method - Change all optional parameters are now properties with appropriate data validators
v0.1.10¶
- New exposed few parameters to the
run
andalign
functions, so you can update the init parameters
v0.1.9¶
- New exposed the post-alignment shift values (which might differ from
shift_opt
if thequick_align
option is used) - Improvement tidied up code
v0.1.8¶
- Change Split the
run
command of theAligner
class torun
(which computes the shift) andalign
which shifts the input array to the new position.
v0.1.7¶
- New Changed the structure of the package to be more Object-oriented. Alignment is now wrapped in its own class
Aligner
which can be directly imported or used like before usingfrom msalign import msalign
- New Added new
shift
function which simply shifts signals without interpolation - can be a lot faster but less accurate. Can be accessed by using keyword parameterquick_shift=True
or by calling theshift()
function - Improvement Cleaned-up code and renamed some poorly named variables
- Change Remove support from Python 2.7, 3.4, 3.5
v0.1.3¶
- New added new keyword parameter
align_by_index
which when set toTrue
will convert the values ofpeaks
to index based on the inputxvals
array. This is introduced as I've noticed that sometimes when aligning to float values the alignment is not optimal - Improvement added more tests to the
tests
suite
v0.1.0¶
- Fix #5 small bug that prevented correct alignment of the MS example
- New added new keyword parameter 'return_shifts' which when set to True will return the aligned data and the vector containing shift parameters