pyhctsa.operations.information.first_max

pyhctsa.operations.information.first_max(y, max_what='mi-gaussian', extra_param=None)

Time of first maximum in a given self-correlation function.

Parameters:
y : array-like

The input time series.

max_what : str, optional

Correlation measure to maximize.

Autocorrelation:

  • 'ac': Autocorrelation.

Automutual information (AMI):

  • 'mi': AMI using the JIDT Gaussian estimator (default for AMI).

  • 'mi-kernel': AMI using the JIDT kernel estimator.

  • 'mi-kraskov1': AMI using the JIDT Kraskov estimator (variant 1).

  • 'mi-kraskov2': AMI using the JIDT Kraskov estimator (variant 2).

  • 'mi-hist': AMI using a histogram-based estimator.

Default is 'mi'.

extra_param : any, optional

An additional parameter required for the specified max_what method (e.g., for Kraskov).

Returns:

The time of the first maximum.

Return type:

int