HCTSA function mappings¶

For existing hctsa users, the following table provides a mapping between existing hctsa functions and equivalent pyhctsa implementations for reference.

Warning

The conceptual groupings in pyhctsa modules (e.g., medical, distribution, etc.) do not always correspond to the same groupings in the original HCTSA.

pyhctsa name	hctsa legacy name	pyhctsa module
hrv_classic	MD_hrv_classic	medical
pnn	MD_pNN	medical
pol_var	MD_polvar	medical
raw_hrv_meas	MD_rawHRVmeas	medical
moving_threshold	EX_MovingThreshold	extreme_events
rad	CR_RAD	criticality
autocorr	CO_AutoCorr	correlation
add_noise	CO_AddNoise	correlation
glscf	CO_glscf	correlation
fzcglscf	CO_fzcglscf	correlation
embed2	CO_Embed2	correlation
embed2_shapes	CO_Embed2_Shapes	correlation
embed2_basic	CO_Embed2_Basic	correlation
embed2_dist	CO_Embed2_Dist	correlation
embed2_angle_tau	CO_Embed2_AngleTau	correlation
partial_autocorr	CO_PartialAutoCorr	correlation
nonlinear_autocorr	CO_NonlinearAutocorr	correlation
stick_angles	CO_StickAngles	correlation
first_crossing	CO_FirstCrossing	correlation
translate_shape	CO_TranslateShape	correlation
autocorr_shape	CO_AutoCorrShape	correlation
histogram_ami	CO_HistogramAMI	correlation
compare_min_ami	CO_CompareMinAMI	correlation
periodicity_wang	PD_PeriodicityWang	correlation
trev	CO_trev	correlation
tc3	CO_tc3	correlation
time_rev_kaplan	DK_timerev	correlation
crinkle_statistic	DK_crinkle	correlation
theiler_q	DK_theilerQ	correlation
automutual_info_stats	IN_AutoMutualInfoStats	information
first_min	CO_FirstMin	information
first_max	CO_FirstMin	information
rm_automutual_information	CO_RM_AMInformation	information
distribution_entropy	EN_DistributionEntropy	entropy
permutation_entropy	EN_PermEn	entropy
lempel_ziv_complexity	EN_MS_LZcomplexity	entropy
complexity_invariant_distance	EN_CID	entropy
approximate_entropy	EN_ApEn	entropy
rpde	EN_rpde	entropy
sample_entropy	EN_SampEn	entropy
multi_scale_entropy	EN_mse	entropy
shannon_entropy	EN_MS_shannon	entropy
stat_av	SY_StatAv	stationarity
trend	SY_Trend	stationarity
std_nth_deriv	SY_StdNthDer	stationarity
ts_length	ST_Length	stationarity
fit_polynomial	ST_FitPolynomial	stationarity
sliding_window	SY_SlidingWindow	stationarity
local_global	SY_LocalGlobal	stationarity
drifting_mean	SY_DriftingMean	stationarity
range_evolve	SY_RangeEvolve	stationarity
kpss_test	SY_KPSStest	stationarity
local_extrema	ST_LocalExtrema	stationarity
simple_stats	ST_SimpleStats	stationarity
moment_corr	ST_MomentCorr	stationarity
dyn_win	SY_DynWin	stationarity
local_distributions	SY_LocalDistributions	stationarity
withinp	DN_Withinp	distribution
unique	DN_Unique	distribution
spread	DN_Spread	distribution
quantile	DN_Quantile	distribution
proportion_values	DN_ProportionValues	distribution
pleft	DN_pleft	distribution
min_max	DN_MinMax	distribution
mean	DN_Mean	distribution
high_low_mu	DN_HighLowMu	distribution
fit_mle	DN_Fit_mle	distribution
cv	DN_cv	distribution
custom_skewness	DN_CustomSkewness	distribution
burstiness	DN_Burstiness	distribution
moments	DN_Moments	distribution
outlier_include	DN_OutlierInclude	distribution
outlier_test	DN_OutlierTest	distribution
trimmed_mean	DN_TrimmedMean	distribution
histogram_asymmetry	DN_HistogramAsymmetry	distribution
histogram_mode	DN_HistogramMode	distribution
remove_points	DN_RemovePoints	distribution
compare_ks_fit	DN_CompareKSFit	distribution
fast_dfa	SC_fastdfa	scaling
fluctuation_analysis	SC_FluctAnal	scaling
transition_matrix	SB_TransitionMatrix	symbolic
binary_stats	SB_BinaryStats	symbolic
motif_three	SB_MotifThree	symbolic
motif_two	SB_MotifTwo	symbolic
binary_stretch	SB_BinaryStretch	symbolic
surprise	FC_Surprise	symbolic
wl_coeffs	WL_coeffs	wavelet
detail_coeffs	WL_DetailCoeffs	wavelet
cwt	WL_cwt	wavelet
dwt_coeff	WL_dwtcoeff	wavelet
scal_2_freq	WL_scal2frq	wavelet
wfbm	WL_fBM	wavelet
hypothesis_test	HT_HypothesisTest	hypothesis_tests
variance_ratio_test	SY_VarRatioTest	hypothesis_tests
spectral_summaries	SP_Summaries	spectral
ar_cov	MF_AR_arcov	model_fit
exp_smoothing	MF_ExpSmoothing	model_fit
ar_fit	MF_arfit	model_fit
local_simple	FC_LocalSimple	model_fit
loop_local_simple	FC_LoopLocalSimple	model_fit
fit_subsegments	MF_FitSubsegments	model_fit
hmm_fit	MF_hmm_fit	model_fit
is_seasonal	DT_IsSeasonal	model_fit
visibility_graph	NW_VisibilityGraph	graph
force_potential	PH_ForcePotential	physics
walker	PH_Walker	physics
preproc_compare	PP_Compare	pre_process
surrogate_test	SD_SurrogateTest	surrogates
nsamdf	NL_nsamdf	nonlinearity
nlpe	NL_MS_nlpe	nonlinearity
embed_pca	NL_embed_PCA	nonlinearity