abagen.mouse.get_structure_coordinates

abagen.mouse.get_structure_coordinates(id=None, acronym=None, name=None, reference_space='sagittal', verbose=False)[source]

Finds xyz coordinates of provided structure(s) in reference_space

Parameters:

  • id (int, optional) – Numerical structure ID

  • acronym (str, optional) – Short-form structure acronym (case sensitive)

  • name (str, optional) – Full structure name (case sensitive)

  • reference_space ({'sagittal', 'coronal'}, optional) – Reference space from which to extract coordinates. Default: ‘sagittal’

  • verbose (bool, optional) – Whether to print status messages. Default: False

Returns:

coords – With columns [‘structure_id’, ‘x’, ‘y’, ‘z’]

Return type:

pandas.DataFrame

Examples

Get the coordinates of structure 1018:

>>> from abagen import mouse
>>> mouse.get_structure_coordinates(id=1018)  
   structure_id     x     y     z
0          1018  7800  3400  1050