client.skeleton

Client for interacting with the skeleton service.

Methods:

Name	Description
get_skeleton	Gets basic skeleton information for a datastack
get_cache_contents	Mirror CloudFiles.list() for skeletons as a pass-through interface to the underlying service and bucket.
skeletons_exist	Confirm or deny that a set of root ids have H5 skeletons in the cache.
get_bulk_skeletons	Generates skeletons for a list of root ids without retrieving them.
generate_bulk_skeletons_async	Generates skeletons for a list of root ids without retrieving them.

Attributes:

Name	Type	Description
server_version	Optional[Version]	The version of the service running on the remote server. Note that this

server_version: Optional[Version] property

The version of the service running on the remote server. Note that this refers to the software running on the server and has nothing to do with the version of the datastack itself.

get_skeleton(root_id, datastack_name=None, skeleton_version=0, output_format='none', log_warning=True, verbose_level=0)

Gets basic skeleton information for a datastack

Parameters:

Name	Type	Description	Default
root_id	int	The root id of the skeleton to retrieve	required
datastack_name	str	The name of the datastack to check	None
skeleton_version	int	The skeleton version to generate and retrieve. Options are documented in SkeletonService. Use 0 for latest.	0
output_format	string	The format to retrieve. Options are: 'none': No return value (this can be used to generate a skeleton without retrieving it) 'precomputed': A cloudvolume.Skeleton object 'json': A dictionary 'jsoncompressed': A dictionary using compression for transmission (generally faster than 'json') 'arrays': A dictionary (literally a subset of the json response) 'arrayscompressed': A dictionary using compression for transmission (generally faster than 'arrays') 'swc': A pandas DataFrame 'h5': An BytesIO object containing bytes for an h5 file	'none'

Returns:

Type	Description
	Skeleton of the requested type. See output_format for details.

get_cache_contents(datastack_name=None, skeleton_version=0, root_id_prefixes=0, limit=0, log_warning=True)

Mirror CloudFiles.list() for skeletons as a pass-through interface to the underlying service and bucket.

skeletons_exist(datastack_name=None, skeleton_version=0, root_ids=0, log_warning=True)

Confirm or deny that a set of root ids have H5 skeletons in the cache.

get_bulk_skeletons(root_ids, datastack_name=None, skeleton_version=0, output_format='json', generate_missing_skeletons=False, log_warning=True, verbose_level=0)

Generates skeletons for a list of root ids without retrieving them.

Parameters:

Name	Type	Description	Default
root_ids	List	A list of root ids of the skeletons to generate	required
datastack_name	str	The name of the datastack to check	None
skeleton_version	int	The skeleton version to generate. Use 0 for latest.	0

generate_bulk_skeletons_async(root_ids, datastack_name=None, skeleton_version=0, log_warning=True, verbose_level=0)

Generates skeletons for a list of root ids without retrieving them.

Parameters:

Name	Type	Description	Default
root_ids	List	A list of root ids of the skeletons to generate	required
datastack_name	str	The name of the datastack to check	None
skeleton_version	int	The skeleton version to generate. Use 0 for latest.	0