Main entry point for API calls to TARDIS.

This module collects API calls to TARDIS. Each exported function should facilitate using TARDIS for data analysis. Users that need fine-grained control are encouraged to build their own functions.

tardis.api.calculate_euclidicity(X, Y=None, max_dim=2, n_steps=10, r=None, R=None, s=None, S=None, k=20, n_jobs=1, return_dimensions=False)[source]#

Convenience function for calculating Euclidicity of a point cloud.

This function provides the most convenient interface for calculating Euclidicity of a point cloud. Internally, this function will use the best and fastest Euclidicity calculation, but this comes at the cost of configurability.

TODO: Document me :-)