HappyDoc Generated Documentation Class: NetCDF_Data

. / VolumeData / netcdf / netcdf_format.py / NetCDF_Data 

Read NetCDF 3 dimensional array data.

Use variables or global attributes xyz_origin and xyz_step, each triples of floats, to define embedding of 3D data matrices in xyz coordinate space.

3D array variables can have any name. Every 3D array is considered. Each becomes a separate component. If they don't all have the same size then one size is chosen arbitrarily and only 3D arrays with that size are used.

A color can be associated with each 3D array saved as an rgba value as an attribute called rgba or with a variable with name matching the array name with _color appended.

NetCDF doesn't have unsigned integral types. To indicate a 3D integer array is supposed to be unsigned save the NumPy typecode in an attribute called numpy_typecode or in a variable named the same as the 3D array with "_typecode" appended.

Methods   
  read_components 
read_components (
        self,
        f,
        path,
        )
  read_vector 
read_vector (
        self,
        f,
        name,
        default,
        )
  read_variable_typecode 
read_variable_typecode (
        self,
        f,
        name,
        )
  read_variable_color 
read_variable_color (
        self,
        f,
        name,
        )
  read_component_name 
read_component_name ( self,  f )
  read_subsample_components 
read_subsample_components (
        self,
        f,
        data_names,
        ctable,
        )
  read_float 
read_float (
        self,
        f,
        name,
        default,
        )
  read_rotation 
read_rotation ( self,  f )
  read_xyz_origin 
read_xyz_origin ( self,  f )
  read_variable_name 
read_variable_name (
        self,
        f,
        name,
        )
  read_cell_angles 
read_cell_angles ( self,  f )
  read_xyz_step 
read_xyz_step ( self,  f )
  default_color 
default_color ( self,  n )
  __init__ 
__init__ ( self,  path )

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