siibra.core.concept

Parent class to siibra main concepts.

Attributes

T
TypeDataset

Classes

AtlasConcept

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

Module Contents

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, prerelease: bool = False)

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.

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)

Match a given object specification.

matches(spec)

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]

property LICENSE: str

property authors

datasets = []

property description

property doi_or_url: str

property id

property key

modality = ''

name

property publications: List[siibra.commons.TypePublication]

shortname = None

property species: siibra.commons.Species

siibra.core.concept.T

siibra.core.concept.TypeDataset