bluepyemodel.evaluation.utils

Utility module for evaluation.

Functions

add_dendritic_recordings(recordings, ...[, ...])

Add dendritic recordings to recordings list.

define_EPSP_feature([dend_type, rec_loc, ...])

Utility function to create a ready-to-use dendrite EPSP fit feature

define_EPSP_protocol(dend_type[, ...])

Returns ready-to-use EPSP protocols at multiple locations along the dendrite.

define_bAP_feature([dend_type, dist_start, ...])

Utility function to create a ready-to-use dendrite backpropagation fit feature

define_bAP_protocol([dist_start, dist_end, ...])

Utility function to create a ready-to-use bAP protocol.
add_dendritic_recordings(recordings, prot_name, dend_type, dist_start=10, dist_end=600, dist_step=10)

Add dendritic recordings to recordings list.

Parameters:

  • recordings (list) – variable to be updated with new recordings

  • prot_name (str) – protocol name

  • dend_type (str) – On which dendrite should the recording be. Can be ‘apical’ or ‘basal’

  • dist_start (int) – closest distance on the dendrite on which to record

  • dist_end (int) – furthest distance on the dendrite on which to record

  • dist_step (int) – record every dist_step distance on the dendrite

define_EPSP_feature(dend_type='apical', rec_loc='dend', dist_start=100, dist_end=600, dist_step=100)

Utility function to create a ready-to-use dendrite EPSP fit feature

Parameters:

  • dend_type (str) – Which dendrite data should the feature compute. Can be ‘apical’ or ‘basal’

  • rec_loc (str) – where should data be recorded from. Can be either ‘dend’ or ‘soma’

  • dist_start (int) – closest distance on the dendrite on which to record

  • dist_end (int) – furthest distance on the dendrite on which to record

  • dist_step (int) – record every dist_step distance on the dendrite

Attention! This is just used for plotting function, BPEM cannot currently handle EPSP attenuation fit feature on its own

define_EPSP_protocol(dend_type, dist_start=100, dist_end=600, dist_step=100)

Returns ready-to-use EPSP protocols at multiple locations along the dendrite.

Parameters:

  • dend_type (str) – Which dendrite data should the feature compute. Can be ‘apical’ or ‘basal’

  • dist_start (int) – closest distance on the dendrite on which to record

  • dist_end (int) – furthest distance on the dendrite on which to record

  • dist_step (int) – record every dist_step distance on the dendrite

define_bAP_feature(dend_type='apical', dist_start=10, dist_end=600, dist_step=10)

Utility function to create a ready-to-use dendrite backpropagation fit feature

Parameters:

  • dend_type (str) – Which dendrite data should the feature compute. Can be ‘apical’ or ‘basal’

  • dist_start (int) – closest distance on the dendrite on which to record

  • dist_end (int) – furthest distance on the dendrite on which to record

  • dist_step (int) – record every dist_step distance on the dendrite

define_bAP_protocol(dist_start=10, dist_end=600, dist_step=10, dist_end_basal=150)

Utility function to create a ready-to-use bAP protocol.

Parameters:

  • dist_start (int) – closest distance on the dendrites on which to record

  • dist_end (int) – furthest distance on the apical dendrite on which to record

  • dist_step (int) – record every dist_step distance on the dendrites

  • dist_end_basal (int) – furthest distance on the basal dendrite on which to record