HappyDoc Generated Documentation Class: PIF_Data

. / VolumeData / pif / pif_format.py / PIF_Data 

Methods   
  is_byte_swap_needed 
is_byte_swap_needed ( self,  file )

Assume file is positioned at byte 0.

Exceptions   

SyntaxError, ('First 4 bytes of PIF file %s must be %d, got %d' %( file.name, PIF_MAGIC_NUMBER, mnum ) )

  header_values 
header_values ( self,  v )
  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.

  read_image_header 
read_image_header (
        self,
        file,
        ff,
        )

Each image has a file header similar to MRC format headers.

  read_floats 
read_floats (
        self,
        file,
        count,
        ff,
        )
  check_header_values 
check_header_values (
        self,
        v,
        file_size,
        file,
        )
Exceptions   

SyntaxError, ( 'PIF data value type %d not supported ' % m )
SyntaxError, ('Bad PIF grid size (%d,%d,%d)' %(vi [ 'nx' ], vi [ 'ny' ], vi [ 'nz' ] ) )
SyntaxError, ('File size %d too small for grid size (%d,%d,%d)' %(file_size, vi [ 'nx' ], vi [ 'ny' ], vi [ 'nz' ] ) )

  read_values_from_string 
read_values_from_string (
        self,
        string,
        etype,
        count,
        )
  permute_matrix_to_xyz_axis_order 
permute_matrix_to_xyz_axis_order ( self,  matrix )
  read_int32 
read_int32 (
        self,
        file,
        count,
        )
  __init__ 
__init__ ( self,  path )
  read_header_values 
read_header_values ( self,  file )

Format derived from C header file mrc.h.

Exceptions   

SyntaxError, ('int4scaleFstr header value of PIF file %s is not parsable as a float: "%s"' %(file.name, v [ 'int4scaleFstr' ] ) )


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