Data Model version 2.1.2
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: IsotropicS2


    Order parameter (S2), calculated assuming isotropic motion.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link derivation to class IsotropicS2Derivation
Main key: serial
Mandatory Attributes: resonances
Known Subclasses: None
Children: None
Constructor: newObj = IsotropicS2( derivation,resonances=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
error Float 0..1 Uncertainty (standard deviation) of value  
figOfMerit FloatRatio 1..1 Figure of merit, describing the reliability of the value. Between 0.0 (useless) and 1.0 (fully reliable, also the default).  
modelFit Text 0..1 Which model used in fitting  
rexError Float 0..1 Uncertainty (standard deviation) in value of Rex  
rexValue Float 0..1 R value for relaxation from other mechanisms  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  
sumSquaredErrors Float 0..1 Sum-Of-Squared-Errors from the fitting  
tauEError Float 0..1 Uncertainty (standard deviation) in overall correlation time.  
tauEValue Float 0..1 Overall correlation time for the molecule  
tauSError Float 0..1 Uncertainty (standard deviation) in internal correlation time.  
tauSValue Float 0..1 Correlation time for internal motion  
value Float 0..1 Value of derived measurement.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
derivation IsotropicS2Derivation 1..1 (Parent link). parent link  
parent IsotropicS2Derivation 1..1 link to parent object - synonym for derivation  
resonances Resonance 2..2 Resonances to which isotropic order parameter values belongs.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
error
getError Float -
setError - Float
figOfMerit
getFigOfMerit FloatRatio -
setFigOfMerit - FloatRatio
modelFit
getModelFit Text -
setModelFit - Text
rexError
getRexError Float -
setRexError - Float
rexValue
getRexValue Float -
setRexValue - Float
serial
getSerial Int -
setSerial - Int
sumSquaredErrors
getSumSquaredErrors Float -
setSumSquaredErrors - Float
tauEError
getTauEError Float -
setTauEError - Float
tauEValue
getTauEValue Float -
setTauEValue - Float
tauSError
getTauSError Float -
setTauSError - Float
tauSValue
getTauSValue Float -
setTauSValue - Float
value
getValue Float -
setValue - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
derivation
getDerivation IsotropicS2Derivation -
parent
getParent IsotropicS2Derivation -
resonances
getResonances Resonance Set -
setResonances - Resonance Set
sortedResonances Resonance List -
findFirstResonance Resonance keyword=value pairs
findAllResonances Resonance Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey IsotropicS2 memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
None

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:22:47_00008

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:56 2015    from data model package  ccp.api.nmr.Nmr.IsotropicS2   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk