mcsas.dataobj package¶
Submodules¶
Module contents¶
-
class
DataObj(**kwargs)[source]¶ Bases:
abc.NewBaseGeneral container for data loaded from file. It offers specialised methods to derive information from the provided data.
-
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.
-
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.
-
setFilename(fn)[source]¶ Stores the absolute path to this data file. Should be reviewed when data sets can be created from several files.
-
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.DataObjRepresents one set of data from a unique source (a file, for example).
-
configType¶ Returns a compatible DataConfig type.
-
count¶
-
dataContent¶ shows the content of the loaded data: Q, I, IErr, etc
-
classmethod
displayData()[source]¶ classmethod(function) -> method
Convert a function to be a class method.
A class method receives the class as implicit first argument, just like an instance method receives the instance. To declare a class method, use this idiom:
- class C:
- def f(cls, arg1, arg2, …): … f = classmethod(f)
It can be called either on the class (e.g. C.f()) or on an instance (e.g. C().f()). The instance is ignored except for its class. If a class method is called for a derived class, the derived class object is passed as the implied first argument.
Class methods are different than C++ or Java static methods. If you want those, see the staticmethod builtin.
-
classmethod
displayDataDescr()[source]¶ classmethod(function) -> method
Convert a function to be a class method.
A class method receives the class as implicit first argument, just like an instance method receives the instance. To declare a class method, use this idiom:
- class C:
- def f(cls, arg1, arg2, …): … f = classmethod(f)
It can be called either on the class (e.g. C.f()) or on an instance (e.g. C().f()). The instance is ignored except for its class. If a class method is called for a derived class, the derived class object is passed as the implied first argument.
Class methods are different than C++ or Java static methods. If you want those, see the staticmethod builtin.
-
modelType¶ Returns a compatible ScatteringModel type.
-
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¶
-
shannonChannelEstText¶
-
sphericalSizeEstText¶
-
-
class
DataConfig[source]¶ Bases:
bases.algorithm.algorithmbase.AlgorithmBase,dataobj.dataconfig.CallbackRegistry-
callbackSlots¶
-
is2d¶
-
parameters= (None, None, None, None, None, None, None, None)¶
-
sampleName¶
-
showParams¶ A list of parameter names which defines the parameters and their ordering shown in a UI. To be overridden in sub classes.
-