Plugin dataset types
These are the types of object an import or dataset plugin can return:
1 class Dataset1D(object):
2 """1D dataset for ImportPlugin or DatasetPlugin."""
3 def __init__(self, name, data=[], serr=None, perr=None, nerr=None):
4 """1D dataset
5 name: name of dataset
6 data: data in dataset: list of floats or numpy 1D array
7 serr: (optional) symmetric errors on data: list or numpy array
8 perr: (optional) positive errors on data: list or numpy array
9 nerr: (optional) negative errors on data: list or numpy array
10
11 If errors are returned for data give serr or nerr and perr.
12 nerr should be negative values if used.
13 perr should be positive values if used.
14 """
15
16 def update(self, data=[], serr=None, perr=None, nerr=None):
17 """Update values to those given."""
18
19 class Dataset2D(object):
20 """2D dataset for ImportPlugin or DatasetPlugin."""
21 def __init__(self, name, data=[[]], rangex=None, rangey=None):
22 """2D dataset.
23 name: name of dataset
24 data: 2D numpy array of values or list of lists of floats
25 rangex: optional tuple with X range of data (min, max)
26 rangey: optional tuple with Y range of data (min, max)
27 """
28 self.name = name
29 self.update(data=data, rangex=rangex, rangey=rangey)
30
31 def update(self, data=[[]], rangex=None, rangey=None):
32 """Update the dataset with the data and ranges given."""
33
34 class DatasetText(object):
35 """Text dataset for ImportPlugin or DatasetPlugin."""
36 def __init__(self, name, data=[]):
37 """A text dataset
38 name: name of dataset
39 data: data in dataset: list of strings
40 """
41
42 def update(self, data=[]):
43 """Update the dataset with the data given."""
