[Vapor-cvs] vapor/share/doc/man raw2vdf.pod, 1.1, 1.2 vdfcreate.pod, 1.4, 1.5

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/vapor/vapor/share/doc/man
In directory sfp-cvsdas-3.v30.ch3.sourceforge.com:/tmp/cvs-serv10508/share/doc/man

Modified Files:
	raw2vdf.pod vdfcreate.pod 
Log Message:
Fixed 3117717 - vdfcreate and raw2vdf need more VDC2 guidance

Index: vdfcreate.pod
===================================================================
RCS file: /cvsroot/vapor/vapor/share/doc/man/vdfcreate.pod,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** vdfcreate.pod	8 Jul 2010 21:03:45 -0000	1.4
--- vdfcreate.pod	29 Nov 2010 22:12:07 -0000	1.5
***************
*** 24,31 ****
  particular solution variable).

! Data volumes in a VDC are represented hiearchically: each volume may
! be accessed at varying, power-of-two coarsened approximations. Moreover,
! two types of VDC files are supported: VDC1 and VDC2. The latter, VDC2,
! supports level-of-detail access in addtion to hierarchical access.

  =head1 OPTIONS
--- 24,32 ----
  particular solution variable).

! Data volumes in a VDC are represented hiearchically: each volume
! may be accessed at varying, power-of-two coarsened approximations.
! Moreover, two types of VDC files are supported: VDC Type 1 (VDC1)
! and VDC Type 2 (VDC2).  The latter, VDC2, supports level-of-detail
! access in addtion to hierarchical access. The default type is VDC1.

  =head1 OPTIONS
***************
*** 35,42 ****
  =item -cratios E<lt>vector<gt>

! This option (VDC 2 only) specifies a colon delimited list of
  compression ratios. The minimum compression ratio is 1 (indicating no
  compression). The maximum is determined by the wavelet familiy (See
! B<-wname>) and the block dimension (See B<-bs>).

--- 36,44 ----
  =item -cratios E<lt>vector<gt>

! This option (VDC2 only) specifies a colon delimited list of
  compression ratios. The minimum compression ratio is 1 (indicating no
  compression). The maximum is determined by the wavelet familiy (See
! B<-wname>) and the block dimension (See B<-bs>). The default compression 
! ratio vector is 500:100:10:1.

***************
*** 69,78 ****
  =item -bs E<lt>NXxNYxNZE<gt>

! The internal storage blocking factor expressed in voxels. In general this 
! should not be changed from the default value.

  =item -level E<lt>levelE<gt>

! This option specifies the number of refinement levels in the VDC data
  approximation hierarchy. Starting with the native grid resolution, each
  successive level in the hierarchy is a factor of two smaller along each
--- 71,81 ----
  =item -bs E<lt>NXxNYxNZE<gt>

! The internal storage blocking factor expressed in voxels. In general
! this should not be changed from the default value (32x32x32 for
! VDC1, and 64x64x64 for VDC2).

  =item -level E<lt>levelE<gt>

! This option specifies the number of refinement levels in a Type 1 VDC data
  approximation hierarchy. Starting with the native grid resolution, each
  successive level in the hierarchy is a factor of two smaller along each
***************
*** 97,107 ****
  constructing a Lifting wavelet for transforming data into
  the VDC. In general this option should not be changed from the default
! value, one.

  =item -nlifting E<lt>nE<gt>

  Specifies the number of wavelet lifting coefficients to be used when
! constructing a Lifting wavelet for transforming data into the VDC. In
! general this option should not be changed from the default value, one.

  =item -comment E<lt>stringE<gt>
--- 100,111 ----
  constructing a Lifting wavelet for transforming data into
  the VDC. In general this option should not be changed from the default
! value, one. VDC1 only.

  =item -nlifting E<lt>nE<gt>

  Specifies the number of wavelet lifting coefficients to be used when
! constructing a Lifting wavelet for transforming data into the VDC.
! In general this option should not be changed from the default value,
! one. VDC1 only.

  =item -comment E<lt>stringE<gt>
***************
*** 199,203 ****
  =item -vdc2 

! Generate a .vdf file for a VDC version 2 data collection.

  =item -wname E<lt>wave_name<gt>
--- 203,207 ----
  =item -vdc2 

! Generate a .vdf file for a VDC Type 2 data collection.

  =item -wname E<lt>wave_name<gt>
***************
*** 216,228 ****
  The command 

! C<vdfcreate -dimension 512x512x512 -numts 100 -level 3 -varnames vx:vy:vz
! foo.vdf>

! will produce a VDF file named, B<foo.vdf>. This file will describe a VDC
! containing up to 100 time steps, starting from 0 and running through 99; three 
! field variables, B<vx>, B<vy>, and B<vz>; each volume would have a 
! spatial resolution of 512^3; and three wavelet transformations would
! be applied resulting in data approximations at resolutions 64^4, 
! 128^3, and 256^3.

  =head1 SEE ALSO
--- 220,231 ----
  The command 

! C<vdfcreate -dimension 512x512x512 -numts 100 -level 3 -varnames vx:vy:vz foo.vdf>

! will produce a VDC Type 1 VDF file named, B<foo.vdf>.  This file
! will describe a VDC containing up to 100 time steps, starting from
! 0 and running through 99; three field variables, B<vx>, B<vy>, and
! B<vz>; each volume would have a spatial resolution of 512^3; and
! three wavelet transformations would be applied resulting in data
! approximations at resolutions 64^4, 128^3, and 256^3.

  =head1 SEE ALSO

Index: raw2vdf.pod
===================================================================
RCS file: /cvsroot/vapor/vapor/share/doc/man/raw2vdf.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** raw2vdf.pod	11 Sep 2008 19:42:16 -0000	1.1
--- raw2vdf.pod	29 Nov 2010 22:12:07 -0000	1.2
***************
*** 44,52 ****

  This option can be used to limit the wavelet approximation hierarchy
! written to the VDC. By default, I<level> == -1, and all levels of the
  approximation hierarchy computed by the wavelet transform are stored
  in the VDC. If I<level> is 0, only the coarsest approximation is saved.
  If I<level> is 1, the coarsest approximation, and first refinement are
! saved. And so on.

  =item -quiet
--- 44,53 ----

  This option can be used to limit the wavelet approximation hierarchy
! written to a Type 1 VDC. By default, I<level> == -1, and all levels of the
  approximation hierarchy computed by the wavelet transform are stored
  in the VDC. If I<level> is 0, only the coarsest approximation is saved.
  If I<level> is 1, the coarsest approximation, and first refinement are
! saved. And so on. This option is not supported for VDC Type 2 and is silently
! ignored if present.

  =item -quiet