cached_data (
        self,
        origin,
        size,
        step,
        )

submatrix (
        self,
        ijk_origin,
        ijk_size,
        )

Deprecated. Used before matrix() routine existed.

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

Convenience routine.

__init__ (
        self,
        size,
        value_type=float32,
        origin=( 0, 0, 0 ),
        step=( 1, 1, 1 ),
        cell_angles=( 90, 90, 90 ),
        rotation=(( 1, 0, 0 ), ( 0, 1, 0 ), ( 0, 0, 1 ) ),
        symmetries=(),
        name='',
        path='',
        file_type='',
        grid_id='',
        default_color=(.7,.7,.7, 1 ),
        )

full_matrix ( self,  progress=None )

Deprecated. Used before matrix() routine existed.

matrix (
        self,
        ijk_origin=( 0, 0, 0 ),
        ijk_size=None,
        ijk_step=( 1, 1, 1 ),
        progress=None,
        from_cache_only=False,
        )

clear_cache ( self )

values_changed ( self )

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

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 (
        self,
        m,
        origin,
        size,
        step,
        )

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 (
        self,
        origin,
        size,
        step,
        )

set_origin ( self,  origin )

plane_spacings ( self )

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

add_change_callback ( self,  cb )

set_rotation ( self,  rotation )

read_matrix (
        self,
        ijk_origin=( 0, 0, 0 ),
        ijk_size=None,
        ijk_step=( 1, 1, 1 ),
        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.

set_step ( self,  step )

update_transform ( self )

Compute 3 by 4 matrices encoding rotation and translation.

coordinates_changed ( self )

Mapping of array indices to xyz coordinates has changed.

set_cell_angles ( self,  cell_angles )

remove_change_callback ( self,  cb )