stats_wrapper¶

turbustat.statistics.stats_wrapper(dataset1, dataset2, fiducial_models=None, statistics=None, multicore=False, vca_break=None, vcs_break=None, dendro_params=None, noise_value=[-inf, -inf], dendro_saves=[None, None], cleanup=True)[source] [edit on github]¶

Function to run all of the statistics on two datasets. Each statistic is run with set inputs. This function needs to be altered to change the inputs.

Parameters:

dataset1 : dict Contains the cube and all of its property arrays. dataset2 : dict See dataset1 fiducial_models : dict, optional Models for dataset1. Avoids recomputing when comparing many sets to dataset1. statistics : list, optional List of all of the statistics to use. If None, all are run. multicore : bool, optional If the wrapper is being used in parallel, this disables returning model values for dataset1. dendro_params : dict or list, optional Provides parameters to use when computing the initial dendrogram. If different parameters are required for each dataset, the the input should be a list containing the two dictionaries. cleanup : bool, optional Delete distance classes after running.