pymaid.get_landmarks¶

pymaid.get_landmarks(with_locations=True, remote_instance=None) → Tuple[DataFrame, Optional[DataFrame]][source]¶

Get all landmarks from CATMAID, optionall with locations associated with them.

Parameters

with_locations (bool, optional) – Whether to also return a location table, by default True
remote_instance (pymaid.CatmaidInstance, optional) –

Returns

The first element is a DataFrame with columns landmark_id, name, user_id, project_id, creation_time, edition_time.

The second element is optionally a DataFrame with columns location_id, x, y, z, landmark_id.

Return type

2-tuple of (DataFrame, optional DataFrame)

Examples

>>> # Join the two tables to find all landmark locations
>>> landmarks, locations = pymaid.get_landmarks(True)
>>> combined = landmarks.merge(locations, on="landmark_id")