HappyDoc Generated Documentation Class: UHBD_Data

. / VolumeData / uhbd / uhbd_format.py / UHBD_Data 

Methods   
  matrix 
matrix ( self,  progress )

Returns 3D NumPy matrix with zyx index order.

Binary file is written in unformatted Fortran style with record length proceeding and following each record. Matrix is written one z plane at a time with plane number and size (k, im, jm) in a record preceding each plane.

  read_values 
read_values (
        self,
        file,
        etype,
        count,
        )
  determine_byte_order 
determine_byte_order ( self,  file )

Infer file byte order using interger value 1 saved in header.

Exceptions   

SyntaxError, ( 'UHBD file does not contain integer value 1 at bytes 96-99\n using either little or big endian byte order. Found %d' % one )

  check_header_values 
check_header_values (
        self,
        v,
        file_size,
        )
Exceptions   

SyntaxError, ('Bad UHBD grid size (%d,%d,%d)' %(v [ 'im' ], v [ 'jm' ], v [ 'km' ] ) )
SyntaxError, ('File size %d too small for grid size (%d,%d,%d)' %(file_size, v [ 'im' ], v [ 'jm' ], v [ 'km' ] ) )
SyntaxError, ('Bad UHBD data scale factor %g <= 0' % v [ 'scale' ] )
SyntaxError, ('Bad UHBD voxel size %g <= 0' % v [ 'h' ] )

  read_header_values 
read_header_values ( self,  file )

Format derived from uhbd_asc2bin.f source code.

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

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