edges_cal.tools.FrequencyRange.decimate

FrequencyRange.decimate(bin_size: int, decimate_at: int | str = 'centre', embed_mask: bool = True) → Self[source]

Decimate the frequency array.

Parameters:

  • bin_size – The number of raw bins to combine into one.

  • decimate_at – Where to start the decimation from. If ‘centre’, then the new frequency array will be the mean frequency in each bin (equivalent to decimate_at=bin_size//2 for odd bin_size, but for even bin size, the new frequencies are between the central two of the bin). If an integer, then the decimation starts at that index.

  • embed_mask – Whether to embed the mask in the new frequency array. IF False, the returned object will have an underlying frequency array with the full range of data, but with a mask similar to this object. If True, the returned object will have the frequencies outside the mask range removed completely.