SCF_Distance

class turbustat.statistics.SCF_Distance(cube1, cube2, size=11, fiducial_model=None, weighted=True)[source] [edit on github]

Bases: object

Calculates the distance between two data cubes based on their SCF surfaces. The distance is the L2 norm between the surfaces. We weight the surface by 1/r^2 where r is the distance from the centre.

Parameters:

cube1 : numpy.ndarray

Data cube.

cube2 : numpy.ndarray

Data cube.

size : int, optional

Maximum size roll over which SCF will be calculated.

fiducial_model : SCF

Computed SCF object. Use to avoid recomputing.

weighted : bool, optional

Sets whether to apply the 1/r^2 weighting to the distance.

Methods Summary

Methods Documentation

distance_metric(verbose=False)[source] [edit on github]

Compute the distance between the surfaces.

Parameters:

verbose : bool, optional

Enables plotting.