aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortradke <tradke@4825ed28-b72c-4eae-9704-e50c059e567d>2004-01-30 17:37:45 +0000
committertradke <tradke@4825ed28-b72c-4eae-9704-e50c059e567d>2004-01-30 17:37:45 +0000
commit17f2c57679acf906844de2491e6269f036048f70 (patch)
tree3f1958ce39858c205d6d22cb13a392657bbd3a17
parent62ee8e4eeee53dbadc5224b55ed1f57fb168ee8f (diff)
Fixed description of hyperslab selection parameters.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOHDF5/trunk@178 4825ed28-b72c-4eae-9704-e50c059e567d
-rw-r--r--doc/documentation.tex11
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 0ae8480..9e8ef13 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -120,8 +120,7 @@ other grid point will be output.
IOHDF5::out_every = 1
IOHDF5::out_vars = "Grid::x[ out_every = 5 ]
Wavetoy::phi[ origin = {4 4 4}
- direction = {0 0 0
- 0 1 0
+ direction = {0 1 0
0 0 1}
extent = {10 20}
downsample = {2 2} ]"
@@ -129,13 +128,13 @@ other grid point will be output.
The hyperslab parameters which can be set in an option string are:
\begin{itemize}
- \item{\tt origin}\\
+ \item{\tt origin[N]}\\
This specifies the origin of the hyperslab. It must be given as an array
of integer values with $N$ elements. Each value specifies the offset in
grid points in this dimension into the N-dimensional volume of the grid
variable.\\
If the origin for a hyperslab is not given, if will default to 0.
- \item{\tt direction}\\
+ \item{\tt direction[N][M]}\\
The direction vectors specify both the directions in which the hyperslab
should be spanned (each vector defines one direction of the hyperslab)
and its dimensionality ($=$ the total number of dimension vectors).
@@ -145,7 +144,7 @@ The hyperslab parameters which can be set in an option string are:
If the direction vectors for a hyperslab are not given, the hyperslab
dimensions will default to $N$, and its directions are parallel to the
underlying grid.
- \item{\tt extent}\\
+ \item{\tt extent[M]}\\
This specifies the extent of the hyperslab in each of its dimensions as
a number of grid points. It must be given as an array of integer values
with $M$ elements ($M$ being the number of hyperslab dimensions).\\
@@ -153,7 +152,7 @@ The hyperslab parameters which can be set in an option string are:
variable's extent. Note that if the origin is set to
a non-zero value, you should also set the hyperslab extent otherwise
the default extent would possibly exceed the variable's grid extent.
- \item{\tt downsample}\\
+ \item{\tt downsample[M]}\\
To select only every so many grid points from the hyperslab you can set
the downsample option. It must be given as an array of integer values
with $M$ elements ($M$ being the number of hyperslab dimensions).\\