siibra.core.concept

Parent class to siibra main concepts.

Module Contents

Classes

AtlasConcept

Parent class encapsulating commonalities of the basic siibra concept like atlas, parcellation, space, region.

Functions

get_registry(subclass_name)

Attributes

T

TypeDataset

class siibra.core.concept.AtlasConcept(identifier: str, name: str, species: str | siibra.commons.Species, shortname: str = None, description: str = None, modality: str = '', publications: List[siibra.commons.TypePublication] = [], datasets: List[TypeDataset] = [], spec=None)

Parent class encapsulating commonalities of the basic siibra concept like atlas, parcellation, space, region. These concepts have an id, name, and key, and they are bootstrapped from metadata stored in an online resources. Typically, they are linked with one or more datasets that can be retrieved from the same or another online resource, providing data files or additional metadata descriptions on request.

property LICENSE: str
property authors
property description
property id
property key
property publications: List[siibra.commons.TypePublication]
property species: siibra.commons.Species
property urls: List[str]

The list of URLs (including DOIs) associated with this atlas concept.

__gt__(other: AtlasConcept)

Compare this atlas concept with other atlas concepts of the same kind with it’s name.

classmethod __init_subclass__(configuration_folder: str = None)

This method is called whenever AtlasConcept gets subclassed (see https://docs.python.org/3/reference/datamodel.html)

__lt__(other: AtlasConcept)

Compare this atlas concept with other atlas concepts of the same kind with it’s name.

__repr__()

Return repr(self).

__str__()

Return str(self).

classmethod clear_registry()
classmethod get_instance(spec: str)
Parameters:

spec (str) – Specification of the class the instance is requested.

Returns:

  • an instance of this class matching the given specification from its

  • registry if possible, otherwise None.

Raises:

IndexError – If spec cannot match any instance

classmethod match(obj, spec) bool

Match a given object specification.

matches(spec) bool
Parameters:

spec (str) – Specification checked within the concept name, key or id

Returns:

Whether the given specification matches the name, key or id of the concept.

Return type:

bool

classmethod registry() siibra.commons.InstanceTable[T]
siibra.core.concept.get_registry(subclass_name: str)
siibra.core.concept.T
siibra.core.concept.TypeDataset