EpochUnraveller¶

class managers.operatorsReadNWB.epoch_unraveller.EpochUnraveller¶

Available methods:

Method name	Method type
`total_overall_epochs()`	static method
`pluck_epoch_row()`	static method
`pluck_start_time()`	static method
`pluck_stop_time()`	static method
`total_epochs_this_region()`	static method
`pluck_epoch_id()`	static method
`pluck_region()`	static method
`pluck_modelname()`	static method
`pluck_modelscale()`	static method
`pluck_timeseries_object()`	static method
`pull_all_epochs_for_region()`	class method
`pull_indices_tseries_for_epoch()`	class method

static pluck_epoch_id(an_epoch)¶

Returns epoch id for the region in the given epoch.

NOTE:

for a given region, total number of these id’s of all the epochs from this regions is equal to those returned from pluck_total_epochs_this_region().
this is extracted from the epoch_tags
see :refer:EpochGenerator for how the epoch_tags were generated.

static pluck_epoch_row(nwbfile, row_i)¶: Returns an epoch by extracting it from NWBFile and the given row number (starting from 0). The nwbfile.epochs is a VectorData.

static pluck_modelname(an_epoch)¶: Returns model name for which this epoch is associated with.

static pluck_modelscale(an_epoch)¶: Returns name of the model scale for which this epoch is associated with.

static pluck_region(an_epoch)¶: Returns region name for which this epoch is associated with.

static pluck_start_time(an_epoch)¶: Returns the start_time in seconds for the given epoch.

static pluck_stop_time(an_epoch)¶: Returns the stop_time in seconds for the given epoch.

static pluck_timeseries_object(an_epoch)¶: Returns the given epoch’s TimeSeries object.

classmethod pull_all_epochs_for_region(nwbfile=None, region=None)¶

Returns a list of all epochs for a particular region from NWBFile

Keyword Arguments:

Key	Value type
`nwbfile`	NWBFile
`region`	string representing name of the regions from which response was recorded

classmethod pull_indices_tseries_for_epoch(an_epoch)¶: Returns list of indices of the timestamps from the given time-series that is between start_time and stop_time in an epoch.

static total_epochs_this_region(an_epoch)¶

Returns total epochs available for the region in the given epoch.

NOTE:

static total_overall_epochs(nwbfile)¶

Return the total number of available epochs.

NOTE: This is different from total_epochs_this_region().