VCA_Distance¶

class turbustat.statistics.VCA_Distance(cube1, cube2, slice_size=1.0, breaks=None, fiducial_model=None, logspacing=False, low_cut=None, high_cut=None)[source] [edit on github]¶

Bases: object

Calculate the distance between two cubes using VCA. The 1D power spectrum is modeled by a linear model. The distance is the t-statistic of the interaction between the two slopes.

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. If not specified, no break point will be used. fiducial_model : VCA Computed VCA object. use to avoid recomputing.

Methods Summary

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

Implements the distance metric for 2 VCA transforms, each with the same channel width.

Methods Documentation

distance_metric(verbose=False, label1=None, label2=None, ang_units=False, unit=Unit("deg"), save_name=None, use_wavenumber=False)[source] [edit on github]¶

Implements the distance metric for 2 VCA transforms, each with the same channel width. We fit the linear portion of the transform to represent the powerlaw.

Parameters:

verbose : bool, optional Enables plotting. label1 : str, optional Object or region name for cube1 label2 : str, optional Object or region name for cube2 ang_units : bool, optional Convert frequencies to angular units using the given header. unit : u.Unit, optional Choose the angular unit to convert to when ang_units is enabled. save_name : str,optional Save the figure when a file name is given. use_wavenumber : bool, optional Plot the x-axis as the wavenumber rather than spatial frequency.