ott.geometry.pointcloud.PointCloud.to_LRCGeometry#

PointCloud.to_LRCGeometry(scale=1.0, **kwargs)[source]#

Convert point cloud to low-rank geometry.

Parameters

  • scale (float) – Value used to rescale the factors of the low-rank geometry. Useful when this geometry is used in the linear term of fused GW.

  • kwargs (Any) – Keyword arguments, such as rank, to to_LRCGeometry() used when the point cloud does not have squared Euclidean cost.

Return type

Union[LRCGeometry, PointCloud]

Returns

Returns the unmodified point cloud if \(n m \ge (n + m) d\), where \(n, m\) is the shape and \(d\) is the dimension of the point cloud with squared Euclidean cost. Otherwise, returns the re-scaled low-rank geometry.