Skip to content

Renamed Spectrum to FrequencySeries

Duncan Macleod requested to merge github/fork/duncanmmacleod/frequencyseries into master

This PR renames the Spectrum object FrequencySeries, bringing it inline with other similar classes in LAL and PyCBC, for example.

The main motivation for this is pedantry, a 'spectrum' is a specific instance of a frequency-series, so we should use the generic name for a generic object.

This PR includes patches to rename the class, provide deprecation-warning'd sub-classes so that codes using Spectrum don't immediately die, and updated all uses of Spectrum in the code library, examples, and documentation.

I also improved the documentation a wee bit at the end, mainly adding a section for 'frequency-domain data' which actually links the FrequencySeries and Spectrogram class references.

Merge request reports