qubx :: data_types :: SourceChunk :: Class SourceChunk
[hide private]
[frames] | no frames]

Class SourceChunk

source code

     object --+    
              |    
util_types.Anon --+
                  |
                 SourceChunk
Known Subclasses:

Describes one contiguous slice of data from the data source.

Instance Methods [hide private]
 
__init__(self, file=None, signal=0, f=0, l=-1, included=True, latency=0, start=-1, sampling=None, baseline_nodes=True, group=0, **kw)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
get_actual_bounds(self, first_offset=None, last_offset=None) source code
 
get_samples(self, first_offset=None, last_offset=None) source code
 
get_idealization(self, signal=None, mark_excluded=False, get_fragments=False, get_durations=False, get_amps=False, get_stds=False, first_offset=0, last_offset=None)
Returns the dwells in chunk as numpy arrays
source code

Inherited from util_types.Anon: __getattr__, __repr__, __str__, clone

Inherited from util_types.Anon (private): _find_arg_dicts, _str_indent

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Instance Variables [hide private]
  baseline_nodes
True to subtract baseline nodes
  f
first data point
  file
qubx.data.QubData
  filter_Hz
low-pass filter frequency, or None
  group
Group column from List or Segments
  idealized
True if segment has (starts with) idealized dwells
  included
False if excluded
  l
last data point
  latency
number of samples to shift the data rightwards (ignored for idealization)
  n
number of data points
  sampling
sampling interval (sec)
  signal
index of source signal
  start
in ms
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, file=None, signal=0, f=0, l=-1, included=True, latency=0, start=-1, sampling=None, baseline_nodes=True, group=0, **kw)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

get_idealization(self, signal=None, mark_excluded=False, get_fragments=False, get_durations=False, get_amps=False, get_stds=False, first_offset=0, last_offset=None)

source code 

Returns the dwells in chunk as numpy arrays

Parameters:
  • signal - signal index, or None to use the chunk.signal
  • mark_excluded - if True, replaces excluded dwells with class -1 (or -2?)
  • get_fragments - if False, omits first/last dwells if incomplete
  • get_durations - if True, returns durations
  • get_amps - if True: returns amps
  • get_stds - if True: returns stds
  • first_offset - (optional) to narrow the desired time range
  • last_offset - (optional)
Returns:
firsts, lasts, classes[, durations, amps, stds]