HappyDoc Generated Documentation Class: Data_Region

. / VolumeViewer / Data_Region 

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

Methods   
  new_region 
new_region ( self,  region )

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

  model_transform 
model_transform ( self )
  cached_data 
cached_data (
        self,
        data_component,
        origin,
        size,
        subsampling,
        )
  show 
show (
        self,
        representation,
        rendering_options,
        show,
        message_cb,
        )
  close_models 
close_models ( self )
  replace_data 
replace_data ( self,  data )
  show_solid 
show_solid (
        self,
        show,
        rendering_options,
        message_cb,
        )
  view_models 
view_models (
        self,
        view,
        representation=None,
        )
  update_solid 
update_solid (
        self,
        rendering_options,
        message_cb,
        )
  unshow 
unshow ( self )

Hide surface model and close solid model.

  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.

  full_name 
full_name ( self )
  make_solid 
make_solid ( self,  message_cb )
  matrix_value_statistics 
matrix_value_statistics (
        self,
        component_number,
        bins,
        message_cb,
        read_matrix,
        )
  __init__ 
__init__ (
        self,
        data,
        region,
        region_name,
        rendering_options,
        message_cb=None,
        )
  close_surface 
close_surface ( self )
  initialize_thresholds 
initialize_thresholds ( self,  message_cb )
  full_matrix 
full_matrix (
        self,
        component_number=0,
        message_cb=None,
        read_matrix=True,
        )
  matrix 
matrix (
        self,
        component_number=0,
        message_cb=None,
        read_matrix=True,
        )
  update_surface 
update_surface (
        self,
        show_mesh,
        rendering_options,
        message_cb,
        )
  make_surface 
make_surface ( self,  message_cb )
  xyz_bounds 
xyz_bounds ( self )

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

  choose_subsampling 
choose_subsampling ( self,  ijk_step )

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

  hide_surface 
hide_surface ( self )
  default_matrix_statistics 
default_matrix_statistics (
        self,
        cparams,
        message_cb,
        )

Used for determining default threshold levels.

  region_matrix 
region_matrix (
        self,
        origin,
        size,
        subsampling,
        step,
        component_number=0,
        message_cb=None,
        read_matrix=True,
        )

Region includes ijk_min and ijk_max points.

  cache_data 
cache_data (
        self,
        data_component,
        origin,
        size,
        subsampling,
        m,
        )
  models 
models ( self )
  surface_model 
surface_model ( self )
  matrix_indices_to_xyz_transform 
matrix_indices_to_xyz_transform ( self )

Transform mapping matrix indices to xyz. The matrix indices are not the same as the data indices since the matrix includes only the current subregion and subsampled data values.

  same_region 
same_region (
        self,
        r1,
        r2,
        )

Handle ijk_min, ijk_max, ijk_step as lists or tuples.

  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.

  data_description 
data_description (
        self,
        data_component,
        origin,
        size,
        subsampling,
        )
  show_surface 
show_surface (
        self,
        show,
        show_mesh,
        rendering_options,
        message_cb,
        )
  warn_if_skewed 
warn_if_skewed ( self )
  ijk_bounds 
ijk_bounds ( self )

The data ijk bounds with half a step size padding on all sides.

  matrix_size 
matrix_size ( self )

Size of matrix for subsampled subregion returned by matrix().

  interpolated_values 
interpolated_values (
        self,
        vertices,
        vertex_xform=None,
        component_number=0,
        message_cb=None,
        out_of_bounds_list=False,
        use_subregion=False,
        )
  close_solid 
close_solid ( self )

This document was automatically generated Thu Nov 09 13:33:35 2006 by HappyDoc version 3.0.a1