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

Class: SparseSampling


    Describes the sparse sampling schedule. For every dim that is sparsely sampled, there will be a SparseSampling object. The nth value in SparseSampling.pointNumbers gives the timestep number for this dimension that was used in the nth sparsely sampled hypercomplex point..
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link dataSource to class DataSource
Main key: dim
Mandatory Attributes: dim
Known Subclasses: None
Children: None
Constructor: newObj = SparseSampling( dataSource,dim=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dim PositiveInt 1..1 Dimension that is sparsely sampled  
minPointsPerVector PositiveInt 0..1 Minimum nuber of non-null points in any row or column.  
pointNumbers Int 0..* Point numbers (time step numbers) for dimension dim in random sampling. The length must be equal to the Experiment.numTimePoints  
predJ Float 0..1 Predicted J coupling value - used for optimisation of non-uniform sampling  
predT2 PositiveFloat 0..1 Predicted T2, in seconds. Used for optimisation of non-uniform samplin  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dataSource DataSource 1..1 (Parent link). parent link  
parent DataSource 1..1 link to parent object - synonym for dataSource  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dim
getDim PositiveInt -
setDim - PositiveInt
minPointsPerVector
getMinPointsPerVector PositiveInt -
setMinPointsPerVector - PositiveInt
pointNumbers
getPointNumbers Int Tuple -
setPointNumbers - Int List
addPointNumber - Int
removePointNumber - Int
predJ
getPredJ Float -
setPredJ - Float
predT2
getPredT2 PositiveFloat -
setPredT2 - PositiveFloat

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dataSource
getDataSource DataSource -
parent
getParent DataSource -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey SparseSampling 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_2007-04-05-11:27:55_00001

isImplicit:

False

Tag

Value
repositoryId $Id: SparseSampling.xml,v 1.28 2011-01-13 14:40:35 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraint name:

length_pointNumbers_is_parent_numSparsePoints
Constraint code: len(self.pointNumbers) == self.parent.numSparsePoints
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:49 2013    from data model package  ccp.api.nmr.Nmr.SparseSampling   revision 1.28  
  Work done by the CCPN team.
www.ccpn.ac.uk