VCS_Distance¶

class turbustat.statistics.VCS_Distance(cube1, cube2, breaks=None, fiducial_model=None, vel_units=False)[source] [edit on github]¶

Bases: object

Calculate the distance between two cubes using VCS. The 1D power spectrum is modeled by a broked linear model to account for the density and velocity dominated scales. The distance is the sum of the t-statistics for each model.

Parameters:

cube1 : numpy.ndarray or astropy.io.fits.PrimaryHDU or SpectralCube Data cube. cube2 : numpy.ndarray or astropy.io.fits.PrimaryHDU or SpectralCube Data cube. slice_size : float, optional Slice to degrade the cube to. breaks : float, list or array, optional Specify where the break point is. If None, attempts to find using spline. fiducial_model : VCS Computed VCS object. use to avoid recomputing. vel_units : bool, optional Convert frequencies to the spectral unit in the headers.

Methods Summary

distance_metric([verbose, label1, label2, ...])

Implements the distance metric for 2 VCS transforms.

Methods Documentation

distance_metric(verbose=False, label1=None, label2=None, save_name=None)[source] [edit on github]¶

Implements the distance metric for 2 VCS transforms. This distance is the t-statistic of the difference in the slopes.

Parameters:	verbose : bool, optional Enables plotting. label1 : str, optional Object or region name for cube1 label2 : str, optional Object or region name for cube2 save_name : str,optional Save the figure when a file name is given.