CoordinateSpaceInfo#

class brainglobe_atlasapi.atlas_generation.atlas_packaging_data.CoordinateSpaceInfo(name, version, use_existing=False, update_existing=False, existing_version=None, existing_stub=None, stub=None, metadata=<factory>, *, root_dir='coordinate-spaces', file_name='manifest.json', template)[source]#

Bases: ComponentInfo

Container for information about a coordinate space component of a BrainGlobe atlas.

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

Overrides the __post_init__ method to include template metadata in the coordinate space metadata.

template#

The TemplateInfo object associated with this coordinate space.

Type:: TemplateInfo

root_dir#

The root directory for coordinate space components (default is descriptors.V3_COORDINATE_SPACE_ROOTDIR).

Type:: str, optional

file_name#

The name of the coordinate space component file (default is “manifest.json”).

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`
`template`
`name`
`version`
`metadata`

generate_metadata_dict()#

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]