HappyDoc Generated Documentation Class: SPIDER_Data

. / VolumeData / spider / spider_format.py / SPIDER_Data 

Methods   
  read_matrix 
read_matrix (
        self,
        ijk_origin,
        ijk_size,
        ijk_step,
        progress,
        )

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

  check_header_values 
check_header_values (
        self,
        v,
        file_size,
        )
Exceptions   

SyntaxError, "SPIDER image stacks not supported."
SyntaxError, ('SPIDER data format %f != 3 (volume data)' % v [ 'iform' ] )
SyntaxError, ('Bad SPIDER grid size (%.0f,%.0f,%.0f)' %(v [ 'nslice' ], v [ 'nrow' ], v [ 'nsam' ] ) )
SyntaxError, ('File size %d too small for grid size (%.0f,%.0f,%.0f) and data offset %.0f' %(file_size, v [ 'nslice' ], v [ 'nrow' ], v [ 'nsam' ], v [ 'labbyt' ] ) )

  need_byte_swap 
need_byte_swap ( self,  file )

Infer file byte order from format value.

Exceptions   

SyntaxError, 'File is not SPIDER volume data.\nBytes 16-19 do not hold float 3 or byte swapped float 3.'

  __init__ 
__init__ ( self,  path )
  read_header_values 
read_header_values ( self,  file )

Format derived from spider_format.html documentation.


This document was automatically generated Fri May 30 21:13:41 2008 by HappyDoc version 3.1