HappyDoc Generated Documentation Class: MRC_Data

. / VolumeData / mrc / mrc_format.py / MRC_Data 

Methods   
  matrix 
matrix ( self )

Returns 3D Numeric matrix with zyx index order.

  read_values 
read_values (
        self,
        file,
        etype,
        count,
        )
  submatrix 
submatrix (
        self,
        ijk_origin,
        ijk_size,
        )

Reads a submatrix from a potentially very large file. Returns 3D Numeric matrix with zyx index order.

  check_header_values 
check_header_values (
        self,
        v,
        file_size,
        file,
        )
Exceptions   

SyntaxError, ( 'MRC data value type (%d) ' % v [ 'mode' ] + 'is not 8 or 16 bit integers or 32 bit floats' )
SyntaxError, ('File size %d too small for grid size (%d,%d,%d)' %(file_size, v [ 'nc' ], v [ 'nr' ], v [ 'ns' ] ) )
SyntaxError, ('Bad MRC grid size (%d,%d,%d)' %(v [ 'nc' ], v [ 'nr' ], v [ 'ns' ] ) )

  permute_matrix_to_xyz_axis_order 
permute_matrix_to_xyz_axis_order ( self,  matrix )
  read_header_values 
read_header_values ( self,  file )

Format derived from C header file mrc.h.

  __init__ 
__init__ ( self,  path )
  read_values_from_string 
read_values_from_string (
        self,
        string,
        etype,
        count,
        )

This document was automatically generated Thu Feb 02 15:18:17 2006 by HappyDoc version 3.0.a1