Skip to content

CHANGELOG.md

Latest commit

 

History

History
executable file
·
80 lines (52 loc) · 4.58 KB

CHANGELOG.md

File metadata and controls

executable file
·
80 lines (52 loc) · 4.58 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

- `SinglePulse`'s `component_fitting()` now shows a difference plot between the template and the data if `residualsplot=True`. By default it is `False`.

Fixed

  • 'Archive.getDyanmicSpectrum()now correctly reads a string as an argument fortemplate` and parses the number of phase bins.

[0.1.2] - 2025-07-21

Changed

  • Allow parsing of par file values in "NAME VALUE ERROR" format rather than "NAME VALUE FIT" format for some fold ephemerides inside the PSRFITS files.
  • Default behavior of Archive's fitPulses() now returns all values from SinglePulse's fitPulse() command. Users can still supply specific indices with the num argument to fitPulses()
  • Filled out more of Calibrator's pacv() plot with correct labeling and sizing.
  • Removed numpy warnings from NaNs in data array combination
  • Removed unnecessary reference to scipy.fftpack, which is in legacy.
  • Default behavior of DynamicSpectrum's getData() now has remove_baseline=False and the internal data array is returned as is.
  • Improved error handling on loading a PSRFITS file. PyPulse first checks to see if the file exists, then if it fails in pyfits.open(), raises an exception noting the problem lies internally there.
  • pypav script allows for centering of the pulse in the format of pav with the -C flag.
  • SinglePulse's Uscale() now normalizes the pulse by default, as per the definition.

Added

  • In Archive's imshow(), the y-axis can now be flipped with the flip=True argument. This allows inverted frequency axes to be turned right-side up. A title argument can now be supplied as well.
  • Archive's plot() now takes arguments of subint, pol, and chan to specifically select individual profile rather than requiring the data be 1D. By default, these arguments are 0.
  • SinglePulse.getOffpulseRMS() convenience function added, which calls SinglePulse.getOffpulseNoise()
  • Individual phase plot implemented in Calibrator class as phaseplot(). This can also be called with plot(mode="phase").
  • SinglePulse.component_fitting() now offers the ability to output to PSRCHIVE's paas text file format for von Mises components.
  • In DynamicSpectrum's remove_baseline() command, two flags have been added. By default, ignorezapped=True and so data with a value of zapvalue are ignored. Such dynamic spectra can result from the less-robust generation methods, i.e., not specifying a template shape, thus resulting in a spike of 0.0 values for zapped data. This should be overhauled in the future.
  • Allow DynamicSpectrum's imshow() to take **kwargs now.
  • Par's getPM() function (also used to get the transverse velocity) parses PMELONG and PMELAT.
  • Added a nonnegative=True flag to Archive's getDynamicSpectrum(). By default, if provided a template shape to match against the data, this will enforce non-negative (flux) dynamic spectrum values
  • DynamicSpectrum's imshow() now allows a cbarlabel argument to provide a basic label to the colorbar, and a badcolor argument as an additional method to recolor instead of only alpha.
  • Par can now return an SWX model timeseries with getSWX().

Fixed

  • The DMX class now correctly parses PINT-style .dmx files with no F1 or F2 columns.
  • Archive.bscrunch()'s nbins argument now works.

0.1.1 - 2021-06-15

Added

  • Fitting errors on the 1D scintillation parameters are now added. This changes the underlying functionfit output but this is not part of the public API.

Changed

  • Converted multiple internal map calls to list comprehensions.
  • DynamicSpectrum now copies colormaps with copy.copy to remove MatplotlibDeprecationWarning
  • Fixed scrunching and waterfall plot limits due to updates in numpy in the handling of NaNs. In waterfall plot, duplicate calls to set axis limits have been removed.
  • Fixed pointers to np.str to np.str_ due to updates in numpy.

0.1.0 - 2021-05-03

Added

Changed

  • Start following SemVer properly.