Skip to content

Commit 2658acd

Browse files
checked functionality. added example.
1 parent 1bdc40c commit 2658acd

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

src/aind_dynamic_foraging_basic_analysis/metrics/trial_metrics.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,12 @@ def get_average_signal_window(
273273
df_trial: pd.DataFrame
274274
DataFrame with a new column containing the mean signal
275275
in the specified window for each trial.
276+
277+
EXAMPLE
278+
*******************
279+
df_trials = get_average_signal_window(nwb, alignment_event='choice_time_in_session',
280+
offsets=[0.33,1],channel='G_0_dff-bright_mc-iso-IRLS',
281+
data_column='data_z_norm')
276282
"""
277283

278284
# Check alignment_event ends with 'in_session'

0 commit comments

Comments
 (0)