allensdk.core.ontology module

class allensdk.core.ontology.Ontology(**kwargs)

Bases: object

Note

Deprecated from 0.12.5 Ontology has been replaced by StructureTree.

get_child_ids(structure_ids)

Find the set of ids that are immediate children of one or more structures.

Parameters:

structure_ids: iterable

Any iterable type that contains structure ids that can be cast to integers.

Returns:

set

Set of child structure ids

get_children(structure_ids)

Find the set of structures that are immediate children of one or more structures.

Parameters:

structure_ids: iterable

Any iterable type that contains structure ids that can be cast to integers.

Returns:

pandas.DataFrame

Set of child structures

get_descendant_ids(structure_ids)

Find the set of the ids of structures that are descendants of one or more structures. The returned set will include the input structure ids.

Parameters:

structure_ids: iterable

Any iterable type that contains structure ids that can be cast to integers.

Returns:

set

Set of descendant structure ids.

get_descendants(structure_ids)

Find the set of structures that are descendants of one or more structures. The returned set will include the input structures.

Parameters:

structure_ids: iterable

Any iterable type that contains structure ids that can be cast to integers.

Returns:

pandas.DataFrame

Set of descendant structures.

structure_descends_from(child_id, parent_id)

Return whether one structure id is a descendant of another structure id.