find_rid_by_tid

DatabaseGTDB.find_rid_by_tid(ids=None, subs=False, iterator=False, flatten=False, mode='frame')

Get rids by target tids.

Parameters

  • ids (Optional[Union[Sequence[Union[str, int]], numpy.ndarray, pandas.core.indexes.base.Index, str, int]]) – Target tids for which retrieve sub-tids

  • subs (bool) – Whether to include subs

  • iterator (bool) – Whether to return data in chunks as iterator.

  • flatten (bool) – Whether to flatten results into single array.

  • mode (str) – Retrieve data as ‘array’, ‘frame’ or ‘dict’(default)

Returns

Return type

Return rids with type depending on input parameters.