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=4, output_format='dict', 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 Neuroglancer-compatibility. Use -1 for latest. |
4
|
output_format
|
string
|
The format to retrieve. Options are: - 'dict': A dictionary - 'swc': A pandas DataFrame |
'dict'
|
Returns:
| Type | Description |
|---|---|
|
Skeleton of the requested type. See |
get_cache_contents(datastack_name=None, skeleton_version=3, 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=3, 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=4, output_format='dict', 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 Neuroglancer-compatibility. Use -1 for latest. |
4
|
generate_bulk_skeletons_async(root_ids, datastack_name=None, skeleton_version=None, 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 Neuroglancer-compatibility. Use -1 for latest. |
None
|
Returns:
| Type | Description |
|---|---|
float
|
The estimated time in seconds to generate all skeletons (a comparable message will be output to the console prior to return). |