pymaid.delete_nodes¶
- pymaid.delete_nodes(node_ids, node_type, no_prompt=False, remote_instance=None)[source]¶
Delete given nodes or connectors.
Due to the way CATMAID’s node deletion API works, this function is not suited for deleting directly linked nodes (e.g. A->B->C). For this to work, you will have to call this function in a for loop!
Danger
Use this with EXTREME caution as this is irreversible!
- Parameters
node_ids – Single or list of node or connector IDs. Must not be a mix of connectors and nodes.
node_type ('NODE' | 'CONNECTOR') – Set which type of node you want to delete as they use different API endpoints!
no_prompt (bool, optional) – By default, you will be prompted to confirm before deleting the node(s). Set this to True to skip that step.
remote_instance (CatmaidInstance, optional) – If not passed directly, will try using global.
- Return type
server response
See also
delete_neuron()
Use to delete entire neurons.
update_nodes()
Use to move neurons