Data containers¶
nsdfdata
Module¶
Classes for NSDF data.
-
class
nsdf.nsdfdata.
EventData
(*args, **kwargs)[source]¶ Bases:
nsdf.nsdfdata.NSDFData
Stores event times recorded from data sources.
-
class
nsdf.nsdfdata.
NSDFData
(name, unit=None, field=None, dtype=<type 'numpy.float64'>)[source]¶ Bases:
object
Base class for NSDF Data.
-
name
¶ str
name of the dataset.
-
unit
¶ str
unit of the recorded quantity.
-
field
¶ str
the recorded field/parameter of the source object. If unspecified it defaults to name.
-
dtype
¶ numpy.dtype
type of the recorded data. Default: numpy.float64
-
put_data
(source, data)[source]¶ Set the data array for source.
Parameters: - source (str) – uid of the data source.
- data (a scalar or sequence of elements of dtype) – the data for this source.
Returns: None
-
update_source_data_dict
(src_data)[source]¶ Insert a bunch of source, data pairs.
Parameters: - src_data (dict-like) – an object that is a dict or a
- of key-value pairs. (sequence) –
Returns: None
Examples
>>> data_obj = nsdf.UniformData('current', unit='pA') >>> ika, ikdr = [0.1, 0.3, 0.5], [0.3, 0.14] >>> data_obj.update_source_data_dict([('KA', ika), ('KDR', ikdr)])
-
-
class
nsdf.nsdfdata.
NonuniformData
(name, unit=None, field=None, tunit=None, dtype=<type 'numpy.float64'>, ttype=<type 'numpy.float64'>)[source]¶ Bases:
nsdf.nsdfdata.TimeSeriesData
Stores nonuniformly sampled data.
-
ttype
¶ np.dtype data type of time points. Default np.float64
-
-
class
nsdf.nsdfdata.
NonuniformRegularData
(*args, **kwargs)[source]¶ Bases:
nsdf.nsdfdata.TimeSeriesData
Stores nonuniformly sampled data where all sources are sampled at the same time points.
-
class
nsdf.nsdfdata.
StaticData
(*args, **kwargs)[source]¶ Bases:
nsdf.nsdfdata.NSDFData
Stores static data recorded from data sources.