HappyDoc Generated Documentation ./VolumeViewer/volume.py

. / VolumeViewer / volume.py 

Functions   
  ijk_step_for_voxel_limit 
ijk_step_for_voxel_limit (
        ijk_min,
        ijk_max,
        ijk_step,
        limit_voxel_count,
        mvoxel_limit,
        )

Return ijk step size so that voxels displayed is at or below the limit. The given ijk step size may be increased or decreased by powers of 2.

  distance 
distance ( xyz1,  xyz2 )
  open_volume_file 
open_volume_file (
        path,
        format=None,
        name=None,
        representation=None,
        open_models=True,
        show_data=True,
        show_dialog=True,
        )

Open and display a map.

  show_one_plane 
show_one_plane (
        data_region,
        show_plane,
        min_voxels,
        )

Decide whether a data region is large enough that only a single z plane should be shown.

  maximum_data_diagonal_length 
maximum_data_diagonal_length ( data )
  full_region 
full_region ( size,  ijk_step=[ 1, 1, 1 ] )
  show_when_opened 
show_when_opened (
        data_region,
        show_on_open,
        max_voxels,
        )

Decide whether a data region is small enough to show when opened.

  is_empty_region 
is_empty_region ( ijk_region )
  volume_from_grid_data 
volume_from_grid_data (
        grid_data,
        representation=None,
        open_model=True,
        show_data=True,
        show_dialog=True,
        )

Open and display a map using Volume Viewer.

  points_ijk_bounds 
points_ijk_bounds (
        points,
        pad,
        data,
        )

Points are in volume object coordinates.

  bounding_box 
bounding_box ( points )
  resize_region_for_zone 
resize_region_for_zone (
        data_region,
        points,
        radius,
        initial_resize=False,
        )

Adjust volume region to include a zone. If current volume region is much bigger than that needed for the zone, then shrink it. The purpose of this resizing is to keep the region small so that recontouring is fast, but not resize on every new zone radius. Resizing on every new zone radius requires recontouring and redisplaying the volume histogram which slows down zone radius updates.

  clamp_region 
clamp_region ( region,  size )
  subarray_size 
subarray_size ( size,  step )
  region_volume 
region_volume ( ijk_min,  ijk_max )
  limit_voxels 
limit_voxels (
        voxel_count,
        ijk_step,
        limit_voxel_count,
        mvoxel_limit,
        )

Return ijk step size so that voxels displayed is at or below the limit. The given ijk step size may be increased or decreased by powers of 2.

  saturate_rgba 
saturate_rgba ( rgba )
  extend_region 
extend_region (
        ijk_min,
        ijk_max,
        factor,
        )
  transformed_points 
transformed_points ( points,  xform )
  show_planes 
show_planes (
        dr,
        axis,
        plane,
        depth,
        extend_axes=[],
        show=True,
        save_in_region_queue=True,
        )
  region_contains_region 
region_contains_region ( r1,  r2 )
Classes   

Volume

Volume_Manager

Region_List

Remember visited subregions.

Rendering_Options


This document was automatically generated Thu Nov 15 14:09:15 2007 by HappyDoc version 3.0.a1