axon_results

class nrv.nmod.results.axon_results(context=None)

Attributes

axon_results.is_dummy
axon_results.is_empty
axon_results.to_save

Methods

axon_results.APs_in_timeframe([vm_key])	Return true if ALL APs have reached their last position (in both direction) within the simulation timeframe, else False
axon_results.APs_reached_end([vm_key])	Return true if ALL APs have reached the both ends of the axon
axon_results.__init__([context])	Init method for NRV_class
axon_results.block([position_key, t_start, ...])	check if an axon is blocked or not.
axon_results.block_summary(AP_start[, freq, ...])	Return axon block characteristics: blocked, onset response, number of APs)
axon_results.check_test_AP()	Check if a test AP is correctely triggered during an axon simulation and if so return the trigger time
axon_results.clear()
axon_results.colormap_plot(axes[, key])
axon_results.compute_f_mem()	compute the cutoff frequency of the axon's membrane and add it to the simulation self dictionnary NB: The frequency is computed in [kHz]
axon_results.copy()
axon_results.count_APs([vm_key])	Count number of APs detected in vm_key
axon_results.detect_AP_collisions([vm_key])	Return True is at least one collision between two APs is detected, else False
axon_results.detect_start_extrastim([threshold])	Returns the starting time of extracellular stimulation from axon simulation results
axon_results.extra_stim_properties()	Return elect caracteristics (blocked, Onset response, ...)
axon_results.filter_freq(my_key, freq[, Q])	Basic Filtering of quantities.
axon_results.fromkeys([value])	Create a new dictionary with keys from iterable and values set to value.
axon_results.generate_axon()	generate from the results new version of the simulated axon.
axon_results.get(key[, default])	Return the value for key if key is in the dictionary, else default.
axon_results.getAPspeed([vm_key])	Return the propagtion speed of each APs, in m/s
axon_results.get_1dpoly_intersec(poly1, poly2)	Returns the intersection points of two 1D poly
axon_results.get_AP_downward_len(x_AP, t_AP)	Returns the length (number of x pts) of the AP in the downward direction
axon_results.get_AP_upward_len(x_AP, t_AP)	Returns the length (number of x pts) of the AP in the upward direction
axon_results.get_avg_AP_speed([vm_key])	Returns the averaged propagtion speed of each APs, in m/s.
axon_results.get_axon_xrec()	Return the x-position recorded array
axon_results.get_collision_pts([vm_key])	Returns three lists: - two containing the x,t coordinates of the interAPs colliding coordinates
axon_results.get_interAPs_collision(x_AP1, ...)	Returns the estimated collision coordinates of two APs.
axon_results.get_membrane_capacitance([...])	get the axon membrane capacitance or permitivity
axon_results.get_membrane_complexe_admitance([...])	get the membran complexe admitance of each axon at a position x and a time t for a given frequency
axon_results.get_membrane_conductivity([x, ...])	get the membrane conductivity at a position x and a time t
axon_results.get_membrane_material([t, ...])
axon_results.get_parameters()	Generic method returning all the atributes of an NRV_class instance
axon_results.get_start_AP(x_AP, t_AP)	Returns the x,t start values of the AP
axon_results.get_start_APs([vm_key])	Return list of (x,t) start positions of each detected APs
axon_results.get_xmax_AP(x_AP, t_AP)	Returns the x,t values the maximum AP x-position
axon_results.get_xmin_AP(x_AP, t_AP)	Returns the x,t values the minimum AP x-position
axon_results.has_AP_reached_end(x_AP, t_AP)	Return true if the AP has reached the end of the axon in both direction, else false
axon_results.is_AP_in_timeframe(x_AP, t_AP)	Return true if AP has reached it's last position (in both direction) within the simulation timeframe, else False
axon_results.is_blocked(AP_start[, freq, ...])	check if the axon is blocked or not.
axon_results.is_recruited([vm_key, t_start])	Return True if an AP is detected, else False.
axon_results.items()
axon_results.keys()
axon_results.linfit_AP(x_AP, t_AP)	Fit the AP with two 1D polynomial equations: one for the upward propagation, one for the downward propagation
axon_results.load(data[, blacklist])	Generic loading method for NRV_class instance
axon_results.plot_stim([IDs, t_stop, N_pts, ax])	Plot one or several stimulis of the simulation extra-cellular context
axon_results.pop(k[,d])	If the key is not found, return the default if given; otherwise, raise a KeyError.
axon_results.popitem()	Remove and return a (key, value) pair as a 2-tuple.
axon_results.raster_plot(axes[, key])
axon_results.rasterize([vm_key, clear_artifacts])	Rasterize a membrane potential (or filtered or any quantity processed from membrane voltage), with AP detection.
axon_results.remove_key([keys_to_remove, ...])	Remove a key or a list of keys from the results
axon_results.remove_raster_artifacts([vm_key])	Remove artifacts (non-APs) rasterized points.
axon_results.save([save, fname, blacklist])	Generic saving method for NRV_class instance.
axon_results.set_parameters(**kawrgs)	Generic method to set any attribute of NRV_class instance
axon_results.setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
axon_results.speed([position_key, t_start, ...])	Compute the velocity of a spike from rasterized data in a dictionary.
axon_results.split_APs([vm_key])	Detects individual Action potential in vm_key and split them in lists
axon_results.update(_NRV_results__m, **kwargs)	overload of dict update method to update both attibute and items
axon_results.values()