allensdk.api.queries.tree_search_api module

class allensdk.api.queries.tree_search_api.TreeSearchApi(base_uri=None)

Bases: Api

See Searching a Specimen or Structure Tree for additional documentation.

get_tree(kind, db_id, ancestors=None, descendants=None)

Fetch meta data for the specified structure or specimen.

Parameters:

kindstring

‘Structure’ or ‘Specimen’

db_idinteger

The id of the structure or specimen to search.

ancestorsboolean, optional

whether to include ancestors in the response (defaults to False)

descendantsboolean, optional

whether to include descendants in the response (defaults to False)

Returns:

dict

parsed json response data