HappyDoc Generated Documentation Class: Grid_Data

. / VolumeData / griddata.py / Grid_Data 

Methods   
  cached_data 
cached_data (
        self,
        origin,
        size,
        step,
        )
  submatrix 
submatrix (
        self,
        ijk_origin,
        ijk_size,
        )

Deprecated. Used before matrix() routine existed.

  call_callbacks 
call_callbacks ( self,  reason )
  matrix_slice 
matrix_slice (
        self,
        matrix,
        ijk_origin,
        ijk_size,
        ijk_step,
        )

Convenience routine.

  __init__ 
__init__ (
        self,
        size,
        value_type=None,
        origin=None,
        step=None,
        cell_angles=None,
        rotation=None,
        symmetries=None,
        name=None,
        path=None,
        file_type=None,
        grid_id=None,
        default_color=None,
        )
  full_matrix 
full_matrix ( self,  progress=None )

Deprecated. Used before matrix() routine existed.

  matrix 
matrix (
        self,
        ijk_origin=None,
        ijk_size=None,
        ijk_step=None,
        progress=None,
        from_cache_only=None,
        )
  clear_cache 
clear_cache ( self )
  name_from_path 
name_from_path ( self,  path )
  values_changed 
values_changed ( self )

Code has modified matrix elements, or the value type has changed.

  ijk_to_xyz 
ijk_to_xyz ( self,  ijk )

A matrix ijk corresponds to a point in xyz space. This function maps the matrix index to the xyz point.

  cache_data 
cache_data (
        self,
        m,
        origin,
        size,
        step,
        )
  xyz_to_ijk 
xyz_to_ijk ( self,  xyz )

A matrix ijk corresponds to a point in xyz space. This function maps the xyz point to the matrix index. The returned matrix index need not be integers.

  data_description 
data_description (
        self,
        origin,
        size,
        step,
        )
  set_origin 
set_origin ( self,  origin )
  plane_spacings 
plane_spacings ( self )

Spacings in xyz space of jk, ik, and ij planes.

  add_change_callback 
add_change_callback ( self,  cb )
  set_rotation 
set_rotation ( self,  rotation )
  read_matrix 
read_matrix (
        self,
        ijk_origin=None,
        ijk_size=None,
        ijk_step=None,
        progress=None,
        )

Must overide this function in derived class to return a 3 dimensional NumPy matrix. The returned matrix has size ijk_size and element ijk is accessed as m[k,j,i]. It is an error if the requested submatrix does not lie completely within the full data matrix. It is also an error for the size to be <= 0 in any dimension. These invalid inputs might throw an exception or might return garbage. It is the callers responsibility to make sure the arguments are valid.

Exceptions   

NotImplementedError, 'Grid %s has no read_matrix() routine' % self.name

  set_step 
set_step ( self,  step )
  update_transform 
update_transform ( self )

Compute 3 by 4 matrices encoding rotation and translation.

  coordinates_changed 
coordinates_changed ( self )

Mapping of array indices to xyz coordinates has changed.

  set_cell_angles 
set_cell_angles ( self,  cell_angles )
  set_path 
set_path (
        self,
        path,
        format=None,
        )
  remove_change_callback 
remove_change_callback ( self,  cb )

This document was automatically generated Wed Jul 9 15:49:12 2008 by HappyDoc version 3.1