mcsas.dataobj package

Module contents

class DataObj(**kwargs)[source]

Bases: abc.NewBase

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

accumulate(others)[source]

Warning

method ‘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)[source]

Warning

method ‘dataobj.DataObj.hdfWrite’ undocumented

initConfig()[source]

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)[source]

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

setFilename(fn)[source]

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

classmethod sourceName()[source]

Returns the name of the measurement method.

updateConfig()[source]

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.

class SASData(**kwargs)[source]

Bases: dataobj.dataobj.DataObj

Represents one set of data from a unique source (a file, for example).

configType
count
dataContent

shows the content of the loaded data: Q, I, IErr, etc

classmethod displayData()[source]

Warning

method ‘dataobj.SASData.displayData’ undocumented

classmethod displayDataDescr()[source]

Warning

method ‘dataobj.SASData.displayDataDescr’ undocumented

modelType
p

Q-Vector at which the intensities are measured. Provided for convenience use within models.

pLimsString

Properly formatted q-limits for UI label text.

q

Q-Vector at which the intensities are measured. Provided for convenience use within models.

qLimsString

Properly formatted q-limits for UI label text.

rUnit
shannonChannelEst()[source]

Warning

method ‘dataobj.SASData.shannonChannelEst’ undocumented

shannonChannelEstText
classmethod sourceName()[source]

The type of data source for UI label text.

sphericalSizeEst()[source]

Warning

method ‘dataobj.SASData.sphericalSizeEst’ undocumented

sphericalSizeEstText
updateConfig()[source]

Warning

method ‘dataobj.SASData.updateConfig’ undocumented

class DataConfig[source]

Bases: bases.algorithm.algorithmbase.AlgorithmBase, dataobj.dataconfig.CallbackRegistry

callbackSlots
hdfWrite(hdf)[source]

Warning

method ‘dataobj.DataConfig.hdfWrite’ undocumented

is2d
onUpdatedX0(x0)[source]

Sets available range of loaded data.

onUpdatedX1(x1)[source]

Warning

method ‘dataobj.DataConfig.onUpdatedX1’ undocumented

parameters = (None, None, None, None, None, None, None, None)
sampleName
showParams
updateFMasks()[source]

Warning

method ‘dataobj.DataConfig.updateFMasks’ undocumented

updateFuMin()[source]

Warning

method ‘dataobj.DataConfig.updateFuMin’ undocumented

updateX0Limits()[source]

Warning

method ‘dataobj.DataConfig.updateX0Limits’ undocumented

updateX0Unit(newUnit)[source]

Sets the unit of the x0 vector.

updateX1Limits()[source]

Warning

method ‘dataobj.DataConfig.updateX1Limits’ undocumented

updateX1Unit(newUnit)[source]

Warning

method ‘dataobj.DataConfig.updateX1Unit’ undocumented