mcsas.dataobj.dataobj module

Represents input data associated with a measurement.

class DataObj(**kwargs)

Bases: abc.NewBase

General container for data loaded from file. It offers specialised methods to derive information from the provided data.

accumulate(others)

Warning

method ‘dataobj.dataobj.DataObj.accumulate’ undocumented

config

configType

Returns a compatible DataConfig type.

count

f

The measurement vector.

filename

hasUncertainties

Returns True if this data set has an error bar for its intensities.

hdfWrite(hdf)

Warning

method ‘dataobj.dataobj.DataObj.hdfWrite’ undocumented

initConfig()

Initializes a new data configuration and sets the sample name which is used to differentiate different data objects of the same type later on.

is2d

Returns true if this dataset contains two-dimensional data with psi information available.

modelType

Returns a compatible ScatteringModel type.

sampleName

seriesKey

The Name of the DataObj property to use as series key, hard-coded for now, assuming it exists. It allows to let the user chose from a generated list of properties (todo).

seriesKeyName

Returns the docstring of the property defined by self.seriesKeyProp.

seriesKeyValue

Returns the value of the property defined by self.seriesKeyProp.

setConfig(config=None)

Set the configuration of this data object if the type matches.

setFilename(fn)

Stores the absolute path to this data file. Should be reviewed when data sets can be created from several files.

classmethod sourceName()

Returns the name of the measurement method.

updateConfig()

Updates the config object based on this data set. All callbacks are run right after this method in setConfig().

x0

First sampling vector.

x1

Second sampling vector.

x2

Third sampling vector.

classproperty(func)

Warning

function ‘dataobj.dataobj.classproperty’ undocumented