fileLoader_base
Classes¤
fileLoader_base
¤
Bases: ABC
Abstract base class to derive file loaders.
For some working examples of derived classes, see fileLoader_abf and fileLoader_csv
To create a file loader
1) derive a class from fileLoader_base and define loadFileType
class myFileLoader(fileLoader_base):
loadFileType = 'the_file_extension_this_will_load'
2) Define a loadFile
function
def loadFile(self):
# load the data from self.filepath and create sweepX and sweepY
# specify what was loaded
self.setLoadedData(sweepX, sweepY)
Source code in sanpy/fileloaders/fileLoader_base.py
152 153 154 155 156 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 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
|
Attributes¤
currentSweep: int
property
¤
Get the current sweep.
filename: str
property
¤
Get the filename.
filepath: str
property
¤
Get the full file path.
filteredDeriv: Optional[np.ndarray]
property
¤
Get the filtered first derivative of sweepY.
numChannels: int
property
¤
Get the number of channels.
If more than one channel, must be defined in derived class.
numEpochs: Optional[int]
property
¤
Get the number of epochs.
Epochs are mostly for pClamp abf files. We are assuming each sweep has the same namber of epochs.
recordingFrequency: int
property
¤
Convenience for dataPointsPerMs, recording frequency in kHz.
sweepC
property
¤
Get the DAC command for the current sweep.
sweepX
property
¤
sweepY
property
¤
Get the Y values for the current sweep.
sweepY_filtered: np.ndarray
property
¤
Get a filtered version of sweepY.
Functions¤
__init__(filepath, loadData=True)
¤
Base class to derive new file loaders.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filepath |
str
|
File path to load. Will use different derived classes based on extension |
required |
loadData |
bool
|
If True then load raw data, otherwise just load the header. |
True
|
Source code in sanpy/fileloaders/fileLoader_base.py
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 |
|
__str__()
¤
Get a short string representing this file.
Source code in sanpy/fileloaders/fileLoader_base.py
233 234 235 236 |
|
getEpochTable(sweep)
¤
Only proper abf files will have an epoch table.
TODO: Make all file loders have an epoch table. Make API so derived file loaders can create their own
Source code in sanpy/fileloaders/fileLoader_base.py
524 525 526 527 528 529 530 531 532 533 |
|
loadFile()
abstractmethod
¤
Derived classes must load the data and call setLoadedData(sweepX, sweepY).
Source code in sanpy/fileloaders/fileLoader_base.py
184 185 186 187 |
|
ms2Pnt_(ms)
¤
Convert milliseconds (ms) to point in recording using self.dataPointsPerMs
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ms |
float
|
The ms into the recording |
required |
Returns:
Type | Description |
---|---|
int
|
The point in the recording corresponding to ms |
Source code in sanpy/fileloaders/fileLoader_base.py
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 |
|
pnt2Ms_(pnt)
¤
Convert a point to milliseconds (ms) using self.dataPointsPerMs
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pnt |
int
|
|
required |
Returns:
Type | Description |
---|---|
float
|
The point in milliseconds (ms) |
Source code in sanpy/fileloaders/fileLoader_base.py
491 492 493 494 495 496 497 498 499 500 501 502 503 504 |
|
pnt2Sec_(pnt)
¤
Convert a point to seconds using dataPointsPerMs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pnt |
int
|
|
required |
Returns:
Type | Description |
---|---|
float
|
The point in seconds (s) |
Source code in sanpy/fileloaders/fileLoader_base.py
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 |
|
setLoadedData(sweepX, sweepY, sweepC=None, recordingMode=recordingModes.iclamp, xLabel='', yLabel='')
¤
Derived classes call this function once the data is loaded in loadFile().
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sweepX |
ndarray
|
Time values |
required |
sweepY |
ndarray
|
Recording values, mV or pA |
required |
sweepC |
ndarray
|
(optional) DAC stimulus, pA or mV |
None
|
recordingMode |
recordingModes
|
(optional) Defaults to recordingModes.iclamp) |
iclamp
|
xLabel |
str
|
(optional) str for x-axis label |
''
|
yLabel |
str
|
(optional) str for y-axis label |
''
|
Notes¤
- Number of sweeps: sweepY.shape[1]
- Sweep Length (sec): sweepX[-1,0]
- Data Points Per Millisecond: 1 / ((sweepX[1,0] - sweepX[0,0]) * 1000)
Source code in sanpy/fileloaders/fileLoader_base.py
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
|
setSweep(currentSweep)
¤
Set the current sweep.
Source code in sanpy/fileloaders/fileLoader_base.py
283 284 285 286 287 288 |
|
recordingModes
¤
Bases: Enum
Recording modes for I-Clamp, V-Clamp, and unknown.
Source code in sanpy/fileloaders/fileLoader_base.py
143 144 145 146 147 148 149 |
|
Functions¤
getFileLoaders(verbose=False)
¤
Load file loaders from both
1) Module sanpy.fileloaders
2) Folder <user>/Documents/SanPy/File Loaders
Each file loader is a class derived from fileLoader_base
See: sanpy.interface.bPlugins.loadPlugins()
Returns:
Type | Description |
---|---|
dict
|
A dictionary of file loaders. |
Source code in sanpy/fileloaders/fileLoader_base.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
|