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

Package: DataLocation


    DRAFT - backward compatibility of future versions not guaranteed.
    Package for storing file descriptors, file pointers and similar for external data files, such as iamges, binary data matrices, ...
Classes
Data Types
Data Obj Types

Imported Packages:

memops.api.AccessControl,   memops.api.Implementation

Packages Importing ccp.api.general.DataLocation:

Affiliation,   Annotation,   ccp.api.nmr.Nmr,   ccp.api.nmr.NmrCalc,   ccpnmr.api.Analysis

Classes:

Class Description
AbstractDataStore Data store descriptor
BlockedBinaryMatrix NumericMatrix stored in blocked binary format
Component Component of the decomposition
ComponentShape Descriptor for the individual shapes that are multiplied together to reconstruct a component.
DataLocationStore grouping of data locaations and file descriptors
DataUrl Url descriptor for an absolute data location
MimeTypeDataStore Data storage pointer for anything with a MimeType (e.g. JPEG or GIF)
NumericMatrix DataSource containing one or more N-dimensional numerical matrix records, which may be real or (hyper)complex
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.

Data Obj Types:

Type Description
None

Data Types:

Type Description
ComplexStorage Storage types for storing (hyper)complex numbers. For a hypercomplex 2D matrix, possibilities are:

'timepoint':
r1r1, i1r1, r1i1, i1i1, r2r1, ...
...
r1r2, ...
...

'quadrant':
r1r1, r2r1, r3r1, ...
r1r2, r2r2, ...
...
i1r1, i2r1, i3r1, ...
...
r1i1, r2i1, r3i1, ...
...
i1i1, i2i1, i3i1,
...

'dimension':
r1r1, i1r1, r2r1, i2r1, ...
r1i1, i1i1, r2i1, i2i1, ...
r1r2, i1r2, r2r2, i2r2, ...
...  
ComponentStatus Analysis status of a ShapeMatrix Component. The following alues are allowed:
    * 'clean' is a component that represents a signal in the spectrum.
      All clean components in a ShapeMatrix must be independent (i.e. no duplicates) so that the sum of all clean components represent all known signals in the ShapeMatrix.
    * 'noise' is a component that represents noise or artifacts. It serves for reconstructing the full spectrum but does not contain signal information.
    * 'border' is a component that contains signal that corresponds to one or more clean components elsewhere. Border components could be shoulders of Components from another region, or duplicates of one or more components present elsewhere.
    * 'raw' is a component that has not yet been analyzed and assigned to one of the other categories. A ShapeMatrix containing raw components should be classed as not resolved.
DataEncoding Encoding of data. Currently binary, ascii.
MatrixFileType File type for NumericMatrix objects
NumberType Allowed values for NumericMatrix.numberType. Currently 'int' and 'float'.

Package guid:

www.ccpn.ac.uk_Fogh_2007-04-03-19:08:10_00001
  Data Model Version 2.0.5
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 26 16:58:05 2012    from data model package  ccp.api.general.DataLocation   revision 1.42  
  Work done by the CCPN team.
www.ccpn.ac.uk