Python API
This is the class and function reference of pycatch22. Please refer to the user guide for further details as the class and function specifications may not be sufficient to give full context.
catch22_all
Extract the catch22 feature set from an input time series.
Syntax
pycatch22.catch22_all(data, catch24=False, short_names=False)
Parameters
catch24
If True, include the two catch24 features (mean and standard deviation) in the output. Default is False.
short_names
If True, also include the short names of the features in the output. Default is False.
Return Value
The function returns a dictionary with the following keys:
Example Usage
import numpy as np
import pycatch22 as catch22
data = np.random.rand(100)
features = catch22_all(data)
print(features['names'])
# Output: ['DN_HistogramMode_5', 'DN_HistogramMode_10', 'CO_f1ecac', ..., 'SP_Summaries_welch_rect_centroid', 'FC_LocalSimple_mean3_stderr']
print(features['values'])
# Output: [0.23, 0.18, 1.52, ..., 0.04, 0.67]
features_with_catch24 = catch22_all(data, catch24=True)
print(features_with_catch24['names'][-2:])
# Output: ['DN_Mean', 'DN_Spread_Std']
features_with_short_names = catch22_all(data, short_names=True)
print(features_with_short_names['short_names'])
# Output: ['mode_5', 'mode_10', 'acf_timescale', ..., 'low_freq_power', 'forecast_error']
Individual Feature Methods
The catch22
module provides direct access to the individual feature extraction methods implemented in C. These methods can be called directly using pycatch22.{name}
, where {name}
is the name of the feature method (as given by the long name in the table of features).
Syntax
pycatch22.DN_Mean(data)
Parameters
Return Values
Example Usage
import numpy as np
from pycatch22 import DN_Mean
data = list(np.random.randn(100))
individual_feature = DN_Mean(data)
print(individual_feature)
# Output: -0.11125506527054776
Last updated