anatools.anaclient.analytics module

Analytics Functions

create_analytics(self, datasetId, type, range=[], images=True, workspaceId=None)

Generate analytics for a dataset.

Parameters:

  • datasetId (str) – Dataset ID to download image annotation for.

  • type (str) – The type of analytics to generate. Choose one from the list that get_analytics_types method returns.

  • range (list[int]) – The range of runs to generate analytics for.

  • images (bool) – If true, images specific to the analytics type will be created along with metrics data.

  • workspaceId (str) – Workspace ID of the dataset to generate the analytics for. If none is provided, the current workspace will get used.

Returns:

The analyticsId for the analytics job.

Return type:

str

delete_analytics(self, analyticsId, workspaceId=None)

Deletes a dataset’s analytics.

Parameters:

  • analyticsId (str) – Analytics ID for the analytics to delete.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns:

If true, successfully deleted the analytics.

Return type:

bool

get_analytics(self, analyticsId, workspaceId=None)

Retrieve information about a specific analytics job. If an analytics job is of type objectMetrics or meanBrightness, then images will get downloaded to current working directory.

Parameters:

  • analyticsId (str) – Analytics Job ID.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns:

Analytics job information.

Return type:

list[dict]

get_analytics_types(self)

Retrieve the analytics types available on the Platform.

Returns:

The analytics types available on the Platform.

Return type:

list[str]