rmv_keys

nrv.ui.rmv_keys(results: axon_results, keys_to_remove: str | set[str] = {}, keys_to_keep: set[str] = {}) → axon_results[source]

remove most of the results key to save computing memory.

Note

Only the following keys kept by the fuction

  • ID

  • L

  • V_mem_raster_position

  • V_mem_raster_x_position

  • V_mem_raster_time_index

  • V_mem_raster_time

  • myelinated

  • intra_stim_starts

  • intra_stim_positions

Warning

This function removes a large amount of data from the results object. Some methods included in the results may not be used afterwards

Parameters:

  • results (axon_results) – results of the axon simulation.

  • keys_to_remove (str | list[str], optional) – key or set of key that should be removed, by default []

  • keys_to_keep (str | list[str], optional) – If None only keys_to_remove are removed. Otherwise, all key exept those in this list are deleted, by default None.

Returns:

updated results.

Return type:

axon_results