scirpy.ir_dist.metrics.DistanceCalculator

class scirpy.ir_dist.metrics.DistanceCalculator(cutoff)

Abstract base class for a CDR3-sequence distance calculator.

Parameters
cutoff : int | NoneOptional[int]

Distances > cutoff will be eliminated to make efficient use of sparse matrices. If None, the default cutoff shall be used.

Attributes

DTYPE

The sparse matrix dtype.

Methods

calc_dist_mat(seqs[, seqs2])

Calculate pairwise distance matrix of all sequences in seqs and seqs2.

squarify(triangular_matrix)

Mirror a triangular matrix at the diagonal to make it a square matrix.