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

Class: ShapeMatrix


    NumericMatrix stored in decomposed form, as a sum of components, each an outer product of lower-dimensionality shapes. The number of components is given by numRecords. Individual records do not have headers, and the header size refers to the header of the entire dataasource.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link dataLocationStore to class DataLocationStore
Main key: serial
Mandatory Attributes: isResolved, numShapes, path, dataUrl
Known Subclasses: None
Children:
link componentShapes to class ComponentShape
link components to class Component
Constructor: newObj = ShapeMatrix( dataLocationStore,isResolved=value, numShapes=value, path=value, dataUrl=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
complexStoredBy ComplexStorage 1..1 The ordering of real and imaginary parts of hypercomplex numbers in the data matrix. See ComplexStorage type for details  
dataEncoding DataEncoding 1..1 Data Encoding  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
fileType MatrixFileType 0..1 Data file type.  
fullPath PathString 1..1 Derived. Full path to data  
headerSize Int 1..1 Header size. May be either in bytes (for binary encoding) or lines (for ascii encoding).  
isBigEndian Boolean 1..1 Are data big-endian (alternative little-endian)? Irrelevant for ascii data.  
isComplex Boolean 0..* Are numbers complex (if True) or real/integer (if False).  
isReconstructable Boolean 1..1 Is spectrum reconstructable? If true all components can be summed to give a representation of the entire spectrum.  
isResolved Boolean 1..1 Is spectrum resolved? If True all components marked 'clean' can be summed to give a correct representation of all significant signal in the spectrum. A spectrum without raw components should be set to resolved.  
numDims Int 1..1 Derived. Number of dimensions.  
numPoints Int 0..* number of points for each matrix dimension - also defines dimensionality of matrix. The number of points is the same for real or complex data, in the sense that n complex points require 2n real numbers for storage. Dimensions are in storage order, fastest varying first.  
numRecords Int 1..1 Number of matrix records in file. All other information in the object describes a single record.  
numShapes PositiveInt 1..1 Number of shapes per component. Differs from numDims only if some shapes are 2D or higher  
numberType NumberType 1..1 Type of numbers held in matrix  
path PathString 1..1 Path relative to dataUrl.url.  
scaleFactor PositiveFloat 1..1 Scale factor for data stored in matrix. The numbers as stored must be multiplied by the scaleFactor before being used. E.g. a stored value of 2 (int) with a scaling factor of 1.6 means the number to use in calculations would be 3.2.  
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  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
componentShapes ComponentShape 0..* (Child link). child link to class ComponentShape  
components Component 0..* (Child link). child link to class Component  
dataLocationStore DataLocationStore 1..1 (Parent link). parent link  
dataUrl DataUrl 1..1 DataUrl under which AbstractDataStore is stored  
nmrDataSources ccp.api.nmr.Nmr.DataSource 0..* ccp.nmr.Nmr.DataSources stored in the DataStore  
parent DataLocationStore 1..1 link to parent object - synonym for dataLocationStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
complexStoredBy
getComplexStoredBy ComplexStorage -
setComplexStoredBy - ComplexStorage
dataEncoding
getDataEncoding DataEncoding -
setDataEncoding - DataEncoding
details
getDetails Text -
setDetails - Text
fileType
getFileType MatrixFileType -
setFileType - MatrixFileType
fullPath
getFullPath PathString - non-std.
headerSize
getHeaderSize Int -
setHeaderSize - Int
isBigEndian
getIsBigEndian Boolean -
setIsBigEndian - Boolean
isComplex
getIsComplex Boolean Tuple -
setIsComplex - Boolean List
addIsComplex - Boolean
removeIsComplex - Boolean
isReconstructable
getIsReconstructable Boolean -
setIsReconstructable - Boolean
isResolved
getIsResolved Boolean -
setIsResolved - Boolean
numDims
getNumDims Int - non-std.
numPoints
getNumPoints Int Tuple -
setNumPoints - Int List
addNumPoints - Int
removeNumPoints - Int
numRecords
getNumRecords Int -
setNumRecords - Int
numShapes
getNumShapes PositiveInt -
setNumShapes - PositiveInt
numberType
getNumberType NumberType -
setNumberType - NumberType
path
getPath PathString -
setPath - PathString
scaleFactor
getScaleFactor PositiveFloat -
setScaleFactor - PositiveFloat
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
componentShapes
getComponentShapes ComponentShape Set -
sortedComponentShapes ComponentShape List -
findFirstComponentShape ComponentShape keyword=value pairs
findAllComponentShapes ComponentShape Set keyword=value pairs
components
getComponents Component Set -
sortedComponents Component List -
findFirstComponent Component keyword=value pairs
findAllComponents Component Set keyword=value pairs
dataLocationStore
getDataLocationStore DataLocationStore -
dataUrl
getDataUrl DataUrl -
setDataUrl - DataUrl
nmrDataSources
getNmrDataSources ccp.api.nmr.Nmr.DataSource Set -
setNmrDataSources - ccp.api.nmr.Nmr.DataSource Set
sortedNmrDataSources ccp.api.nmr.Nmr.DataSource List -
addNmrDataSource - ccp.api.nmr.Nmr.DataSource
removeNmrDataSource - ccp.api.nmr.Nmr.DataSource
findFirstNmrDataSource ccp.api.nmr.Nmr.DataSource keyword=value pairs
findAllNmrDataSources ccp.api.nmr.Nmr.DataSource Set keyword=value pairs
parent
getParent DataLocationStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ShapeMatrix 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
newComponent Component ...
newComponentShape ComponentShape ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2007-04-04-17:43:15_00005

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

isComplex_same_length_as_numPoints
Constraint code: len(self.numPoints) == len(self.isComplex)
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:00 2014    from data model package  ccp.api.general.DataLocation.ShapeMatrix   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk