TerminologyInfo

class brainglobe_atlasapi.atlas_generation.atlas_packaging_data.TerminologyInfo(name: str, version: str, use_existing: bool = False, update_existing: bool = False, existing_version: str | None = None, existing_stub: str | None = None, stub: str | None = None, metadata: dict = <factory>, *, root_dir: str = 'terminologies', file_name: str = 'terminology.csv')

Bases: ComponentInfo

Container for the terminology component of a BrainGlobe atlas.

This dataclass holds information about a terminology component of a BrainGlobe atlas. It inherits from ComponentInfo and specifies the root directory and file name for terminology components.

root_dir

The root directory for terminology components (default is descriptors.V2_TERMINOLOGY_ROOTDIR).

Type:

str, optional

file_name

The name of the terminology component file (default is descriptors.V2_TERMINOLOGY_NAME).

Type:

str, optional

Methods

generate_metadata_dict()

Generate a dictionary containing metadata for this component.

Attributes

existing_stub
existing_version
file_name
root_dir
stub
update_existing
use_existing
name
version
metadata

generate_metadata_dict() → Dict[str, str]

Generate a dictionary containing metadata for this component.

The metadata dictionary includes the component’s name, version, and location stub.

Returns:

A dictionary containing the component metadata.

Return type:

Dict[str, str]