pymaid.eval_skids

pymaid.eval_skids(x, remote_instance=None, warn_duplicates=True)[source]

Extract skeleton IDs from input.

Will turn annotations and neuron names into skeleton IDs.

Parameters
  • x (int | str | CatmaidNeuron | CatmaidNeuronList | DataFrame) –

    Your options are either::
    1. int or list of ints:
      • will be assumed to be skeleton IDs

    2. str or list of str:
      • if convertible to int, will be interpreted as x

      • if starts with ‘annotation:’ will be assumed to be annotations

      • else will be assumed to be neuron names

    3. For CatmaidNeuron/List or pandas.DataFrames/Series:
      • will look for skeleton_id attribute

  • remote_instance (CatmaidInstance, optional) – If not passed directly, will try using global.

  • warn_duplicates (bool, optional) – If True, will warn if duplicate skeleton IDs are found. Only applies to CatmaidNeuronLists.

Returns

List containing skeleton IDs as strings.

Return type

list