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.

Note

Names follow the current hctsa main branch. hctsa has standardized the capitalization of 33 function names (e.g., DN_cv → DN_CV, EN_MS_LZcomplexity → EN_LZComplexity, NL_TISEAN_d2 → NL_d2) and renamed SB_BinaryStretch → SB_BinaryGapHomogeneity. A few ported functions (CO_RM_AMInformation, DN_HighLowMu, SY_DynWin) have since been removed from hctsa and are listed under their last name.

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
porta	MD_Porta	medical
moving_threshold	EX_MovingThreshold	extreme_events
extreme_event_order	EX_ExtremeEventOrder	extreme_events
rad	CR_RAD	criticality
oversampling	CO_Oversampling	correlation
time_rev_kld	CO_TimeRevKLD	correlation
autocorr	CO_AutoCorr	correlation
autocorr_x2_shape	CO_AutoCorrX2Shape	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
falling_sticks	CO_FallingSticks	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
pos_neg_asymmetry	CO_PosNegAsymmetry	correlation
crinkle_statistic	DK_crinkle	correlation
theiler_q	DK_theilerQ	correlation
joint_non_gaussianity	CO_JointNonGaussianity	correlation
matrix_profile	CO_MatrixProfile	correlation
quantilogram	CO_Quantilogram	correlation
remove_points	CO_RemovePoints	correlation
automutual_info_stats	IN_AutoMutualInfoStats	information
first_min	CO_FirstMin	information
first_max	CO_FirstMin	information
multivariate_ami	IN_MultivariateAMI	information
distribution_entropy	EN_DistributionEntropy	entropy
permutation_entropy	EN_PermEn	entropy
lempel_ziv_complexity	EN_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_Shannon	entropy
bubble_entropy	EN_BubbleEn	entropy
dispersion_entropy	EN_DispEn	entropy
fuzzy_entropy	EN_FuzzyEn	entropy
permutation_entropy_complexity	EN_PermEnComplexity	entropy
randomize_ordinal	EN_RandomizeOrdinal	entropy
wavelet_entropy	EN_wentropy	entropy
stat_av	SY_StatAv	stationarity
trend	SY_Trend	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
pp_test	SY_PPtest	stationarity
local_extrema	ST_LocalExtrema	stationarity
simple_stats	ST_SimpleStats	stationarity
moment_corr	ST_MomentCorr	stationarity
local_distributions	SY_LocalDistributions	stationarity
ramping_windows	SY_RampingWindows	stationarity
slow_feature_analysis	SY_SlowFeatureAnalysis	stationarity
peak_intervals	ST_PeakIntervals	stationarity
drifting_auto_corr	SY_DriftingAutoCorr	stationarity
drifting_mean_cusum	SY_DriftingMeanCUSUM	stationarity
spread_random_local	SY_SpreadRandomLocal	stationarity
std_nth_deriv_change	SY_StdNthDerChange	stationarity
nstat_z	SY_nstat_z	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
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
fit_kernel_smooth	DN_FitKernelSmooth	distribution
simple_fit	DN_SimpleFit	distribution
tail_index	DN_TailIndex	distribution
fluctuation_analysis	SC_FluctAnal	scaling
mma	SC_MMA	scaling
higuchi_fd	SC_HiguchiFD	scaling
mfdfa	SC_MFDFA	scaling
transition_matrix	SB_TransitionMatrix	symbolic
transition_p_alphabet	SB_TransitionPAlphabet	symbolic
binary_stats	SB_BinaryStats	symbolic
motif_three	SB_MotifThree	symbolic
motif_two	SB_MotifTwo	symbolic
binary_stretch	SB_BinaryGapHomogeneity	symbolic
surprise	FC_Surprise	symbolic
binary_stats_ar1	SB_BinaryStats_AR1	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
modwt_var	WL_modwtvar	wavelet
wpd_best_tree	WL_wpdBestTree	wavelet
distribution_test	HT_DistributionTest	hypothesis_tests
variance_ratio_test	SY_VarRatioTest	hypothesis_tests
independence_tests	HT_IndependenceTests	hypothesis_tests
marginal_tests	HT_MarginalTests	hypothesis_tests
phase_amp_coupling	SP_PhaseAmpCoupling	spectral
spectral_summaries	SP_Summaries	spectral
spectral_summaries_phase	SP_SummariesPhase	spectral
specparam	SP_Specparam	spectral
cepstrum	SP_Cepstrum	spectral
bicoherence	SP_Bicoherence	spectral
envelope_stats	SP_EnvelopeStats	spectral
phase_fluctuation_scaling	SP_PhaseFluctuationScaling	spectral
sinusoid_fit	SP_SinusoidFit	spectral
spectral_time_freq	SP_SpectralTimeFreq	spectral
rhythmicity	SP_Rhythmicity	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
gp_fit_across	MF_GP_FitAcross	model_fit
compare_ar	MF_CompareAR	model_fit
compare_test_sets	MF_CompareTestSets	model_fit
garch_compare	MF_GARCHcompare	model_fit
garch_fit	MF_GARCHfit	model_fit
gp_hyperparameters	MF_GP_Hyperparameters	model_fit
state_space_comp_order	MF_StateSpaceCompOrder	model_fit
state_space_n4sid	MF_StateSpace_n4sid	model_fit
armax	MF_armax	model_fit
hmm_compare_n_states	MF_hmm_CompareNStates	model_fit
steps_ahead	MF_steps_ahead	model_fit
visibility_graph	NW_VisibilityGraph	graph
ordinal_partition_network	NW_OrdinalPartitionNetwork	graph
force_potential	PH_ForcePotential	physics
walker	PH_Walker	physics
kramers_moyal	PH_KramersMoyal	physics
preproc_compare	PP_Compare	pre_process
preproc_iterate	PP_Iterate	pre_process
preproc_model_fit	PP_ModelFit	pre_process
preproc_schreiber_denoise	PP_SchreiberDenoise	pre_process
surrogate_test	SD_SurrogateTest	surrogates
surrogates	SD_Surrogates	surrogates
nsamdf	NL_NSAMDF	nonlinearity
nlpe	NL_nlpe	nonlinearity
embed_pca	NL_EmbedPCA	nonlinearity
ssa	NL_SSA	nonlinearity
zero_one_test	NL_ZeroOneTest	nonlinearity
local_density	NL_LocalDensity	nonlinearity
tisean_d2	NL_d2	nonlinearity
poincare_section	NL_PoincareSection	nonlinearity
delay_time	NL_DelayTime	nonlinearity
box_count_entropy_rate	NL_BoxCountEntropyRate	nonlinearity
dvv	NL_DVV	nonlinearity
dimensions	NL_Dimensions	nonlinearity
evt_local_dim	NL_EVTLocalDim	nonlinearity
embed_cluster	NL_EmbedCluster	nonlinearity
embed_kernel_pca	NL_EmbedKernelPCA	nonlinearity
fnn	NL_FNN	nonlinearity
fractal_dimensions	NL_FractalDimensions	nonlinearity
gp_corr_sum	NL_GPCorrSum	nonlinearity
largest_lyap	NL_LargestLyap	nonlinearity
lyap_spec	NL_LyapSpec	nonlinearity
persistent_homology	NL_PersistentHomology	nonlinearity
rqa	NL_RQA	nonlinearity
recurrence_times	NL_RecurrenceTimes	nonlinearity
return_time	NL_ReturnTime	nonlinearity
takens_estimator	NL_TakensEstimator	nonlinearity
tisean_c1	NL_c1	nonlinearity
stepdetect	CP_ML_StepDetect	changepoint
l1pwc_sweep_lambda	CP_l1pwc_SweepLambda	changepoint
wavelet_var_chg	CP_WaveletVarChg	changepoint