pafsim.processor.correlator

Module Contents

class pafsim.processor.correlator.Correlator(name: str, **kwargs)

Bases: pafsim.processor._processor.Processor

Inheritance diagram of pafsim.processor.correlator.Correlator

The Correlator takes time series data as input and correlates them. The input is a time series of the form APT or FAPT The output is are ACMs of the form NFPAA, where N is the number of ACMs

Construct a Correlator object

Parameters:

name (str) – The unique name of theCorrelator

kwargs:

acc (int): Number of ACMs to create. mode (str): ‘acm’ -> correlate and build covariance matrices (default)

property default: str

Default process function

property shape: tuple

The shape of the output array

Returns:

The shape

Return type:

tuple

N_INPUT = 1
I_FORMAT = [['F', 'A', 'P', 'T']]
O_FORMAT = ['N', 'F', 'P', 'A', 'A']
acm() numpy.ndarray

Processing function to compute the covariances

Returns:

The output array

Return type:

np.ndarray

plot(path='', figsize=(8, 4))

Plotting function to plot the amplitude of covariance matrices. Just a sub-set is randomly chosen

Parameters:
  • path (str, optional) – If not set to “” it stores the plot in the given directory. Defaults to “”.

  • figsize (tuple, optional) – Size of the plotted figure. Defaults to (8,4).