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

Class: FloatMatrixData


    Floating point matrix data
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link run to class Run
Main key: serial
Mandatory Attributes: shape
Known Subclasses: None
Children: None
Constructor: newObj = FloatMatrixData( run,shape=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
code Word 0..1 Unique identifier for the parameter within the context of the application being run  
data Float 0..* Matrix data as packed list.  
defaultValue Float 1..1 default value of data in matrix. Used instead of values that are not explicitly set.  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
ioRole IoRole 1..1 Role of data in calculation (input / output).  
name Line 0..1 Human readable name of parameter  
ndim PositiveInt 1..1 Derived. Number of matrix dimensions  
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  
shape NonNegativeInt 1..* Matrix shape, slowest moving index first. SIze in first dimension (only) may be zero.  
size NonNegativeInt 1..1 Derived. Matrix size - product of dimensions sizes  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
parameterGroup ParameterGroup 0..1 Parameter group that Data belong to  
parent Run 1..1 link to parent object - synonym for run  
run Run 1..1 (Parent link). parent link  
runParameters RunParameter 0..* parameters that refer to unit of data.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
code
getCode Word -
setCode - Word
data
getData Float Tuple -
setData - Float List
defaultValue
getDefaultValue Float -
setDefaultValue - Float
details
getDetails Text -
setDetails - Text
ioRole
getIoRole IoRole -
setIoRole - IoRole
name
getName Line -
setName - Line
ndim
getNdim PositiveInt - non-std.
serial
getSerial Int -
setSerial - Int
shape
getShape NonNegativeInt Tuple -
setShape - NonNegativeInt List
size
getSize NonNegativeInt - non-std.

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parameterGroup
getParameterGroup ParameterGroup -
setParameterGroup - ParameterGroup
parent
getParent Run -
run
getRun Run -
runParameters
getRunParameters RunParameter Set -
setRunParameters - RunParameter Set
sortedRunParameters RunParameter List -
addRunParameter - RunParameter
removeRunParameter - RunParameter
findFirstRunParameter RunParameter keyword=value pairs
findAllRunParameters RunParameter Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey FloatMatrixData 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
getPointValue Float Int List non-std. get value of matrix at position 'point'. Point is converted as for self.pointToIndex.
getSubmatrixData Float List Int List, Int List non-std. get data (packed linear array)  for submatrix of shape 'shape' with 'point' as the corner with the smallest index values. point is convered as for self.pointToIndex. 'shape values that are omitted or set to zero are reset to the (rest of the) dimension size.
indexToPoint Int List Int non-std. Converts array index to equivalent point
pointToIndex Int Int List non-std. converts point to equivalent array index. Point is padded to matrix dimension with zeros. negative index values -i in point are treated as eqal to (size-i).
removeSlice - Int non-std. Remove slice of matrix in slowest verying dimension at offset index.
resetData - - non-std. Reset data to default values and free memory used.
setPointValue - Int List, Float non-std. set value of matrix at position 'point'. Point is converted as for self.pointToIndex.
setSubmatrixData - Int List, Int List, Float List non-std. set data for submatrix of shape 'shape' with 'point' as the corner with the smallest index values to 'values' (packed linear array). Point is converted as for self.pointToIndex.  shape values that are omitted or set to zero are reset to the (rest of the) dimension size.
sizeFirstDim - Int non-std. Change size in first (slowest) dimension, truncating or padding with self.defaultValue as necessary.

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2011-04-05-18:08:58_00001

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:25:12 2015    from data model package  ccp.api.nmr.NmrCalc.FloatMatrixData   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk