HappyDoc Generated Documentation ./Mask/maskcommand.py

. / Mask / maskcommand.py 

Functions   
  mask_command 
mask_command ( cmdname,  args )

Command to extract a piece of a volume data set within a surface.

mask [axis ] [fullMap true|false] [pad ] [slab |] [sandwich true|false]

mask #0 #1 axis 0,0,1 fullmap true pad 10

masks volume #0 using surface #1 via projection along the z axis, and makes a full copy of the map (rather than a minimal subregion) and expands the surface along its per-vertex normal vectors before masking.

  mask 
mask (
        volumes,
        surfaces,
        axis=None,
        fullMap=None,
        pad=None,
        slab=None,
        sandwich=None,
        )
Exceptions   

MidasError, 'No surfaces specified'
MidasError, 'pad option value must be a number'
MidasError, 'sandwich option value must be true or false'
MidasError, 'fullMap option value must be true or false'

Classes   

This document was automatically generated Fri May 30 21:13:45 2008 by HappyDoc version 3.1