HappyDoc Generated Documentation ./VolumeViewer/vopcommand.py

. / VolumeViewer / vopcommand.py 

Functions   
  submatrix_center 
submatrix_center (
        v,
        xyz_center,
        index_center,
        use_subregion,
        use_step,
        )

Return center in submatrix index units.

  zflip_operation 
zflip_operation (
        v,
        use_subregion,
        use_step,
        in_place,
        model_id,
        )
  filter_volumes 
filter_volumes ( models,  keyword=None )
Exceptions   

MidasError, 'No %svolumes specified by "%s"' %( keyword, models )
MidasError, 'Model %s is not a volume' % v.name
MidasError, 'No %svolumes specified' % keyword

  volume_operation 
volume_operation (
        volumes,
        operation,
        center=None,
        iCenter=None,
        fillValue=None,
        onGrid=None,
        map=None,
        modelId=None,
        inPlace=None,
        useSubregion=None,
        useStep=None,
        )
Exceptions   

MidasError, 'Cannot subtract grids of different size'
MidasError, ('Unknown operation "%s", use %s' %(operation, ', '.join( operations ) ) )
MidasError, 'Cannot subtract grids with different subregions'
MidasError, 'Resample operation must specify onGrid option'
MidasError, "Can't modify volume in place: %s" % names
MidasError, '%s must be number, got "%s"' %(name, str( val ) )
MidasError, 'Subtract operation must specify map option'
MidasError, 'modelId must be integer, got "%s"' % str( modelId )

  vop_command 
vop_command ( cmdname,  args )

Command to perform volume operations that create a new volume, such as erasing an octant, sphere, zone, Gaussian filtering, Fourier transform, ....

Syntax: vop [radius ] [center ] [iCenter ] [fillValue ] [sDev ] [onGrid ] [map ] [modelId ] [inPlace true|false] [useSubregion true|false] [useStep true|false]

where op is one of octant, ~octant, resample, zflip, subtract. Plan to add operations sphere, ~sphere, zone, ~zone, gaussian

  parse_floats 
parse_floats (
        value,
        name,
        count,
        default=None,
        )
Exceptions   

MidasError, ('%s value must be %d comma-separated numbers, got %s' %(name, count, str( value ) ) )

  octant_operation 
octant_operation (
        v,
        outside,
        center,
        iCenter,
        useSubregion,
        useStep,
        inPlace,
        fillValue,
        modelId,
        )
  subtract_operation 
subtract_operation (
        v,
        sv,
        useSubregion,
        useStep,
        inPlace,
        modelId,
        )
  resample_operation 
resample_operation (
        v,
        gv,
        useSubregion,
        useStep,
        inPlace,
        modelId,
        )
Classes   

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