Table of Contents

Class: Data_Region VolumeViewer/__init__.py

Manages surface and volume display for a region of a data set.

Methods   
__init__
add_subsamples
cache_data
cached_data
choose_subsampling
close_models
close_solid
close_surface
data_description
ijk_region
make_solid
make_surface
matrix
matrix_value_statistics
models
new_region
replace_components
same_region
save_orientation
set_parameters
show
show_solid
show_surface
transform
unique_name
update_solid
update_surface
view_models
xyz_origin_and_step
xyz_region
  __init__ 
__init__ (
        self,
        data_set,
        region,
        region_name,
        rendering_options,
        attached_model=None,
        )

  add_subsamples 
add_subsamples (
        self,
        grid_object,
        cell_size,
        )

  cache_data 
cache_data (
        self,
        data_component,
        origin,
        size,
        subsampling,
        m,
        )

  cached_data 
cached_data (
        self,
        data_component,
        origin,
        size,
        subsampling,
        )

  choose_subsampling 
choose_subsampling ( self,  ijk_step )

Return the subsampling and size of subsampled matrix for the requested ijk_step.

  close_models 
close_models ( self,  save_orientation=0 )

  close_solid 
close_solid ( self )

  close_surface 
close_surface ( self )

  data_description 
data_description (
        self,
        data_component,
        origin,
        size,
        subsampling,
        )

  ijk_region 
ijk_region ( self )

Return the origin and size of the subsampled submatrix to be read. Also return the subsampling factor and additional step (ie stride) that must be used to get the displayed data.

  make_solid 
make_solid ( self,  message_cb )

  make_surface 
make_surface ( self,  message_cb )

  matrix 
matrix (
        self,
        data_component,
        message_cb,
        read_matrix=1,
        )

Region includes ijk_min and ijk_max points.

  matrix_value_statistics 
matrix_value_statistics (
        self,
        data_component,
        bins,
        message_cb,
        read_matrix,
        )

  models 
models ( self )

  new_region 
new_region ( self,  region )

Remembers new region but does not close existing model. To display new region need to call show().

  replace_components 
replace_components ( self,  components )

  same_region 
same_region (
        self,
        r1,
        r2,
        )

Handle ijk_min, ijk_max, ijk_step as lists or tuples.

  save_orientation 
save_orientation ( self )

  set_parameters 
set_parameters ( self,  **kw )

Programatically set data region parameters. The following keyword parameters are valid.

surface_levels surface_colors (rgb or rgba values) surface_brightness_factor transparency_factor solid_levels solid_colors (rgb or rgba values) transparency_depth solid_brightness_factor hidden

show_outline_box use_colormap

If data set has more than one component than the component parameters are specified as lists. The component parameters are the ones in the first group above. For single component data a list is not used.

  show 
show (
        self,
        representation,
        rendering_options,
        show,
        message_cb,
        )

  show_solid 
show_solid (
        self,
        show,
        rendering_options,
        message_cb,
        )

  show_surface 
show_surface (
        self,
        show,
        show_mesh,
        rendering_options,
        message_cb,
        )

  transform 
transform ( self )

  unique_name 
unique_name ( self,  region_name )

  update_solid 
update_solid (
        self,
        rendering_options,
        message_cb,
        )

  update_surface 
update_surface (
        self,
        show_mesh,
        rendering_options,
        message_cb,
        )

  view_models 
view_models (
        self,
        view,
        representation=None,
        )

  xyz_origin_and_step 
xyz_origin_and_step ( self )

  xyz_region 
xyz_region ( self )

The xyz bounding box encloses the subsampled grid with half a step size padding on all sides.


Table of Contents

This document was automatically generated on Wed Mar 26 19:02:42 2003 by HappyDoc version 2.1