Skip to content

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
class fileLoader_base(ABC):
    """Abstract base class to derive file loaders.

    For some working examples of derived classes, see
    [fileLoader_abf](../../api/fileloader/fileLoader_abf.md) and
    [fileLoader_csv](../../api/fileloader/fileLoader_csv.md)

    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)

    """

    loadFileType: str = ""
    # @property
    # @abstractmethod
    # def loadFileType(self) -> str:
    #     """Derived classes must return the file type to handle.
    #     For example, 'csv', or 'm', or 'dat'
    #     """
    #     pass

    @abstractmethod
    def loadFile(self):
        """Derived classes must load the data and call setLoadedData(sweepX, sweepY)."""
        pass

    def __init__(self, filepath: str, loadData: bool = True):
        """Base class to derive new file loaders.

        Parameters
        ----------
        filepath : str
            File path to load. Will use different derived classes based on extension
        loadData : bool
            If True then load raw data, otherwise just load the header.
        """

        super().__init__()

        logger.info(filepath)

        self._loadError = False

        self._path = filepath

        self._metaData = sanpy.metaData.MetaData()  # per file metadata

        self._filteredY : np.ndarray = None  # set in _getDerivative
        self._filteredDeriv : np.ndarray = None
        self._currentSweep: int = 0

        self._epochTableList: List[sanpy.fileloaders.epochTable] = None

        self._sweepX = None
        self._sweepY = None
        self._sweepC = None
        self._numSweeps = None
        self._sweepList = None
        self._sweepLengthSec = None
        self._dataPointsPerMs = None
        self._recordingMode = recordingModes.unknown
        self._sweepLabelX = None
        self._sweepLabelY = None

        # load file from inherited class
        self.loadFile()

        # check our work
        self._checkLoadedData()

    def __str__(self):
        """Get a short string representing this file."""
        txt = f"file: {self.filename} sweeps: {self.numSweeps} dur (Sec):{self.recordingDur}"
        return txt

    @property
    def metadata(self):
        return self._metaData

    def setAcqDate(self, value):
        self.metadata.setMetaData('Acq Date', value, triggerDirty=False)

    def setAcqTime(self, value):
        self.metadata.setMetaData('Acq Time', value, triggerDirty=False)

    def getLoadError(self) -> bool:
        return self._loadError

    def setLoadError(self, value : bool):
        self._loadError = value

    def isKymograph(self) -> bool:
        return isinstance(self, sanpy.fileloaders.fileLoader_tif)

    @property
    def filepath(self) -> str:
        """Get the full file path."""
        return self._path

    @property
    def filename(self) -> str:
        """Get the filename."""
        if self.filepath is None:
            return None
        else:
            return os.path.split(self.filepath)[1]

    @property
    def numChannels(self) -> int:
        """Get the number of channels.

        If more than one channel, must be defined in derived class.
        """
        return 1

    @property
    def currentSweep(self) -> int:
        """Get the current sweep."""
        return self._currentSweep

    def setSweep(self, currentSweep: int):
        """Set the current sweep."""
        if currentSweep > self.numSweeps - 1:
            logger.error(f"max sweep is {self.numSweeps-1}, got {currentSweep}")
            return
        self._currentSweep = currentSweep

    @property
    def recordingMode(self):
        return self._recordingMode

    # feb 2023, uncommented
    @property
    def sweepLabelX(self):
        return self._sweepLabelX

    @property
    def sweepLabelY(self):
        return self._sweepLabelY

    @property
    def recordingDur(self):
        return self._sweepLengthSec

    @property
    def numSweeps(self):
        return len(self._sweepList)

    @property
    def sweepList(self):
        return self._sweepList

    @property
    def dataPointsPerMs(self):
        return self._dataPointsPerMs

    @property
    def acqDate(self):
        return self._acqDate

    @property
    def acqTime(self):
        return self._acqTime

    @property
    def sweepX(self):
        """Get the X-Values for a sweep.

        Notes
        -----
        All sweeps are assumed to have the same x-values (seconds).
        """
        # return self._sweepX[:, self.currentSweep]
        return self._sweepX[:, 0]

    @property
    def sweepY(self):
        """Get the Y values for the current sweep."""
        return self._sweepY[:, self.currentSweep]

    @property
    def sweepC(self):
        """Get the DAC command for the current sweep."""
        if self._sweepC is None:
            # return np.zeros_like(self._sweepX[:, self.currentSweep])
            return np.zeros_like(self._sweepX[:, 0])
        return self._sweepC[:, self.currentSweep]

    def get_xUnits(self):
        return self._sweepLabelX

    def get_yUnits(self):
        return self._sweepLabelY

    @property
    def filteredDeriv(self) -> Optional[np.ndarray]:
        """Get the filtered first derivative of sweepY."""
        if self._filteredDeriv is not None:
            return self._filteredDeriv[:, self.currentSweep]
        else:
            return None

    def _getDerivative(
        self,
        medianFilter: int = 0,
        SavitzkyGolay_pnts: int = 5,
        SavitzkyGolay_poly: int = 2,
    ):
        """Get filtered version of recording and derivative of recording (used for I-Clamp).

            By default we will use a SavitzkyGolay filter with 5 points and a 2nd order polynomial.

        Parameters
        ----------
        medianFilter : int
            Median filter box with. Must be odd, specify 0 for no median filter
        SavitzkyGolay_pnts : int
            Specify 0 for no filter.
        SavitzkyGolay_poly : int

        Notes
        -----
        Creates:
            self._filteredVm
            self._filteredDeriv
        """

        # logger.info(f'{self.filename} medianFilter:{medianFilter} SavitzkyGolay_pnts:{SavitzkyGolay_pnts} SavitzkyGolay_poly:{SavitzkyGolay_poly}')

        if not isinstance(medianFilter, int):
            logger.error(f"expecting int medianFilter, got: {medianFilter}")

        if medianFilter > 0:
            if not medianFilter % 2:
                medianFilter += 1
                logger.warning(
                    "Please use an odd value for the median filter, set medianFilter: {medianFilter}"
                )
            medianFilter = int(medianFilter)
            self._filteredY = scipy.signal.medfilt2d(self._sweepY, [medianFilter, 1])
        elif SavitzkyGolay_pnts > 0:
            self._filteredY = scipy.signal.savgol_filter(
                self._sweepY,
                SavitzkyGolay_pnts,
                SavitzkyGolay_poly,
                axis=0,
                mode="nearest",
            )
        else:
            self._filteredY = self.sweepY

        self._filteredDeriv = np.diff(self._filteredY, axis=0)

        # filter the derivative
        if medianFilter > 0:
            if not medianFilter % 2:
                medianFilter += 1
                print(
                    f"Please use an odd value for the median filter, set medianFilter: {medianFilter}"
                )
            medianFilter = int(medianFilter)
            self._filteredDeriv = scipy.signal.medfilt2d(
                self._filteredDeriv, [medianFilter, 1]
            )
        elif SavitzkyGolay_pnts > 0:
            self._filteredDeriv = scipy.signal.savgol_filter(
                self._filteredDeriv,
                SavitzkyGolay_pnts,
                SavitzkyGolay_poly,
                axis=0,
                mode="nearest",
            )
        else:
            # self._filteredDeriv = self.filteredDeriv
            pass

        # mV/ms
        dataPointsPerMs = self.dataPointsPerMs
        self._filteredDeriv = self._filteredDeriv * dataPointsPerMs  # / 1000

        # insert an initial point (rw) so it is the same length as raw data in abf.sweepY
        # three options (concatenate, insert, vstack), could only get vstack working
        rowOfZeros = np.zeros(self.numSweeps)

        # logger.info(f' dataPointsPerMs:{dataPointsPerMs}')
        # logger.info(f' self.numSweeps:{self.numSweeps}')
        # logger.info(f' rowOfZeros:{rowOfZeros.shape}')
        # logger.info(f' 1 - _filteredDeriv:{self._filteredDeriv.shape}')

        # rowZero = 0
        self._filteredDeriv = np.vstack([rowOfZeros, self._filteredDeriv])

        # logger.info(f'  sweepX:{self.sweepX.shape}')
        # logger.info(f'  sweepY:{self.sweepY.shape}')
        # logger.info(f'  _filteredY:{self._filteredY.shape}')
        # logger.info(f'  2- _filteredDeriv:{self._filteredDeriv.shape}')

        return self._filteredDeriv

    @property
    def sweepY_filtered(self) -> np.ndarray:
        """Get a filtered version of sweepY."""
        if self._filteredY is not None:
            return self._filteredY[:, self.currentSweep]

    @property
    def recordingFrequency(self) -> int:
        """Convenience for dataPointsPerMs, recording frequency in kHz."""
        return self.dataPointsPerMs

    def pnt2Sec_(self, pnt: int) -> float:
        """Convert a point to seconds using dataPointsPerMs.

        Parameters
        ----------
        pnt : int

        Returns
        -------
        float
            The point in seconds (s)
        """
        if pnt is None:
            # return math.isnan(pnt)
            return math.nan
        else:
            return pnt / self.dataPointsPerMs / 1000

    def pnt2Ms_(self, pnt: int) -> float:
        """
        Convert a point to milliseconds (ms) using `self.dataPointsPerMs`

        Parameters
        ----------
        pnt : int

        Returns
        -------
        float
            The point in milliseconds (ms)
        """
        return pnt / self.dataPointsPerMs

    def ms2Pnt_(self, ms: float) -> int:
        """
        Convert milliseconds (ms) to point in recording using `self.dataPointsPerMs`

        Parameters
        ----------
        ms : float
            The ms into the recording

        Returns
        -------
        int
            The point in the recording corresponding to ms
        """
        theRet = ms * self.dataPointsPerMs
        theRet = int(round(theRet))
        return theRet

    def getEpochTable(self, sweep: int):
        """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
        """
        if self._epochTableList is not None:
            return self._epochTableList[sweep]
        else:
            return None

    @property
    def numEpochs(self) -> Optional[int]:
        """Get the number of epochs.

        Epochs are mostly for pClamp abf files. We are assuming each sweep has the same namber of epochs.
        """
        if self._epochTableList is not None:
            return self._epochTableList[0].numEpochs()

    def _checkLoadedData(self):
        # TODO: check all the member vraiables are correct
        # set error if they are not
        pass

    def setLoadedData(
        self,
        sweepX: np.ndarray,
        sweepY: np.ndarray,
        sweepC: Optional[np.ndarray] = None,
        recordingMode: recordingModes = recordingModes.iclamp,
        xLabel: str = "",
        yLabel: str = "",
    ):
        """Derived classes call this function once the data is loaded in loadFile().

        Parameters
        ----------
        sweepX : np.ndarray
            Time values
        sweepY : np.ndarray
            Recording values, mV or pA
        sweepC : np.ndarray
            (optional) DAC stimulus, pA or mV
        recordingMode : recordingModes
            (optional) Defaults to recordingModes.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)
        """
        self._sweepX = sweepX
        self._sweepY = sweepY
        self._sweepC = sweepC

        self._numSweeps: int = self._sweepY.shape[1]
        self._sweepList: List[int] = list(range(self._numSweeps))

        self._sweepLengthSec: float = self._sweepX[-1, 0]  # from 0 to last sample point

        dtSeconds = self._sweepX[1, 0] - self._sweepX[0, 0]  # seconds per sample
        dtSeconds = float(dtSeconds)
        dtMilliseconds = dtSeconds * 1000
        # july 2023 paula
        # _dataPointsPerMs = int(1 / dtMilliseconds)
        _dataPointsPerMs = 1 / dtMilliseconds

        if _dataPointsPerMs == 0:
            logger.error(f'_dataPointsPerMs is zero!')
            logger.error(f'  dtSeconds:{dtSeconds}')
            logger.error(f'  dtMilliseconds:{dtMilliseconds}')
            logger.error(f'  _dataPointsPerMs = int(1 / dtMilliseconds)')

        self._dataPointsPerMs: int = _dataPointsPerMs

        self._recordingMode: recordingModes = recordingMode
        self._sweepLabelX: str = xLabel
        self._sweepLabelY: str = yLabel

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 ¤

Get the X-Values for a sweep.

Notes¤

All sweeps are assumed to have the same x-values (seconds).

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
def __init__(self, filepath: str, loadData: bool = True):
    """Base class to derive new file loaders.

    Parameters
    ----------
    filepath : str
        File path to load. Will use different derived classes based on extension
    loadData : bool
        If True then load raw data, otherwise just load the header.
    """

    super().__init__()

    logger.info(filepath)

    self._loadError = False

    self._path = filepath

    self._metaData = sanpy.metaData.MetaData()  # per file metadata

    self._filteredY : np.ndarray = None  # set in _getDerivative
    self._filteredDeriv : np.ndarray = None
    self._currentSweep: int = 0

    self._epochTableList: List[sanpy.fileloaders.epochTable] = None

    self._sweepX = None
    self._sweepY = None
    self._sweepC = None
    self._numSweeps = None
    self._sweepList = None
    self._sweepLengthSec = None
    self._dataPointsPerMs = None
    self._recordingMode = recordingModes.unknown
    self._sweepLabelX = None
    self._sweepLabelY = None

    # load file from inherited class
    self.loadFile()

    # check our work
    self._checkLoadedData()
__str__() ¤

Get a short string representing this file.

Source code in sanpy/fileloaders/fileLoader_base.py
233
234
235
236
def __str__(self):
    """Get a short string representing this file."""
    txt = f"file: {self.filename} sweeps: {self.numSweeps} dur (Sec):{self.recordingDur}"
    return txt
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
def getEpochTable(self, sweep: int):
    """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
    """
    if self._epochTableList is not None:
        return self._epochTableList[sweep]
    else:
        return None
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
@abstractmethod
def loadFile(self):
    """Derived classes must load the data and call setLoadedData(sweepX, sweepY)."""
    pass
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
def ms2Pnt_(self, ms: float) -> int:
    """
    Convert milliseconds (ms) to point in recording using `self.dataPointsPerMs`

    Parameters
    ----------
    ms : float
        The ms into the recording

    Returns
    -------
    int
        The point in the recording corresponding to ms
    """
    theRet = ms * self.dataPointsPerMs
    theRet = int(round(theRet))
    return theRet
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
def pnt2Ms_(self, pnt: int) -> float:
    """
    Convert a point to milliseconds (ms) using `self.dataPointsPerMs`

    Parameters
    ----------
    pnt : int

    Returns
    -------
    float
        The point in milliseconds (ms)
    """
    return pnt / self.dataPointsPerMs
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
def pnt2Sec_(self, pnt: int) -> float:
    """Convert a point to seconds using dataPointsPerMs.

    Parameters
    ----------
    pnt : int

    Returns
    -------
    float
        The point in seconds (s)
    """
    if pnt is None:
        # return math.isnan(pnt)
        return math.nan
    else:
        return pnt / self.dataPointsPerMs / 1000
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
def setLoadedData(
    self,
    sweepX: np.ndarray,
    sweepY: np.ndarray,
    sweepC: Optional[np.ndarray] = None,
    recordingMode: recordingModes = recordingModes.iclamp,
    xLabel: str = "",
    yLabel: str = "",
):
    """Derived classes call this function once the data is loaded in loadFile().

    Parameters
    ----------
    sweepX : np.ndarray
        Time values
    sweepY : np.ndarray
        Recording values, mV or pA
    sweepC : np.ndarray
        (optional) DAC stimulus, pA or mV
    recordingMode : recordingModes
        (optional) Defaults to recordingModes.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)
    """
    self._sweepX = sweepX
    self._sweepY = sweepY
    self._sweepC = sweepC

    self._numSweeps: int = self._sweepY.shape[1]
    self._sweepList: List[int] = list(range(self._numSweeps))

    self._sweepLengthSec: float = self._sweepX[-1, 0]  # from 0 to last sample point

    dtSeconds = self._sweepX[1, 0] - self._sweepX[0, 0]  # seconds per sample
    dtSeconds = float(dtSeconds)
    dtMilliseconds = dtSeconds * 1000
    # july 2023 paula
    # _dataPointsPerMs = int(1 / dtMilliseconds)
    _dataPointsPerMs = 1 / dtMilliseconds

    if _dataPointsPerMs == 0:
        logger.error(f'_dataPointsPerMs is zero!')
        logger.error(f'  dtSeconds:{dtSeconds}')
        logger.error(f'  dtMilliseconds:{dtMilliseconds}')
        logger.error(f'  _dataPointsPerMs = int(1 / dtMilliseconds)')

    self._dataPointsPerMs: int = _dataPointsPerMs

    self._recordingMode: recordingModes = recordingMode
    self._sweepLabelX: str = xLabel
    self._sweepLabelY: str = yLabel
setSweep(currentSweep) ¤

Set the current sweep.

Source code in sanpy/fileloaders/fileLoader_base.py
283
284
285
286
287
288
def setSweep(self, currentSweep: int):
    """Set the current sweep."""
    if currentSweep > self.numSweeps - 1:
        logger.error(f"max sweep is {self.numSweeps-1}, got {currentSweep}")
        return
    self._currentSweep = currentSweep

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
class recordingModes(enum.Enum):
    """Recording modes for I-Clamp, V-Clamp, and unknown."""

    iclamp = "I-Clamp"
    vclamp = "V-Clamp"
    kymograph = "Kymograph"
    unknown = "unknown"

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
def getFileLoaders(verbose: bool = False) -> dict:
    """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](../../api/fileloader/fileLoader_base.md)

    See: sanpy.interface.bPlugins.loadPlugins()

    Returns
    -------
    dict
        A dictionary of file loaders.
    """
    retDict = {}

    ignoreModuleList = ["fileLoader_base", "recordingModes", "epochTable", "hekaUtils"]

    if not sanpy.DO_KYMOGRAPH_ANALYSIS:
        ignoreModuleList.append('fileLoader_tif')
    #
    # system file loaders from sanpy.fileloaders
    loadedList = []
    for moduleName, obj in inspect.getmembers(sanpy.fileloaders):
        if inspect.isclass(obj):
            # if verbose:
            #     logger.info(f"moduleName:{moduleName}")
            if moduleName in ignoreModuleList:
                # if verbose:
                #     logger.info(f'IGNORING {moduleName}')
                continue
            loadedList.append(moduleName)
            fullModuleName = "sanpy.fileloaders." + moduleName
            # filetype is a static str, e.g. the extension to load
            try:
                filetype = obj.loadFileType
            except AttributeError as e:
                logger.warning(f'Did not load "{moduleName}", no "filetype" attribute')
                continue
            oneLoaderDict = {
                "fileLoaderClass": moduleName,
                "type": "system",
                "module": fullModuleName,
                "path": "",
                "constructor": obj,
                #'filetype': filetype
            }
            if filetype in retDict.keys():
                logger.warning(
                    f'loader already added "{moduleName}" filetype:"{filetype}"'
                )
                logger.warning(f"  this loader will overwrite the previous loader.")
            retDict[filetype] = oneLoaderDict

    # logger.info(f'Loaded system file loaders:')
    # for k,v in retDict.keys():
    #     logger.info(f'    {k}:{v}')
    # # sort
    # retDict = dict(sorted(retDict.items()))

    #
    # user plugins from files in folder "<user>/SanPy/file loaders"
    fileLoaderFolder = sanpy._util._getUserFileLoaderFolder()
    # loadedModuleList = []
    if os.path.isdir(fileLoaderFolder):
        files = glob.glob(os.path.join(fileLoaderFolder, "*.py"))
    else:
        # no user file loader folder ???
        files = []

    for file in files:
        if file.endswith("__init__.py"):
            continue

        moduleName = os.path.split(file)[1]
        moduleName = os.path.splitext(moduleName)[0]
        fullModuleName = "sanpy.fileloaders." + moduleName

        loadedModule = sanpy._util._module_from_file(fullModuleName, file)

        try:
            oneConstructor = getattr(loadedModule, moduleName)
        except AttributeError as e:
            logger.error(
                f'Did not load file loader, make sure file name and class name are the same:"{moduleName}"'
            )
        else:
            # filetype is a static str, e.g. the extension to load
            try:
                filetype = oneConstructor.loadFileType
            except AttributeError as e:
                logger.warning(f'Did not load "{moduleName}", no "filetype" attribute')
                continue
            oneLoaderDict = {
                "fileLoaderClass": moduleName,
                "type": "user",
                "module": fullModuleName,
                "path": file,
                "constructor": oneConstructor,
                #'filetype': filetype
            }
            if filetype in retDict.keys():
                logger.warning(
                    f'loader already added "{moduleName}" handleExtension:"{filetype}"'
                )
                logger.warning(f"  this loader will overwrite the previous loader.")
            retDict[filetype] = oneLoaderDict

    if verbose:
        logger.info(f"Loaded {len(retDict.keys())} file loaders:")
        for k, v in retDict.items():
            # logger.info(f'    {k}:{v}')
            logger.info(f"  {k}")
            for k2, v2 in v.items():
                logger.info(f"    {k2}: {v2}")

    # sort
    # retDict = dict(sorted(retDict.items()))

    return retDict
All material is Copyright 2011-2023 Robert H. Cudmore