ripple.py
RippleLFPSelection
¶
Bases: SpyglassMixin
, Manual
Source code in src/spyglass/ripple/v1/ripple.py
validate_key(key)
staticmethod
¶
Validates that the filter_name is a ripple filter
set_lfp_electrodes(key, electrode_list=None, group_name='CA1', **kwargs)
staticmethod
¶
Removes all electrodes for the specified nwb file and then adds back the electrodes in the list
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
dict
|
dictionary corresponding to the LFPBand entry to use for ripple detection |
required |
electrode_list
|
list
|
list of electrodes from LFPBandSelection.LFPBandElectrode to be used as the ripple LFP during detection |
None
|
group_name
|
str
|
description of the electrode group, by default "CA1" |
'CA1'
|
Source code in src/spyglass/ripple/v1/ripple.py
RippleParameters
¶
Bases: SpyglassMixin
, Lookup
Source code in src/spyglass/ripple/v1/ripple.py
insert_default()
¶
Insert the default parameter set
Source code in src/spyglass/ripple/v1/ripple.py
RippleTimesV1
¶
Bases: SpyglassMixin
, Computed
Source code in src/spyglass/ripple/v1/ripple.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
|
make(key)
¶
Populate RippleTimesV1 table.
Fetches... - Nwb file name from LFPBandV1 - Parameters for ripple detection from RippleParameters - Ripple LFPs and position info from PositionOutput and LFPBandV1 Runs she specified ripple detection algorithm (Karlsson or Kay from ripple_detection package), inserts the results into the analysis nwb file, and inserts the key into the RippleTimesV1 table.
Source code in src/spyglass/ripple/v1/ripple.py
fetch1_dataframe()
¶
fetch_dataframe()
¶
Convenience function for returning all marks in a readable format
get_ripple_lfps_and_position_info(key)
staticmethod
¶
Return the ripple LFPs and position info for the specified key.
Fetches... - Ripple parameters from RippleParameters - Electrode keys from RippleLFPSelection - LFP data from LFPBandV1 - Position data from PositionOutput merge table Interpolates the position data to the LFP timestamps.
Source code in src/spyglass/ripple/v1/ripple.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
|
get_Kay_ripple_consensus_trace(ripple_filtered_lfps, sampling_frequency, smoothing_sigma=0.004)
staticmethod
¶
Calculate the consensus trace for the ripple filtered LFPs
Source code in src/spyglass/ripple/v1/ripple.py
plot_ripple_consensus_trace(ripple_consensus_trace, ripple_times, ripple_label=1, offset=0.1, relative=True, ax=None)
staticmethod
¶
Plot the consensus trace for a ripple event
Source code in src/spyglass/ripple/v1/ripple.py
plot_ripple(lfps, ripple_times, ripple_label=1, offset=0.1, relative=True, ax=None)
staticmethod
¶
Plot the LFPs for a ripple event
Source code in src/spyglass/ripple/v1/ripple.py
create_figurl(zscore_ripple=False, ripple_times_color='red', consensus_color='black', speed_color='black', view_height=800, use_ripple_filtered_lfps=False, lfp_offset=1, lfp_channel_ind=None)
¶
Generate a FigURL for the ripple detection
Source code in src/spyglass/ripple/v1/ripple.py
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
|
interpolate_to_new_time(df, new_time, upsampling_interpolation_method='linear')
¶
Upsample a dataframe to a new time index