diff options
| author | Shashank | 2017-05-29 12:40:26 +0530 |
|---|---|---|
| committer | Shashank | 2017-05-29 12:40:26 +0530 |
| commit | 0345245e860375a32c9a437c4a9d9cae807134e9 (patch) | |
| tree | ad51ecbfa7bcd3cc5f09834f1bb8c08feaa526a4 /modules/hdf5/help | |
| download | scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.gz scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.bz2 scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.zip | |
CMSCOPE changed
Diffstat (limited to 'modules/hdf5/help')
70 files changed, 8229 insertions, 0 deletions
diff --git a/modules/hdf5/help/en_US/addchapter.sce b/modules/hdf5/help/en_US/addchapter.sce new file mode 100755 index 000000000..63e2d78d4 --- /dev/null +++ b/modules/hdf5/help/en_US/addchapter.sce @@ -0,0 +1,10 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2011 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("HDF5 Management",SCI+"/modules/hdf5/help/en_US",%T);
\ No newline at end of file diff --git a/modules/hdf5/help/en_US/h5attr.xml b/modules/hdf5/help/en_US/h5attr.xml new file mode 100755 index 000000000..4f6b3f0aa --- /dev/null +++ b/modules/hdf5/help/en_US/h5attr.xml @@ -0,0 +1,123 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5attr" xml:lang="en"> + <refnamediv> + <refname>h5attr</refname> + <refpurpose>Create an attribute</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5attr(obj, location, name, data [, targetType]) + h5attr(filename, location, name, data [, targetType]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the location in the object or in the file</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to the new dataset</para> + </listitem> + </varlistentry> + <varlistentry> + <term>data</term> + <listitem> + <para>a Scilab data</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetType</term> + <listitem> + <para>a string giving the type of the target</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Create a new named attribute based on the Scilab data passed as argument.</para> + <para> + The target HDF5 type can be chosen in the list available in the <ulink url="http://www.hdfgroup.org/HDF5/doc/RM/PredefDTypes.html">HDF5 manual</ulink>. + Examples of this HDF5 type are "H5T_MIPS_U32" or "H5T_STD_B64BE", but shortcuts as "MIPS_U32" or "STD_B64BE" can also be used. + </para> + <para>An attribute can be located in a group or in a dataset</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = 1:5 + %pi; +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// We open the file +a = h5open(TMPDIR + "/x.sod"); + +// Add an attribute to the root element +h5attr(a, ".", "My Attribute", int8(123)); + +// Check +h5dump(a) + +// ...or +a.root("My Attribute").data + +// Add an attribute to the dataset named "x" +h5attr(a, "/x", "My Dataset Attribute", int16(321)); + +// Check +h5dump(a.root.x) + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5attr">h5dataset</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5close.xml b/modules/hdf5/help/en_US/h5close.xml new file mode 100755 index 000000000..4b0771550 --- /dev/null +++ b/modules/hdf5/help/en_US/h5close.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5close" xml:lang="en"> + <refnamediv> + <refname>h5close</refname> + <refpurpose>Close a HDF5 object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5close([obj_1 [, obj_2 [, ...]]]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj_i</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Close an object and all its descendants. That allows to free all the memory associated to this object.</para> + <para>All the buffers associated to the file are flushed before closing it.</para> + <para>With no arguments, all the opened objects are closed.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = ["Hello" "World"; "Salut" "Monde"]; +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// Dump the file content +h5dump(a); + +// Open the dataset named "x" +ds = a.root.x + +// Get the attribute 'SCILAB_Class' +attr = ds.SCILAB_Class + +// Read its value +attr.data + +// Get the data from ds +d = ds.data + +// We have finished with the dataset +h5close(ds) + +// attr has been open from ds so attr is now not available +// ... so an error +attr + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5cp.xml b/modules/hdf5/help/en_US/h5cp.xml new file mode 100755 index 000000000..e87fc77c8 --- /dev/null +++ b/modules/hdf5/help/en_US/h5cp.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5cp" xml:lang="en"> + <refnamediv> + <refname>h5cp</refname> + <refpurpose>Copy an object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5cp(srcobj [, srcloc], destobj [, destloc]) + h5cp(srcobj [, srcloc], destfile, destloc) + h5cp(srcfile, srcloc, destobj [, destloc]) + h5cp(srcfile, srcloc, destfile, destloc) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>srcobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcloc</term> + <listitem> + <para>a string giving the source location</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destloc</term> + <listitem> + <para>a string giving the destination location</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcfile</term> + <listitem> + <para>a string the source filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destfile</term> + <listitem> + <para>a string giving the destination filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Copy an object to another place (same file or not).</para> + <para>Before copying a newly created object, the file must be flushed.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a HDF5 file +a = h5open(TMPDIR + "/test.h5"); +b = h5open(TMPDIR + "/test1.h5"); + +// We create a group and a dataset +h5group(a, "Grp_1"); +h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]); + +// We flush the file to be sure that the modifications +// will be taken into account when the copy will occur +h5flush(a); + +// Create a group and a dataset in b +h5group(b, "BGrp"); +h5write(b("/BGrp"), "BDset", 11:18); +h5close(b) + +// Now we copy Dset_1 to Dset_2 located under root +h5cp(a.root.Grp_1, "Dset_1", a, "Dset_2") + +// Copy BDset to a dataset under Grp_1 +h5cp(TMPDIR +"/test1.h5", "/BGrp/BDset", a.root.Grp_1) + +// We can change the destination name +h5cp(TMPDIR +"/test1.h5", "/BGrp/BDset", a.root.Grp_1, "The Foo Dataset") + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5mv">h5mv</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5rm">h5rm</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5flush">h5flush</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5dataset.xml b/modules/hdf5/help/en_US/h5dataset.xml new file mode 100755 index 000000000..c79277929 --- /dev/null +++ b/modules/hdf5/help/en_US/h5dataset.xml @@ -0,0 +1,161 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5dataset" xml:lang="en"> + <refnamediv> + <refname>h5dataset</refname> + <refpurpose>Create a dataset and write the data</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5dataset(obj, name, sourceInfo [, sourceType], data, targetInfo [, targetType]) + h5dataset(filename, name, sourceInfo [, sourceType], data, targetInfo [, targetType]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to the new dataset</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sourceInfo</term> + <listitem> + <para>a matrix 5xn of doubles</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sourceType</term> + <listitem> + <para>a string giving the type of the source</para> + </listitem> + </varlistentry> + <varlistentry> + <term>data</term> + <listitem> + <para>a Scilab data</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetInfo</term> + <listitem> + <para>a matrix 6xn of doubles</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetType</term> + <listitem> + <para>a string giving the type of the target</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Create a new named dataset (if it does not exist) based on the Scilab data passed as argument.</para> + <para> + The target HDF5 type can be chosen in the list available in the <ulink url="http://www.hdfgroup.org/HDF5/doc/RM/PredefDTypes.html">HDF5 manual</ulink>. + Examples of this HDF5 type are "H5T_MIPS_U32" or "H5T_STD_B64BE", but shortcuts as "MIPS_U32" or "STD_B64BE" can also be used. + </para> + <para>The source info gives information on how to get the data. It is a matrix 5xn where n is the number of dimensions of the data. The rows give the following information:</para> + <simplelist type="inline"> + <member> + 1st row: the data dimensions. + </member> + <member> + 2nd row: the start point of the hyperslab. + </member> + <member> + 3rd row: the hyperslab's count. + </member> + <member> + 4th row: the hyperslab's stride. + </member> + <member> + 5th row: the hyperslab's block. + </member> + </simplelist> + <para> + For more explanation about hyperslab selection, see <link linkend="h5write">h5write</link>. + </para> + <para>The targetInfo matrix is 6xn double matrix. The first row gives the dimensions of the target dataset and the second one gives the maximal possible dimensions. When the first and the second row are not equal, the dataset will be chunked. The rows 3 to 6 give the hyperslab's start, count, stride and block.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a new HDF5 file +a = h5open(TMPDIR + "/test.h5", "w") + +// The data +x = uint32(1:100); +y = uint32(1:9); + +// We create the dataset +// x is viewed as a C-matrix (row-major) +h5dataset(a, "My_Dataset", [10 10 ; 2 1 ; 4 1 ; 2 1 ; 1 9], x, [7 12 ; 9 14 ; 3 3 ; 1 1 ; 1 1 ; 4 9]) +h5dump(a, "My_Dataset"); + +// We add y data in extending the dataset dimensions +h5dataset(a, "My_Dataset", [9 1 ; 1 1 ; 1 1 ; 1 1 ; 9 1], y, [9 12 ; 9 14 ; 1 1 ; 1 1 ; 1 1 ; 9 1]) +h5dump(a, "My_Dataset"); + +// We can replace the y data +h5dataset(a, "My_Dataset", [9 1 ; 1 1 ; 1 1 ; 1 1 ; 9 1], uint32(11:19), [9 12 ; 9 14 ; 1 1 ; 1 1 ; 1 1 ; 9 1]) +h5dump(a, "My_Dataset"); + +// Free all the resources +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + <member> + <link linkend="h5write">h5write</link> + </member> + <member> + <link linkend="h5writeattr">h5writeattr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5dump.xml b/modules/hdf5/help/en_US/h5dump.xml new file mode 100755 index 000000000..5f52bf8c4 --- /dev/null +++ b/modules/hdf5/help/en_US/h5dump.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5dump" xml:lang="en"> + <refnamediv> + <refname>h5dump</refname> + <refpurpose>Dump the content of an H5 object on the standard output stream</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5dataset(obj, name) + h5dataset(filename, name) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to dump</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Write the content of an H5 object in the standard output stream. Useful to help debugging and checking that everything is ok with the object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a new HDF5 file +a = h5open(TMPDIR + "/test.h5", "a") + +// The data +h5write(a, "DS1", 1:10); +h5write(a, "DS2", uint16(1:10)); +h5write(a, "DS3", ["Hello" "World"]); +h5writeattr(a, "/DS3", "ATT3.1", "String Matrix") + +// We can dump all the file +h5dump(a) + +// ...or only the third dataset +h5dump(a, "/DS3") + +// Free all the resources +h5close(a) + +// We can dump without explicitely open the file +h5dump(TMPDIR + "/test.h5"); + +// ... or only the third dataset +h5dump(TMPDIR + "/test.h5", "/DS3"); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5exists.xml b/modules/hdf5/help/en_US/h5exists.xml new file mode 100755 index 000000000..decfced66 --- /dev/null +++ b/modules/hdf5/help/en_US/h5exists.xml @@ -0,0 +1,113 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5exists" xml:lang="en"> + <refnamediv> + <refname>h5exists</refname> + <refpurpose>Test the existence of named object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5exists(obj, locations) + b = h5exists(obj, location, attrNames) + b = h5exists(filename, locations) + b = h5exists(filename, location, attrNames) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>locations</term> + <listitem> + <para>a matrix of string containing the path to check</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the location where to check the attributes names</para> + </listitem> + </varlistentry> + <varlistentry> + <term>attrNames</term> + <listitem> + <para>a matrix of string containing the attributes names to check</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a matrix of booleans</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check the existence of a named object or an attribute.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = 123; +y = 321; +save(TMPDIR + "/xy.sod", "x", "y"); + +// We open the file +a = h5open(TMPDIR + "/xy.sod", "r"); + +// Check existence of datasets "x", "y" and "z" +// "z" does not exist... +h5exists(a, ["x" "y" "z"]) + +// Check presence of Silab attributes +h5exists(a, "/", ["SCILAB_sod_version", "SCILAB_scilab_version"]) + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5get">h5get</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5flush.xml b/modules/hdf5/help/en_US/h5flush.xml new file mode 100755 index 000000000..d214470c1 --- /dev/null +++ b/modules/hdf5/help/en_US/h5flush.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5flush" xml:lang="en"> + <refnamediv> + <refname>h5flush</refname> + <refpurpose>Flush all the buffers associated with a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5flush(obj [, local]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>local</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Flush all the buffers associated with a file. If local is %T, only the file is flushed, otherwise the entire virtual file is flushed.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a HDF5 file +a = h5open(TMPDIR +"/test.h5", "w"); + +// Write a dataset +h5write(a, "MyDset", 1:100); + +// We flush the file +h5flush(a); + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5open">h5close</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5get.xml b/modules/hdf5/help/en_US/h5get.xml new file mode 100755 index 000000000..3a8c5e0dc --- /dev/null +++ b/modules/hdf5/help/en_US/h5get.xml @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5get" xml:lang="en"> + <refnamediv> + <refname>h5get</refname> + <refpurpose>Get a named object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + nobj = h5get(obj, location [, isAttr]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the location</para> + </listitem> + </varlistentry> + <varlistentry> + <term>isAttr</term> + <listitem> + <para>a boolean to indicate that an attribute must be got</para> + </listitem> + </varlistentry> + <varlistentry> + <term>nobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Get the object with the given location under obj. If isAttr is %T, an H5 object is returned (if it exists), by default isAttr is %F.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = ["Hello" "World"; "Salut" "Monde"]; +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// Get the root object, this equivalent to a.root or a("/") +r = h5get(a, "/") + +// Get the dataset "x" +x = h5get(a, "/x") // or h5get(a.root, "x") +x.data + +// Get an unexisting dataset +y = h5get(a.root, "blahblah") + +// Get an attribute +attr = h5get(a.root, "SCILAB_scilab_version", %t) +attr.data + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5group.xml b/modules/hdf5/help/en_US/h5group.xml new file mode 100755 index 000000000..5a291faf1 --- /dev/null +++ b/modules/hdf5/help/en_US/h5group.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5group" xml:lang="en"> + <refnamediv> + <refname>h5group</refname> + <refpurpose>Create a group</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5group(obj, names) + h5group(filename, names) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>a matrix of strings giving the names</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Create a set of groups.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a file +a = h5open(TMPDIR + "/test_group.h5", "a"); + +// We create a set of 10 groups containg 10 subgroups +// Firstly, we create the names +gnames = "Group_" + string(1:10); +sgnames = "SubGroup_" + string(1:10); +names = gnames; +for s=gnames + names = [names s + "/" + sgnames] +end + +// Secondly, we create the groups +h5group(a, names); + +// We can check that all is ok +h5ls(a) + +// ...and +h5ls(a, "Group_3") + +// Free the resources associated to a +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isArray.xml b/modules/hdf5/help/en_US/h5isArray.xml new file mode 100755 index 000000000..07680ab87 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isArray.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isArray" xml:lang="en"> + <refnamediv> + <refname>h5isArray</refname> + <refpurpose>Check if the HDF5 object is an array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isArray(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is an array object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = (1:10) + %i*(20:29); +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isArray(a) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isCompound">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isAttr.xml b/modules/hdf5/help/en_US/h5isAttr.xml new file mode 100755 index 000000000..cbfeecf67 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isAttr.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isAttr" xml:lang="en"> + <refnamediv> + <refname>h5isAttr</refname> + <refpurpose>Check if the HDF5 object is an attribute</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isAttr(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is an attribute object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = 1:10; +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isAttr(a) + +// Test against attribute 'SCILAB_scilab_version' +h5isAttr(a.root.SCILAB_scilab_version) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isCompound.xml b/modules/hdf5/help/en_US/h5isCompound.xml new file mode 100755 index 000000000..3e0b74945 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isCompound.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isCompound" xml:lang="en"> + <refnamediv> + <refname>h5isCompound</refname> + <refpurpose>Check if the HDF5 object is a compound object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isCompound(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a compound object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = (1:10) + %i*(20:29); +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isCompound(a) + +// Test against root.x.data +h5isCompound(a.root.x.data) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isFile.xml b/modules/hdf5/help/en_US/h5isFile.xml new file mode 100755 index 000000000..1e86ff2ed --- /dev/null +++ b/modules/hdf5/help/en_US/h5isFile.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isFile" xml:lang="en"> + <refnamediv> + <refname>h5isFile</refname> + <refpurpose>Check if the HDF5 object is a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isFile(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a file object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = 1:10; +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isFile(a) + +// Test against root +h5isFile(a.root) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isGroup.xml b/modules/hdf5/help/en_US/h5isGroup.xml new file mode 100755 index 000000000..0fce5fb73 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isGroup.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isGroup" xml:lang="en"> + <refnamediv> + <refname>h5isGroup</refname> + <refpurpose>Check if the HDF5 object is a group</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isGroup(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a group object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = 1:10; +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isGroup(a) + +// Test against root +h5isGroup(a.root) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isRef.xml b/modules/hdf5/help/en_US/h5isRef.xml new file mode 100755 index 000000000..1e49ec5e6 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isRef.xml @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isRef" xml:lang="en"> + <refnamediv> + <refname>h5isRef</refname> + <refpurpose>Check if the HDF5 object is a reference object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isRef(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a reference object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = list(1, "hello"); +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isRef(a) + +// Test against the references in the dataset named 'x' +y = a.root.x.data; +h5isRef(y) + +// Get the reference values +y(1).data, y(2).data + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isSet.xml b/modules/hdf5/help/en_US/h5isSet.xml new file mode 100755 index 000000000..316f47769 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isSet.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isSet" xml:lang="en"> + <refnamediv> + <refname>h5isSet</refname> + <refpurpose>Check if the HDF5 object is a dataset</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isSet(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a dataset object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = 1:10; +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isSet(a) + +// Test against dataset 'x' +h5isSet(a.root.x) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isSpace.xml b/modules/hdf5/help/en_US/h5isSpace.xml new file mode 100755 index 000000000..674238ff8 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isSpace.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isSpace" xml:lang="en"> + <refnamediv> + <refname>h5isSpace</refname> + <refpurpose>Check if the HDF5 object is a dataspace</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isSpace(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a dataspace object.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = 1:10; +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isSpace(a) + +// Test against the dataspace associated to dataset 'x' +h5isSpace(a.root.x.dataspace) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isType.xml b/modules/hdf5/help/en_US/h5isType.xml new file mode 100755 index 000000000..cc1c010c9 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isType.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isType" xml:lang="en"> + <refnamediv> + <refname>h5isType</refname> + <refpurpose>Check if the HDF5 object is a type</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isType(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a type.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = 1:10; +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isType(a) + +// Test against the type associated to dataset 'x' +h5isType(a.root.x.type) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5isVlen.xml b/modules/hdf5/help/en_US/h5isVlen.xml new file mode 100755 index 000000000..d60c0dba4 --- /dev/null +++ b/modules/hdf5/help/en_US/h5isVlen.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isVlen" xml:lang="en"> + <refnamediv> + <refname>h5isVlen</refname> + <refpurpose>Check if the HDF5 object is a variable length array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = h5isVlen(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Check if an HDF5 object is a variable length array.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create a SOD file which an HDF5 one +x = (1:10) + %i*(20:29); +save(TMPDIR + "/x.sod", "x"); + +// Open the file +a = h5open(TMPDIR + "/x.sod", "r"); + +// Test +h5isVlen(a) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isCompound">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isArray</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5label.xml b/modules/hdf5/help/en_US/h5label.xml new file mode 100755 index 000000000..db8deadf5 --- /dev/null +++ b/modules/hdf5/help/en_US/h5label.xml @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5label" xml:lang="en"> + <refnamediv> + <refname>h5label</refname> + <refpurpose>Label a dataset</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5label(obj, location, dims, names) + h5label(filename, location, dims, names) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the location</para> + </listitem> + </varlistentry> + <varlistentry> + <term>dims</term> + <listitem> + <para>a row of doubles</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>a row of strings with the same size as dims</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Label a dataset according to dims and names. The <code>dims(i)</code>-nth dimension is labelled with <code>names(i)</code>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create an HDF5 file +a = h5open(TMPDIR + "/test.h5", "w") + +// The data +x = uint8(1:24); + +// We make a dataset with x as an hypermatrix 1x2x3x4 +h5dataset(a, "My Dataset", [1 2 3 4 ; 1 1 1 1 ; 1 1 1 1 ; 1 1 1 1; 1 2 3 4], x, [1 2 3 4 ; 1 2 3 4 ; 1 1 1 1 ; 1 1 1 1 ; 1 1 1 1 ; 1 2 3 4]); + +// We label it +h5label(a, "My Dataset", [1 3], ["Hello" "World"]); + +// We check +h5dump(a) + +// We close all +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5ln.xml b/modules/hdf5/help/en_US/h5ln.xml new file mode 100755 index 000000000..f760957d6 --- /dev/null +++ b/modules/hdf5/help/en_US/h5ln.xml @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5ln" xml:lang="en"> + <refnamediv> + <refname>h5ln</refname> + <refpurpose>Link an object to another one</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5ln(obj, linkname, destobj [, hard]) + h5ln(obj, linkname, destname [, hard]) + h5ln(obj, linkname, destfile, destname) + h5ln(filename, location, linkname, destname [, hard]) + h5ln(filename, location, linkname, destfile, destname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>linkname</term> + <listitem> + <para>a string giving the link name</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destfile</term> + <listitem> + <para>a string giving the destination filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>hard</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the location in the file</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Create a hard, soft or external link. When destfile is given, it is always an external link. By default hard is set to false, so by default a soft link is created.</para> + <para>Soft links can be created even if the target does not exist.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a HDF5 file +a = h5open(TMPDIR + "/test.h5"); +b = h5open(TMPDIR + "/test1.h5"); + +// We create a group and a dataset +h5group(a, "Grp_1"); +h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]); +h5group(b, "BGrp"); +h5write(b("/BGrp"), "BDset", 11:18); +h5close(b) + +// We create a second group and add a link +h5group(a, "Grp_2"); +h5ln(a, "Hard_Link", "/Grp_1/Dset_1", %t) +h5ln(a, "Soft_Link", "/Grp_1/Dset_1") +h5ln(a, "External_Link", TMPDIR +"/test1.h5", "/BGrp") + +// We check +h5dump(a) + +// Check the external link +a.root.External_Link.BDset.data + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5ls.xml b/modules/hdf5/help/en_US/h5ls.xml new file mode 100755 index 000000000..62d9fa9bd --- /dev/null +++ b/modules/hdf5/help/en_US/h5ls.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5ls" xml:lang="en"> + <refnamediv> + <refname>h5ls</refname> + <refpurpose>List the content of an HDF5 object (group or dataset)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + content = h5ls(obj [, name [, filter]]) + content = h5ls(filename, name [, filter]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to the object to list</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filter</term> + <listitem> + <para>a string giving the type to filter</para> + </listitem> + </varlistentry> + <varlistentry> + <term>content</term> + <listitem> + <para>a matrix of strings with 2 columns</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>List the content of a group or a dataset. The first column gives the names and the second one the type of the listed element.</para> + <para>The filter can take one of the values 'group' (or 'g'), 'dataset' (or 'd'), 'type' (or 't') and 'attribute' (or 'a'). For example, if 'g' is given, only the groups will be returned.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = int8(matrix(1:80, 10, 8)); +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// We list the content of a +h5ls(a) + +// only the dataset +h5ls(a, ".", "d") + +// only the attributes +h5ls(a, ".", "a"); + +// We can see a dataset named x, list it +h5ls(a.root.x) // a.root.x is equivalent to a("/x") + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5mount.xml b/modules/hdf5/help/en_US/h5mount.xml new file mode 100755 index 000000000..4f9d87266 --- /dev/null +++ b/modules/hdf5/help/en_US/h5mount.xml @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5mount" xml:lang="en"> + <refnamediv> + <refname>h5mount</refname> + <refpurpose>Mount a file on a group</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5mount(obj, location, fileobj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the mount point</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fileobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Mount an HDF5 file on a mount point.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create an HDF5 file +a = h5open(TMPDIR + "/test.h5", "w") + +// we create a group which will be used as mount point +h5group(a, "/mnt"); + +// Create an other file with a group and a dataset +b = h5open(TMPDIR + "/test1.h5", "w") +h5group(b, "Group_1"); +h5write(b, "Group_1/Dataset_1", [1 2;3 4]); + +// Mount b on a +h5mount(a, "/mnt", b) + +// Now we can modify or read b like if we were in a +a.root.mnt.Group_1.Dataset_1.data +h5write(a.root.mnt.Group_1, "Dataset_1", [10 11;12 13]) + +// We can now unmount and remove the mount point +h5umount(a, "/mnt") +h5rm(a, "/mnt") + +// We close all +h5close(a, b) + +// Check that the modification in b is ok +h5dump(TMPDIR + "/test1.h5", "/Group_1/Dataset_1") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5umount">h5umount</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5mv.xml b/modules/hdf5/help/en_US/h5mv.xml new file mode 100755 index 000000000..2913ccb63 --- /dev/null +++ b/modules/hdf5/help/en_US/h5mv.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5mv" xml:lang="en"> + <refnamediv> + <refname>h5mv</refname> + <refpurpose>Move an object</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5mv(srcobj [, srcloc], destobj [, destloc]) + h5mv(srcobj [, srcloc], destfile, destloc) + h5mv(srcfile, srcloc, destobj [, destloc]) + h5mv(srcfile, srcloc, destfile, destloc) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>srcobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destobj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcloc</term> + <listitem> + <para>a string giving the source location</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destloc</term> + <listitem> + <para>a string giving the destination location</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcfile</term> + <listitem> + <para>a string the source filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destfile</term> + <listitem> + <para>a string giving the destination filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Move an object to another place (same file or not). This command is equivalent to <code>h5cp</code> followed by <code>h5rm</code>. + </para> + <para>Before moving a newly created object, the file must be flushed.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// We create a HDF5 file +a = h5open(TMPDIR + "/test.h5"); +b = h5open(TMPDIR + "/test1.h5"); + +// We create a group and a dataset +h5group(a, "Grp_1"); +h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]); + +// We flush the file to be sure that the modifications +// will be taken into account when the move will occur +h5flush(a); + +// Create a group and a dataset in b +h5group(b, "BGrp"); +h5write(b("/BGrp"), "BDset", 11:18); +h5close(b) + +// Now we copy Dset_1 to Dset_2 located under root +h5mv(a.root.Grp_1, "Dset_1", a, "Dset_2") + +// Copy BDset to a dataset under Grp_1 +h5mv(TMPDIR +"/test1.h5", "/BGrp/BDset", a.root.Grp_1) + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5cp">h5cp</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5rm">h5rm</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5flush">h5flush</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5objects.xml b/modules/hdf5/help/en_US/h5objects.xml new file mode 100755 index 000000000..86f0a0a0d --- /dev/null +++ b/modules/hdf5/help/en_US/h5objects.xml @@ -0,0 +1,519 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5objects" xml:lang="en"> + <refnamediv> + <refname>H5 Objects</refname> + <refpurpose>Describe the properties of the different H5 objects</refpurpose> + </refnamediv> + <refsection> + <title>Contents</title> + <itemizedlist> + <listitem> + <para> + <link linkend="H5File">H5 File</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Group">H5 Group</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Dataset">H5 Dataset</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Dataspace">H5 Dataspace</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Attribute">H5Attribute</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Type">H5 Type</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Reference">H5 Reference</link> + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Description</title> + <para>H5 objects have some accessible properties. All the properties name are case insensitive (except for the path or objects names).</para> + </refsection> + <refsection id="H5File"> + <title>H5 File</title> + <para>The following properties can be accessed: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: the filename; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">size</emphasis>: the file size; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">version</emphasis>: the HDF5 library version; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">root</emphasis>: the root group "/". + </para> + </listitem> + </itemizedlist> + If the field name starts with '/', then it is considered as a path and the returned value is the H5 object corresponding to this path. + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); + +// a is a file +h5isFile(a) + +// Access to the properties +a.name, a.size, a.version, a.root + +// Open the dataset x +a("/x") + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + + <refsection id="H5Group"> + <title>H5 Group</title> + <para>The following properties can be accessed: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">attributes</emphasis>: the attributes names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">groups</emphasis>: the subgroups names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">datasets</emphasis>: the datasets names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">types</emphasis>: the types names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">externals</emphasis>: the external links names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">softs</emphasis>: the soft links names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">danglings</emphasis>: the dangling links names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">hards</emphasis>: the hard links names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">links</emphasis>: the links names and types; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: the group name; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: the group path. + </para> + </listitem> + </itemizedlist> + If the field name is not in the previous list, then it is considered as a local path to another H5 object. + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +root = a.root; + +// root is a group +h5isGroup(root) + +// Access to the properties +root.name, root.path, root.datasets, root.attributes + +// Open the dataset x +dset_x = root.x + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + + <refsection id="H5Dataset"> + <title>H5 Dataset</title> + <para>The following properties can be accessed: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">attributes</emphasis>: the attributes names; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: the dataset type; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">dataspace</emphasis>: the dataset space; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">data</emphasis>: the dataset data; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: the group name; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: the group path. + </para> + </listitem> + </itemizedlist> + If the field name is not in the previous list, then it is considered as an attribute name. + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +dset_x = a.root.x; + +// dset_x is a dataset +h5isSet(dset_x) + +// Access to the properties +dset_x.attributes, dset_x.type, dset_x.dataspace, dset_x.data + +// Open the attribute x +attr_x = dset_x.SCILAB_Class + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + + <refsection id="H5Dataspace"> + <title>H5 Dataspace</title> + <para>The following properties can be accessed: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">dims</emphasis>: the dataspace dimensions; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">extents</emphasis>: the dataspace max dimensions; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: the dataspace type: "scalar", "simple" or "null"; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: the parent name. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: the parent path. + </para> + </listitem> + </itemizedlist> + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +dspace_x = a.root.x.dataspace; + +// dspace_x is a space +h5isSpace(dspace_x) + +// Access to the properties +dspace_x.dims, dspace_x.extents, dspace_x.type + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + + <refsection id="H5Attribute"> + <title>H5 Attribute</title> + <para>The following properties can be accessed: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: the attribute type; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">dataspace</emphasis>: the attribute dataspace; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">data</emphasis>: the attribute data; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: the attribute name. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: the parent path. + </para> + </listitem> + </itemizedlist> + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +attr_x = a.root.x.SCILAB_Class; + +// attr_x is an attribute +h5isAttr(attr_x) + +// Access to the properties +attr_x.type, attr_x.dataspace, attr_x.data + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + + <refsection id="H5Type"> + <title>H5 Type</title> + <para>The following properties can be accessed: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">class</emphasis>: the type class; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: the type name; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">size</emphasis>: the size in bytes; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">nativetype</emphasis>: the native type associated with this type; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">nativesize</emphasis>: the size of the native type. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: the parent name. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: the parent path. + </para> + </listitem> + </itemizedlist> + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +type_x = a.root.x.type; + +// type_x is a type +h5isType(type_x) + +// Access to the properties +type_x.class, type_x.type, type_x.size, type_x.nativetype, type_x.nativesize, + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + + <refsection id="H5Reference"> + <title>H5 Reference</title> + <para>H5 Reference object wrap an hypermatrix object where elements are a reference to an H5 object.</para> + <programlisting role="example"><![CDATA[ +x = list([1 2;3 4], "Hello", uint32(123)); +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +dims_x = a.root.x.dataspace.dims +ref_x = a.root.x.data; + +// ref_x is a reference +h5isRef(ref_x) + +// Get the 3 elements +x1 = ref_x(1), x2 = ref_x(2), x3 = ref_x(3) + +// Get the data +x1.data, x2.data, x3.data + +// Free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5attr">h5attr</link> + </member> + <member> + <link linkend="h5close">h5close</link> + </member> + <member> + <link linkend="h5cp">h5cp</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5dump">h5dump</link> + </member> + <member> + <link linkend="h5exists">h5exists</link> + </member> + <member> + <link linkend="h5flush">h5flush</link> + </member> + <member> + <link linkend="h5get">h5get</link> + </member> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + <member> + <link linkend="h5isType">h5isType</link> + </member> + <member> + <link linkend="h5label">h5label</link> + </member> + <member> + <link linkend="h5ln">h5ln</link> + </member> + <member> + <link linkend="h5ls">h5ls</link> + </member> + <member> + <link linkend="h5mount">h5mount</link> + </member> + <member> + <link linkend="h5mv">h5mv</link> + </member> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5readattr">h5read</link> + </member> + <member> + <link linkend="h5rm">h5rm</link> + </member> + <member> + <link linkend="h5umount">h5umount</link> + </member> + <member> + <link linkend="h5write">h5write</link> + </member> + <member> + <link linkend="h5writeattr">h5writeattr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5open.xml b/modules/hdf5/help/en_US/h5open.xml new file mode 100755 index 000000000..7f8a81aa2 --- /dev/null +++ b/modules/hdf5/help/en_US/h5open.xml @@ -0,0 +1,154 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5open" xml:lang="en"> + <refnamediv> + <refname>h5open</refname> + <refpurpose>Open an HDF5 file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + obj = h5open(filename [, access]) + obj = h5open(filename, access, driver [, driver_options...]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + <varlistentry> + <term>access</term> + <listitem> + <para>A string giving the access mode to use</para> + </listitem> + </varlistentry> + <varlistentry> + <term>driver</term> + <listitem> + <para>A string giving the driver name</para> + </listitem> + </varlistentry> + <varlistentry> + <term>driver_options</term> + <listitem> + <para>A boolean or a double depending of the driver value</para> + </listitem> + </varlistentry> + <varlistentry> + <term>obj</term> + <listitem> + <para>A H5Object corresponding to the open file</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Open an HDF5 file in using the access mode (by default "a").</para> + <para>The access mode is one of the five values:</para> + <simplelist type="inline"> + <member> + "r": read only, the file must exist. + </member> + <member> + "r+": read/write, the file must exist. + </member> + <member> + "w": create file, truncate if exists. + </member> + <member> + "w-": create file, fail if exists. + </member> + <member> + "a": read/write if exists, create otherwise (default). + </member> + </simplelist> + <para>Several drivers can be used:</para> + <simplelist type="inline"> + <member> + "sec2": Unbuffered, using standard POSIX functions. + </member> + <member> + "stdio": Uses functions from the standard C stdio.h to perform I/O. + </member> + <member> + "core": Uses a file in memory (improves read/write). This driver has two options: + <simplelist type="inline"> + <member> + backingStore: a boolean, if %T (default), the changes are saved in the real file. + </member> + <member> + blockSize: a double: increment (in bytes) to use to increase buffer size (default 64K). + </member> + </simplelist> + </member> + <member> + "family": Allow to split the file when its size is greater than the option memberSize (a double, by default 2^31 -1). The filename must contain a %d which will be used to generate the family filenames. + </member> + </simplelist> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = 1:10; +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// Dump the file content +h5dump(a); + +// list the contents of the root element. +h5ls(a) + +// Get the SOD version +a.root.SCILAB_sod_version.data + +// or if the name contains 'invalid' chars +a.root("SCILAB_sod_version").data + +// Get the content of the dataset x +a.root.x.data + +// it is possible to open the dataset directly with its path +// Subgroups or datasets are separated with '/' +a("/x") + +// Free the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5close">h5close</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5read.xml b/modules/hdf5/help/en_US/h5read.xml new file mode 100755 index 000000000..c53cc74e0 --- /dev/null +++ b/modules/hdf5/help/en_US/h5read.xml @@ -0,0 +1,146 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5read" xml:lang="en"> + <refnamediv> + <refname>h5read</refname> + <refpurpose>Read the data of HDF5 dataset</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5read(obj [, name, [, start, count [, stride [, block]]]]) + h5read(filename, name [, start, count [, stride [, block]]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to the new dataset</para> + </listitem> + </varlistentry> + <varlistentry> + <term>start</term> + <listitem> + <para>a row of doubles containing the start of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>count</term> + <listitem> + <para>a row of doubles containing the count of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>stride</term> + <listitem> + <para>a row of doubles containing the stride of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>block</term> + <listitem> + <para>a row of doubles containing the block of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Read the content of a dataset according to the optional hyperslab selection.</para> + <para>It is possible to make an hyperslab selection on the data.</para> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="../images/hyperslab_selection.png" align="center" valign="middle"/> + </imageobject> + </inlinemediaobject> + </para> + <para>The arguments start, count, stride and block must have a size equal to the number of dimensions of the data: + <simplelist type="inline"> + <member> + start: gives the coordinates in the data where to start the selection. + </member> + <member> + count: gives the number of selected blocks in each dimension. + </member> + <member> + stride: gives the shift between two consecutives blocks in each dimension. Take care that the stride must be greater than the corresponding block dimension. + </member> + <member> + block: gives the block dimensions. + </member> + </simplelist> + </para> + <para>By default stride and block are set to 1 in each dimension.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = int8(matrix(1:80, 10, 8)); +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// Read the data from the dataset 'x' +dx = h5read(a, "/x") + +// Now select a part +dx1 = h5read(a, "/x", [3 4], [5 3]) + +// ...which is equivalent to +dx(3:(3+5-1),4:(4+3-1)) + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5readattr">h5readattr</link> + </member> + <member> + <link linkend="h5write">h5write</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5readattr.xml b/modules/hdf5/help/en_US/h5readattr.xml new file mode 100755 index 000000000..678570858 --- /dev/null +++ b/modules/hdf5/help/en_US/h5readattr.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5readattr" xml:lang="en"> + <refnamediv> + <refname>h5readattr</refname> + <refpurpose>Read the data of an HDF5 attribute</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5readattr(obj [, location], name) + h5readattr(filename, location, name) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to the attribute name</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the path to the group or the dataset containing the attribute</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Read the content of an attribute.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = int8(matrix(1:80, 10, 8)); +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// Read an attribute of the root group +scilab_version = h5readattr(a, "/", "SCILAB_scilab_version") + +// and another one +sod_version = h5readattr(a.root, "SCILAB_sod_version") + +// and one from a dataset +scilab_class = h5readattr(a.root.x, "SCILAB_Class") + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5read">h5read</link> + </member> + <member> + <link linkend="h5writeattr">h5writeattr</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5rm.xml b/modules/hdf5/help/en_US/h5rm.xml new file mode 100755 index 000000000..88e8b686b --- /dev/null +++ b/modules/hdf5/help/en_US/h5rm.xml @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5rm" xml:lang="en"> + <refnamediv> + <refname>h5rm</refname> + <refpurpose>Remove elements from an HDF5 file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5rm(obj [, names]) + h5rm(filename, names) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>a matrix of strings giving the locations to remove</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving an the path of a HDF5 file</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Remove one or more objects from the file.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a = h5open(TMPDIR + "/test.h5", "a"); + +// We can create several groups under root +names = "Group_" + string(1:10); +h5group(a, names) + +// we display them +h5ls(a) + +// ... or +a.root.groups + +// we can remove a part of them +names = "Group_" + string(1:2:10); +h5rm(a, names); + +// we check that all is ok +a.root.groups + +// We have finished so we free all the resources +h5close(a); + +// We can remove attributes too +x = %pi; +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// we look for attributes +h5ls(a) + +// ... or +a.root.attributes + +// We remove 'SCILAB_sod_version' +h5rm(a, "SCILAB_sod_version"), h5ls(a) + +// Free the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5umount.xml b/modules/hdf5/help/en_US/h5umount.xml new file mode 100755 index 000000000..2c363f146 --- /dev/null +++ b/modules/hdf5/help/en_US/h5umount.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5umount" xml:lang="en"> + <refnamediv> + <refname>h5umount</refname> + <refpurpose>Unmount a previously mounted file.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5umount(obj, location) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>a string giving the mount point</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Unmount a previously mounted file.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Create an HDF5 file +a = h5open(TMPDIR + "/test.h5", "w") + +// we create a group which will be used as mount point +h5group(a, "/mnt"); + +// Create an other file with a group and a dataset +b = h5open(TMPDIR + "/test1.h5", "w") +h5group(b, "Group_1"); +h5write(b, "Group_1/Dataset_1", [1 2;3 4]); + +// Mount b on a +h5mount(a, "/mnt", b) + +// Now we can modify or read b like if we were in a +a.root.mnt.Group_1.Dataset_1.data +h5write(a.root.mnt.Group_1, "Dataset_1", [10 11;12 13]) + +// We can now unmount and remove the mount point +h5umount(a, "/mnt") +h5rm(a, "/mnt") + +// We close all +h5close(a, b) + +// Check that the modification in b is ok +h5dump(TMPDIR + "/test1.h5", "/Group_1/Dataset_1") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5mount">h5mount</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5write.xml b/modules/hdf5/help/en_US/h5write.xml new file mode 100755 index 000000000..9c691ffcb --- /dev/null +++ b/modules/hdf5/help/en_US/h5write.xml @@ -0,0 +1,167 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5write" xml:lang="en"> + <refnamediv> + <refname>h5write</refname> + <refpurpose>Create a dataset (if it does not exist) and write the data</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h5write(obj, name, data [, targetType], [, start, count [, stride [, block]]]) + h5write(filename, name, data [, targetType], [, start, count [, stride [, block]]]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string giving the path to the dataset</para> + </listitem> + </varlistentry> + <varlistentry> + <term>data</term> + <listitem> + <para>a Scilab data</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetType</term> + <listitem> + <para>a string giving the type of the target</para> + </listitem> + </varlistentry> + <varlistentry> + <term>start</term> + <listitem> + <para>a row of doubles containing the start of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>count</term> + <listitem> + <para>a row of doubles containing the count of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>stride</term> + <listitem> + <para>a row of doubles containing the stride of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>block</term> + <listitem> + <para>a row of doubles containing the block of the hyperslab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string giving the filename</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Create a new named dataset (if it does not exist) based on the Scilab data passed as argument.</para> + <para> + The target HDF5 type can be chosen in the list available in the <ulink url="http://www.hdfgroup.org/HDF5/doc/RM/PredefDTypes.html">HDF5 manual</ulink>. + Examples of this HDF5 type are "H5T_MIPS_U32" or "H5T_STD_B64BE", but shortcuts as "MIPS_U32" or "STD_B64BE" can also be used. + </para> + <para>It is possible to make an hyperslab selection on the data.</para> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="../images/hyperslab_selection.png" align="center" valign="middle"/> + </imageobject> + </inlinemediaobject> + </para> + <para>The arguments start, count, stride and block must have a size equal to the number of dimensions of the data: + <simplelist type="inline"> + <member> + start: gives the coordinates in the data where to start the selection. + </member> + <member> + count: gives the number of selected blocks in each dimension. + </member> + <member> + stride: gives the shift between two consecutives blocks in each dimension. Take care that the stride must be greater than the corresponding block dimension. + </member> + <member> + block: gives the block dimensions. + </member> + </simplelist> + By default stride and block are set to 1 in each dimension. + </para> + <para> + If the target type is "H5T_STD_REF_OBJ", the data matrix must be a string matrix containing the absolute paths of group or datasets. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = matrix(1:20, 4, 5); +save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones + +// Open the created file +a = h5open(TMPDIR + "/x.sod"); + +// We want to add a new dataset named "y" +y = uint32(matrix(10:30, 7, 3)); +h5write(a, "y", y); + +// We add a dataset "z" in using MIPS representation +h5write(a, "z", y, "H5T_MIPS_U32"); + +// Now we make an hyperslab selection +x = uint32(matrix(1:(11*17), 11, 17)); +h5write(a, "t", x, [1 2], [2 4], [5 3], [3 2]); + +//Now check that all is ok +x, a("/t").data' + +// We have finished so we free all the resources +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/en_US/h5writeattr.xml b/modules/hdf5/help/en_US/h5writeattr.xml new file mode 100755 index 000000000..f6133d73e --- /dev/null +++ b/modules/hdf5/help/en_US/h5writeattr.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5writeattr" xml:lang="en"> + <refnamediv> + <refname>h5writeattr</refname> + <refpurpose>Write an attribute in a group or a dataset</refpurpose> + </refnamediv> + <refsection> + <para>This function is fully equivalent to h5attr.</para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/fr_FR/addchapter.sce b/modules/hdf5/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..1e80dd862 --- /dev/null +++ b/modules/hdf5/help/fr_FR/addchapter.sce @@ -0,0 +1,10 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("HDF5 Management",SCI+"/modules/hdf5/help/fr_FR",%T); diff --git a/modules/hdf5/help/images/hyperslab_selection.png b/modules/hdf5/help/images/hyperslab_selection.png Binary files differnew file mode 100755 index 000000000..531950705 --- /dev/null +++ b/modules/hdf5/help/images/hyperslab_selection.png diff --git a/modules/hdf5/help/ja_JP/addchapter.sce b/modules/hdf5/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..6810fc432 --- /dev/null +++ b/modules/hdf5/help/ja_JP/addchapter.sce @@ -0,0 +1,10 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("HDF5 Management",SCI+"/modules/hdf5/help/ja_JP",%T); diff --git a/modules/hdf5/help/ja_JP/h5attr.xml b/modules/hdf5/help/ja_JP/h5attr.xml new file mode 100755 index 000000000..749721ff1 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5attr.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5attr" xml:lang="ja"> + <refnamediv> + <refname>h5attr</refname> + <refpurpose>属性を作成する</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5attr(obj, location, name, data [, targetType]) + h5attr(filename, location, name, data [, targetType]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>オブジェクト内またはファイル内の位置を指定する文字列 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>新規データセットへのパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>data</term> + <listitem> + <para>Scilabデータ</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetType</term> + <listitem> + <para>ターゲットの型を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 引数としてScilabデータに基づき新規に属性を作成します. + </para> + <para> + ターゲットのHDF5型は, + <ulink url="http://www.hdfgroup.org/HDF5/doc/RM/PredefDTypes.html">HDF5マニュアル</ulink>で利用可能なリストの中から選択できます. + このHDF5型の例は"H5T_MIPS_U32" または "H5T_STD_B64BE"ですが, + "MIPS_U32" または "STD_B64BE" のような短縮形も使用可能です. + </para> + <para>属性をグループ内またはデータセット内に配置することが可能です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = 1:5 + %pi; +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイルです +// ファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// ルート要素に属性を追加 +h5attr(a, ".", "My Attribute", int8(123)); +// 確認 +h5dump(a) +// ...または +a.root("My Attribute").data +// データセットに"x"という名前の属性を追加 +h5attr(a, "/x", "My Dataset Attribute", int16(321)); +// 確認 +h5dump(a.root.x) +// 完了し,リソースを全て解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5attr">h5dataset</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5close.xml b/modules/hdf5/help/ja_JP/h5close.xml new file mode 100755 index 000000000..456b5ffcc --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5close.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5close" xml:lang="ja"> + <refnamediv> + <refname>h5close</refname> + <refpurpose>HDF5オブジェクトを閉じる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5close([obj_1 [, obj_2 [, ...]]]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj_i</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + オブジェクトとその全ての派生ノードを閉じます. + これにより,このオブジェクトに関連する全メモリを解放できます. + </para> + <para> + ファイルに関連する全てのバッファはファイルを閉じる前にフラッシュされます. + </para> + <para>引数を指定しない場合, オープンされている全オブジェクトが閉じられます + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = ["Hello" "World"; "Salut" "Monde"]; +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイルです +// 作成済みのファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// ファイルの内容をダンプ +h5dump(a); +// "x"という名前のデータセットをオープン +ds = a.root.x +// 属性'SCILAB_Class'を取得 +attr = ds.SCILAB_Class +// 値を読み込む +attr.data +// dsからデータを取得 +d = ds.data +// データセットを終了 +h5close(ds) +// attrはdsからオープンされていたため, attr はもう利用可能ではありません +// ... よってエラーが発生します +attr +// 処理を完了し, リソースを全て解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5cp.xml b/modules/hdf5/help/ja_JP/h5cp.xml new file mode 100755 index 000000000..17e96b986 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5cp.xml @@ -0,0 +1,130 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5cp" xml:lang="ja"> + <refnamediv> + <refname>h5cp</refname> + <refpurpose>オブジェクトをコピーする</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5cp(srcobj [, srcloc], destobj [, destloc]) + h5cp(srcobj [, srcloc], destfile, destloc) + h5cp(srcfile, srcloc, destobj [, destloc]) + h5cp(srcfile, srcloc, destfile, destloc) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>srcobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcloc</term> + <listitem> + <para>コピー元を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destloc</term> + <listitem> + <para>コピー先を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcfile</term> + <listitem> + <para>コピー元のファイル名(文字列)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destfile</term> + <listitem> + <para>コピー先のファイル名(文字列)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>オブジェクトを他の場所(同じファイルまたはそれ以外)にコピーします.</para> + <para>新規に作成されたオブジェクトをコピーする前には, ファイルをフラッシュする必要があります.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR + "/test.h5"); +b = h5open(TMPDIR + "/test1.h5"); +// グループおよびデータセットを作成 +h5group(a, "Grp_1"); +h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]); +// コピーの際に修正を確実に反映するためにファイルをフラッシュ +h5flush(a); +// bの中にグループおよびデータセットを作成 +h5group(b, "BGrp"); +h5write(b("/BGrp"), "BDset", 11:18); +h5close(b) +// Dset_1をルートの下のDset_2にコピー +h5cp(a.root.Grp_1, "Dset_1", a, "Dset_2") +// BDsetをGrp_1の下のデータセットにコピー +h5cp(TMPDIR +"/test1.h5", "/BGrp/BDset", a.root.Grp_1) +// コピー先の名前を変更可能 +h5cp(TMPDIR +"/test1.h5", "/BGrp/BDset", a.root.Grp_1, "The Foo Dataset") +// 処理を完了し, 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5mv">h5mv</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5rm">h5rm</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5flush">h5flush</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5dataset.xml b/modules/hdf5/help/ja_JP/h5dataset.xml new file mode 100755 index 000000000..eb3df5127 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5dataset.xml @@ -0,0 +1,172 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5dataset" xml:lang="ja"> + <refnamediv> + <refname>h5dataset</refname> + <refpurpose>データセットを作成し, データを書き込む</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5dataset(obj, name, sourceInfo [, sourceType], data, targetInfo [, targetType]) + h5dataset(filename, name, sourceInfo [, sourceType], data, targetInfo [, targetType]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>新規データセットへのパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sourceInfo</term> + <listitem> + <para>5 x n のdouble行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sourceType</term> + <listitem> + <para>ソースの型を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>data</term> + <listitem> + <para>Scilabデータ</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetInfo</term> + <listitem> + <para>6 x n のdoubleの行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetType</term> + <listitem> + <para>目標の型を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 引数として指定されたScilabデータに基づき, + 名前を指定して(まだ存在しない場合に)新規にデータセットを作成します. + </para> + <para> + ターゲットのHDF5型は, + <ulink url="http://www.hdfgroup.org/HDF5/doc/RM/PredefDTypes.html">HDF5マニュアル</ulink>で利用可能なリストの中から選択できます. + このHDF5型の例は"H5T_MIPS_U32" または "H5T_STD_B64BE"ですが, + "MIPS_U32" または "STD_B64BE" のような短縮形も使用可能です. + </para> + <para> + ソース情報はデータを取得する方法に関する情報を指定します. + これは 5xn の行列です.ただし,nはデータの次元数です. + 行は以下の情報を指定します: + </para> + <simplelist type="inline"> + <member> + 1行目: データの次元. + </member> + <member> + 2行目: hyperslabのstart. + </member> + <member> + 3行目: hyperslabのカウント. + </member> + <member> + 4行目: hyperslabのstride. + </member> + <member> + 5行目: hyperslabのblock. + </member> + </simplelist> + <para> + hyperslab選択に関する詳細については, + <link linkend="h5write">h5write</link>を参照ください. + </para> + <para>targetInfo行列は 6xn の double 行列です. 最初の行は + ターゲットのデータセットの次元, + 2行目は次元の最大値を指定します. + 1行目と2行目が等しくない場合, + データセットは分割されます. + 3から6行目はhyperslabのstart, count, stride, block を指定します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを新規に作成 +a = h5open(TMPDIR + "/test.h5", "w") +// データ +x = uint32(1:100); +y = uint32(1:9); +// データセットを作成 +// x はC-行列として見えます (行優先) +h5dataset(a, "My_Dataset", [10 10 ; 2 1 ; 4 1 ; 2 1 ; 1 9], x, [7 12 ; 9 14 ; 3 3 ; 1 1 ; 1 1 ; 4 9]) +h5dump(a, "My_Dataset"); +// 既存のデータセットの次元を拡張子,yデータを追加 +h5dataset(a, "My_Dataset", [9 1 ; 1 1 ; 1 1 ; 1 1 ; 9 1], y, [9 12 ; 9 14 ; 1 1 ; 1 1 ; 1 1 ; 9 1]) +h5dump(a, "My_Dataset"); +// yデータを置換 +h5dataset(a, "My_Dataset", [9 1 ; 1 1 ; 1 1 ; 1 1 ; 9 1], uint32(11:19), [9 12 ; 9 14 ; 1 1 ; 1 1 ; 1 1 ; 9 1]) +h5dump(a, "My_Dataset"); +// リソースを解放 +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + <member> + <link linkend="h5write">h5write</link> + </member> + <member> + <link linkend="h5writeattr">h5writeattr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5dump.xml b/modules/hdf5/help/ja_JP/h5dump.xml new file mode 100755 index 000000000..d2e0f39f1 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5dump.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5dump" xml:lang="ja"> + <refnamediv> + <refname>h5dump</refname> + <refpurpose>H5オブジェクトの内容を標準出力ストリームにダンプ</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5dataset(obj, name) + h5dataset(filename, name) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>ダンプするパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + H5オブジェクトの内容を標準出力ストリームに書き込みます. + デバッグを容易にし, + オブジェクトの内容が全て問題ないことを確認する際に有用です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを新規に作成 +a = h5open(TMPDIR + "/test.h5", "a") +// データ +h5write(a, "DS1", 1:10); +h5write(a, "DS2", uint16(1:10)); +h5write(a, "DS3", ["Hello" "World"]); +h5writeattr(a, "/DS3", "ATT3.1", "String Matrix") +// ファイル全体をダンプできます +h5dump(a) +// ...または3番目のデータセットのみ +h5dump(a, "/DS3") +// リソースを全て解放 +h5close(a) +// ファイルを明示的にオープンせずにダンプできます +h5dump(TMPDIR + "/test.h5"); +// ... または3番目のデータセットのみ +h5dump(TMPDIR + "/test.h5", "/DS3"); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5exists.xml b/modules/hdf5/help/ja_JP/h5exists.xml new file mode 100755 index 000000000..30a3121bd --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5exists.xml @@ -0,0 +1,113 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5exists" xml:lang="ja"> + <refnamediv> + <refname>h5exists</refname> + <refpurpose>指定した名前のオブジェクトが存在するかどうかを確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5exists(obj, locations) + b = h5exists(obj, location, attrNames) + b = h5exists(filename, locations) + b = h5exists(filename, location, attrNames) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>locations</term> + <listitem> + <para>確認するパスを有する文字列の行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para> + 属性名を確認する位置を指定する文字列 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>attrNames</term> + <listitem> + <para> + 確認する属性名を有する文字列の行列 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値の行列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>指定した名前のオブジェクトまたは属性の存在を確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = 123; +y = 321; +save(TMPDIR + "/xy.sod", "x", "y"); +// ファイルをオープン +a = h5open(TMPDIR + "/xy.sod", "r"); +// データセット "x", "y" および "z"の存在を確認 +// "z" は存在しない... +h5exists(a, ["x" "y" "z"]) +// Scilab 属性の存在を確認 +h5exists(a, "/", ["SCILAB_sod_version", "SCILAB_scilab_version"]) +// リソースを全て解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5get">h5get</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5flush.xml b/modules/hdf5/help/ja_JP/h5flush.xml new file mode 100755 index 000000000..66b483203 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5flush.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5flush" xml:lang="ja"> + <refnamediv> + <refname>h5flush</refname> + <refpurpose>ファイルに関連するバッファを全てフラッシュする</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5flush(obj [, local]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>local</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>ファイルに関連するバッファを全てフラッシュします. + local が %T の場合, そのファイルのみがフラッシュされ, + その他は仮想ファイル全体がフラッシュされます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR +"/test.h5", "w"); +// データセットを書き込む +h5write(a, "MyDset", 1:100); +// ファイルをフラッシュ +h5flush(a); +// 処理を完了し, 全てのリソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5open">h5close</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5get.xml b/modules/hdf5/help/ja_JP/h5get.xml new file mode 100755 index 000000000..808d3b1f9 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5get.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5get" xml:lang="ja"> + <refnamediv> + <refname>h5get</refname> + <refpurpose>指定した名前のオブジェクトを取得</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + nobj = h5get(obj, location [, isAttr]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>位置を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>isAttr</term> + <listitem> + <para>必要な属性を示す論理値</para> + </listitem> + </varlistentry> + <varlistentry> + <term>nobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + obj を元として指定した位置のオブジェクトを取得します. + isAttr が %T の場合, H5オブジェクトが返されます. + デフォルトで isAttr は %F です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = ["Hello" "World"; "Salut" "Monde"]; +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイルです +// Open the created file +a = h5open(TMPDIR + "/x.sod"); +// ルートオブジェクトを取得, これは a.root または a("/") と等価です. +r = h5get(a, "/") +// データセット "x"を取得 +x = h5get(a, "/x") // または h5get(a.root, "x") +x.data +// 既存のデータセットを取得 +y = h5get(a.root, "blahblah") +// 属性を取得 +attr = h5get(a.root, "SCILAB_scilab_version", %t) +attr.data +// ファイルを全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5group.xml b/modules/hdf5/help/ja_JP/h5group.xml new file mode 100755 index 000000000..ad3083bd0 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5group.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5group" xml:lang="ja"> + <refnamediv> + <refname>h5group</refname> + <refpurpose>グループを作成</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5group(obj, names) + h5group(filename, names) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>名前を指定する文字列の行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>グループの集合を作成します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// ファイルを作成 +a = h5open(TMPDIR + "/test_group.h5", "a"); +// 10個のサブグループを有する10個のグループを作成 +// まず, 名前を作成 +gnames = "Group_" + string(1:10); +sgnames = "SubGroup_" + string(1:10); +names = gnames; +for s=gnames + names = [names s + "/" + sgnames] +end +// 次に, グループを作成 +h5group(a, names); +// 全てOKであることを確認 +h5ls(a) +// ...そして +h5ls(a, "Group_3") +// a に関連するリソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isArray.xml b/modules/hdf5/help/ja_JP/h5isArray.xml new file mode 100755 index 000000000..62aa14bad --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isArray.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isArray" xml:lang="ja"> + <refnamediv> + <refname>h5isArray</refname> + <refpurpose>HDF5オブジェクトが配列かどうかを確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isArray(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトが配列オブジェクトかどうかを確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルであるSODファイルを作成 +x = (1:10) + %i*(20:29); +save(TMPDIR + "/x.sod", "x"); +// ファイルをオープン +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isArray(a) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isCompound">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isAttr.xml b/modules/hdf5/help/ja_JP/h5isAttr.xml new file mode 100755 index 000000000..872f7e9ed --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isAttr.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isAttr" xml:lang="ja"> + <refnamediv> + <refname>h5isAttr</refname> + <refpurpose>HDF5オブジェクトが属性かどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isAttr(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>属性オブジェクトがHDF5オブジェクトかどうか確認します.</para> + </refsection> + <refsection> + <title>例を</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルをであるSODファイルを作成 +x = 1:10; +save(TMPDIR + "/x.sod", "x"); +// ファイルをオープン +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isAttr(a) +// 'SCILAB_scilab_version'属性に関してテスト +h5isAttr(a.root.SCILAB_scilab_version) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isCompound.xml b/modules/hdf5/help/ja_JP/h5isCompound.xml new file mode 100755 index 000000000..a57ab71fe --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isCompound.xml @@ -0,0 +1,113 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isCompound" xml:lang="ja"> + <refnamediv> + <refname>h5isCompound</refname> + <refpurpose>HDF5オブジェクトが複合オブジェクトかどうかを確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isCompound(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5が複合オブジェクトであるかどうかを調べます.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルであるSODファイルを作成します +x = (1:10) + %i*(20:29); +save(TMPDIR + "/x.sod", "x"); +// ファイルをオープン +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isCompound(a) +// root.x.dataを確認 +h5isCompound(a.root.x.data) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isFile.xml b/modules/hdf5/help/ja_JP/h5isFile.xml new file mode 100755 index 000000000..500240d81 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isFile.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isFile" xml:lang="ja"> + <refnamediv> + <refname>h5isFile</refname> + <refpurpose>HDF5オブジェクトがファイルかどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isFile(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトがファイルオブジェクトかどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = 1:10; +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isFile(a) +// ルートに対してテスト +h5isFile(a.root) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isGroup.xml b/modules/hdf5/help/ja_JP/h5isGroup.xml new file mode 100755 index 000000000..dde2465bb --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isGroup.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isGroup" xml:lang="ja"> + <refnamediv> + <refname>h5isGroup</refname> + <refpurpose>HDF5オブジェクトがグループオブジェクトかどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isGroup(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトがグループオブジェクトかどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = 1:10; +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isGroup(a) +// ルートに対してテスト +h5isGroup(a.root) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isRef.xml b/modules/hdf5/help/ja_JP/h5isRef.xml new file mode 100755 index 000000000..8bbd8a3f3 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isRef.xml @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isRef" xml:lang="ja"> + <refnamediv> + <refname>h5isRef</refname> + <refpurpose>HDF5オブジェクトがリファレンスオブジェクトかどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isRef(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトがリファレンスオブジェクトかどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = list(1, "hello"); +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isRef(a) +// 'x'という名前のデータセットのリファレンスに対してテスト +y = a.root.x.data; +h5isRef(y) +// リファレンス値を取得 +y(1).data, y(2).data +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isSet.xml b/modules/hdf5/help/ja_JP/h5isSet.xml new file mode 100755 index 000000000..5944bafbf --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isSet.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isSet" xml:lang="ja"> + <refnamediv> + <refname>h5isSet</refname> + <refpurpose>HDF5オブジェクトがデータセットかどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isSet(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトがデータセットかどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = 1:10; +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isSet(a) +// データセット'x'に対してテスト +h5isSet(a.root.x) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isSpace.xml b/modules/hdf5/help/ja_JP/h5isSpace.xml new file mode 100755 index 000000000..c8f1a2d5e --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isSpace.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isSpace" xml:lang="ja"> + <refnamediv> + <refname>h5isSpace</refname> + <refpurpose>HDF5オブジェクトがデータスペースかどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isSpace(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトがデータスペースオブジェクトかどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = 1:10; +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isSpace(a) +// データセット'x'に関連するデータスペースに対してテスト +h5isSpace(a.root.x.dataspace) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isType.xml b/modules/hdf5/help/ja_JP/h5isType.xml new file mode 100755 index 000000000..8408fddb1 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isType.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isType" xml:lang="ja"> + <refnamediv> + <refname>h5isType</refname> + <refpurpose>HDF5オブジェクトが型かどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isType(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトがかどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = 1:10; +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// Test +h5isType(a) +// データセット'x'に関連する型に対してテスト +h5isType(a.root.x.type) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isArray">h5isArray</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isVlen</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5isVlen.xml b/modules/hdf5/help/ja_JP/h5isVlen.xml new file mode 100755 index 000000000..5f444f43e --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5isVlen.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5isVlen" xml:lang="ja"> + <refnamediv> + <refname>h5isVlen</refname> + <refpurpose>HDF5オブジェクトが可変長配列かどうか確認</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + b = h5isVlen(obj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>HDF5オブジェクトが可変長配列かどうか確認します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// SODファイル(HDF5ファイル)を作成 +x = (1:10) + %i*(20:29); +save(TMPDIR + "/x.sod", "x"); +// ファイルを開く +a = h5open(TMPDIR + "/x.sod", "r"); +// テスト +h5isVlen(a) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isType">h5isType</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isCompound">h5isCompound</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5isVlen">h5isArray</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5label.xml b/modules/hdf5/help/ja_JP/h5label.xml new file mode 100755 index 000000000..b108f93d0 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5label.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5label" xml:lang="ja"> + <refnamediv> + <refname>h5label</refname> + <refpurpose>データセットに名前を付ける</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5label(obj, location, dims, names) + h5label(filename, location, dims, names) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>位置を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>dims</term> + <listitem> + <para>doubleの行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>dimsと同じ大きさの文字列の行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + dimsおよびnamesによりデータセットに名前を付けます. + <code>dims(i)</code>のn番目の次元は<code>names(i)</code>で + 名前を指定します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR + "/test.h5", "w") +// データ +x = uint8(1:24); +// ハイパー行列1x2x3x4としてxを含むデータセットを作成 +h5dataset(a, "My Dataset", [1 2 3 4 ; 1 1 1 1 ; 1 1 1 1 ; 1 1 1 1; 1 2 3 4], x, [1 2 3 4 ; 1 2 3 4 ; 1 1 1 1 ; 1 1 1 1 ; 1 1 1 1 ; 1 2 3 4]); +// データセットに名前を付ける +h5label(a, "My Dataset", [1 3], ["Hello" "World"]); +// 確認 +h5dump(a) +// 全て閉じる +h5close(a) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5 module introduced.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5ln.xml b/modules/hdf5/help/ja_JP/h5ln.xml new file mode 100755 index 000000000..0d6a44bac --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5ln.xml @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5ln" xml:lang="ja"> + <refnamediv> + <refname>h5ln</refname> + <refpurpose>オブジェクトを他のオブジェクトにリンクする</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5ln(obj, linkname, destobj [, hard]) + h5ln(obj, linkname, destname [, hard]) + h5ln(obj, linkname, destfile, destname) + h5ln(filename, location, linkname, destname [, hard]) + h5ln(filename, location, linkname, destfile, destname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>linkname</term> + <listitem> + <para>リンク名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destfile</term> + <listitem> + <para>出力先ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>hard</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>ファイル内の位置を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + ハード, ソフト, または外部リンクを作成します. + destfileが指定された場合, 常に外部リンクを作成します. + デフォルトで hard は falseに設定されており, + デフォルトでソフトリンクが作成されます. + </para> + <para>ソフトリンクはターゲットが存在しない場合でも作成可能です.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR + "/test.h5"); +b = h5open(TMPDIR + "/test1.h5"); +// グループとデータセットを作成 +h5group(a, "Grp_1"); +h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]); +h5group(b, "BGrp"); +h5write(b("/BGrp"), "BDset", 11:18); +h5close(b) +// 2番目のグループを作成し, リンクを追加 +h5group(a, "Grp_2"); +h5ln(a, "Hard_Link", "/Grp_1/Dset_1", %t) +h5ln(a, "Soft_Link", "/Grp_1/Dset_1") +h5ln(a, "External_Link", TMPDIR +"/test1.h5", "/BGrp") +// 確認 +h5dump(a) +// 外部リンクを確認 +a.root.External_Link.BDset.data +// 処理を完了し, 全てのリソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5ls.xml b/modules/hdf5/help/ja_JP/h5ls.xml new file mode 100755 index 000000000..af66074a8 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5ls.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5ls" xml:lang="ja"> + <refnamediv> + <refname>h5ls</refname> + <refpurpose>HDF5オブジェクト (グループまたはデータセット)の内容の一覧を得る</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + content = h5ls(obj [, name [, filter]]) + content = h5ls(filename, name [, filter]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>一覧を得るためにオブジェクトのパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filter</term> + <listitem> + <para>フィルタの型を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>content</term> + <listitem> + <para>2列の文字列行列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + グループまたはデータセットの内容の一覧を取得します. + 最初の列には名前, 2列目には要素の型が得られます. + </para> + <para> + filterには値 'group' (または 'g'), 'dataset' (または 'd'), 'type' (または 't') および 'attribute' (または 'a') + のどれかを指定できます. + 例えば, 'g' が指定された場合, グループのみが返されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = int8(matrix(1:80, 10, 8)); +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイル +// 作成されたファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// aの内容の一覧を得る +h5ls(a) +// データセットのみ +h5ls(a, ".", "d") +// 属性のみ +h5ls(a, ".", "a"); +// xという名前のデータセットを見て, 一覧を取得可能 +h5ls(a.root.x) // a.root.x is equivalent to a("/x") +// 処理を完了し, 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5mount.xml b/modules/hdf5/help/ja_JP/h5mount.xml new file mode 100755 index 000000000..3f16cfd5a --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5mount.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5mount" xml:lang="ja"> + <refnamediv> + <refname>h5mount</refname> + <refpurpose>グループにファイルをマウントする</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5mount(obj, location, fileobj) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>マウントポイントを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fileobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>マウントポイントにHDF5ファイルをマウントします.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR + "/test.h5", "w") +// マウントポイントとして使用されるグループを作成 +h5group(a, "/mnt"); +// グループとデータセットを有する他のファイルを作成 +b = h5open(TMPDIR + "/test1.h5", "w") +h5group(b, "Group_1"); +h5write(b, "Group_1/Dataset_1", [1 2;3 4]); +// aにbをマウント +h5mount(a, "/mnt", b) +// これにより, aと同様にbを修正または読み込みできるようになる +a.root.mnt.Group_1.Dataset_1.data +h5write(a.root.mnt.Group_1, "Dataset_1", [10 11;12 13]) +// アンマウントし, マウントポイントを削除 +h5umount(a, "/mnt") +h5rm(a, "/mnt") +// 全て閉じる +h5close(a, b) +// bの修正がokかどうか確認 +h5dump(TMPDIR + "/test1.h5", "/Group_1/Dataset_1") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5umount">h5umount</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5mv.xml b/modules/hdf5/help/ja_JP/h5mv.xml new file mode 100755 index 000000000..78bd5fcbc --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5mv.xml @@ -0,0 +1,134 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5mv" xml:lang="ja"> + <refnamediv> + <refname>h5mv</refname> + <refpurpose>オブジェクトを移動</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5mv(srcobj [, srcloc], destobj [, destloc]) + h5mv(srcobj [, srcloc], destfile, destloc) + h5mv(srcfile, srcloc, destobj [, destloc]) + h5mv(srcfile, srcloc, destfile, destloc) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>srcobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destobj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcloc</term> + <listitem> + <para>移動元の位置を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destloc</term> + <listitem> + <para>移動先の位置を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>srcfile</term> + <listitem> + <para>移動元のファイル名(文字列)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>destfile</term> + <listitem> + <para>移動先のファイル名(文字列)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + オブジェクトを他の場所(同じファイルまたは別のファイル)に移動します. + このコマンドは, <code>h5cp</code> の後に <code>h5rm</code>を + 実行するのと等価です. + </para> + <para>新規に作成されたオブジェクトを移動する前には, + ファイルをフラッシュする必要があります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR + "/test.h5"); +b = h5open(TMPDIR + "/test1.h5"); +// グループとデータセットを作成 +h5group(a, "Grp_1"); +h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]); +// 移動時に確実に修正が反映されるように,ファイルをフラッシュ +h5flush(a); +// b内にグループとデータセットを作成 +h5group(b, "BGrp"); +h5write(b("/BGrp"), "BDset", 11:18); +h5close(b) +// Dset_1をroot以下のDset_2に移動 +h5mv(a.root.Grp_1, "Dset_1", a, "Dset_2") +// BDsetをデータセットGrp_1にコピー +h5mv(TMPDIR +"/test1.h5", "/BGrp/BDset", a.root.Grp_1) +// 処理を完了し, 全てのリソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5cp">h5cp</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5rm">h5rm</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5flush">h5flush</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5objects.xml b/modules/hdf5/help/ja_JP/h5objects.xml new file mode 100755 index 000000000..c598df6a0 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5objects.xml @@ -0,0 +1,495 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5objects" xml:lang="ja"> + <refnamediv> + <refname>H5 Objects</refname> + <refpurpose>種々のH5オブジェクトのプロパティを説明</refpurpose> + </refnamediv> + <refsection> + <title>内容</title> + <itemizedlist> + <listitem> + <para> + <link linkend="H5File">H5ファイル</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Group">H5グループ</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Dataset">H5データセット</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Dataspace">H5データスペース</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Attribute">H5属性</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Type">H5型</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="H5Reference">H5リファレンス</link> + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>説明</title> + <para>H5オブジェクトはアクセス可能なプロパティを有します. + 全てのプロパティ名は,大文字小文字を区別します(パス名およびオブジェクト名を + 除きます). + </para> + </refsection> + <refsection id="H5File"> + <title>H5ファイル</title> + <para>以下のプロパティにアクセス可能です: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: ファイル名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">size</emphasis>: ファイルの大きさ; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">version</emphasis>: HDF5ライブラリのバージョン; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">root</emphasis>: ルートグループ "/". + </para> + </listitem> + </itemizedlist> + フィールド名が'/'で始まる場合, + パスとみなされ, 戻り値はこのパスに対応するH5オブジェクトとなります. + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +// aはファイル +h5isFile(a) +// プロパティにアクセス +a.name, a.size, a.version, a.root +// データセットxをオープン +a("/x") +// 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection id="H5Group"> + <title>H5グループ</title> + <para>以下のプロパティがアクセス可能: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">attributes</emphasis>: 属性名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">groups</emphasis>: サブグループ名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">datasets</emphasis>: データセット名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">types</emphasis>: 型名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">externals</emphasis>: 外部リンク名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">softs</emphasis>: ソフトリンク名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">danglings</emphasis>: ダングリングリンク名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">hards</emphasis>: ハードリンク名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">links</emphasis>: リンク名と型; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: グループ名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: グループのパス. + </para> + </listitem> + </itemizedlist> + フィールド名が過去のリストにない場合, 他のH5オブジェクトへのローカルパスとみなされます. + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +root = a.root; +// rootはグループ +h5isGroup(root) +// プロパティにアクセス +root.name, root.path, root.datasets, root.attributes +// データセットxをオープン +dset_x = root.x +// 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection id="H5Dataset"> + <title>H5 Dataset</title> + <para>以下のプロパティにアクセス可能です: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">attributes</emphasis>: 属性名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: データセット型; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">dataspace</emphasis>: データセット空間; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">data</emphasis>: データセットデータ; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: グループ名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: グループパス. + </para> + </listitem> + </itemizedlist> + フィールド名が過去のリストに存在しない場合, 属性名とみなされます. + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +dset_x = a.root.x; +// dset_x がデータセットです +h5isSet(dset_x) +// プロパティにアクセス +dset_x.attributes, dset_x.type, dset_x.dataspace, dset_x.data +// 属性xをオープン +attr_x = dset_x.SCILAB_Class +// 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection id="H5Dataspace"> + <title>H5データスペース</title> + <para>以下のプロパティにアクセスできます: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">dims</emphasis>: データスペースの次元; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">extents</emphasis>: データスペースの最大次元; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: データスペースの型: "scalar", "simple" または "null"; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: 親の名前. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: 親のパス. + </para> + </listitem> + </itemizedlist> + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +dspace_x = a.root.x.dataspace; +// dspace_x はスペース +h5isSpace(dspace_x) +// プロパティにアクセス +dspace_x.dims, dspace_x.extents, dspace_x.type +// 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection id="H5Attribute"> + <title>H5属性</title> + <para>以下のプロパティにアクセス可能です: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: 属性の型; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">dataspace</emphasis>: 属性のデータスペース; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">data</emphasis>: 属性データ; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: 属性名. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: 親のパス. + </para> + </listitem> + </itemizedlist> + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +attr_x = a.root.x.SCILAB_Class; +// attr_x は属性 +h5isAttr(attr_x) +// プロパティにアクセス +attr_x.type, attr_x.dataspace, attr_x.data +// 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection id="H5Type"> + <title>H5型</title> + <para>以下のプロパティにアクセス可能です: + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">class</emphasis>: 型のクラス; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">type</emphasis>: 型名; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">size</emphasis>: 大きさ(単位:バイト); + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">nativetype</emphasis>: この型に関連するネーティブ型; + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">nativesize</emphasis>: ネーティブ型の大きさ. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">name</emphasis>: 親の名前. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">path</emphasis>: 親のパス. + </para> + </listitem> + </itemizedlist> + </para> + <programlisting role="example"><![CDATA[ +x = [1 2;3 4]; +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +type_x = a.root.x.type; +// type_x は型 +h5isType(type_x) +// プロパティにアクセス +type_x.class, type_x.type, type_x.size, type_x.nativetype, type_x.nativesize, +// 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection id="H5Reference"> + <title>H5リファレンス</title> + <para> + H5リファレンスオブジェクトは,各要素がH5オブジェクトへのリファレンスであるハイパー行列オブジェクト + をラップします. + </para> + <programlisting role="example"><![CDATA[ +x = list([1 2;3 4], "Hello", uint32(123)); +save(TMPDIR + "/x.sod", "x"); +a = h5open(TMPDIR + "/x.sod"); +dims_x = a.root.x.dataspace.dims +ref_x = a.root.x.data; +// ref_x はリファレンス +h5isRef(ref_x) +// 3個の要素を取得 +x1 = ref_x(1), x2 = ref_x(2), x3 = ref_x(3) +// データを取得 +x1.data, x2.data, x3.data +// 全リソース解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5attr">h5attr</link> + </member> + <member> + <link linkend="h5close">h5close</link> + </member> + <member> + <link linkend="h5cp">h5cp</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5dump">h5dump</link> + </member> + <member> + <link linkend="h5exists">h5exists</link> + </member> + <member> + <link linkend="h5flush">h5flush</link> + </member> + <member> + <link linkend="h5get">h5get</link> + </member> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5isAttr">h5isAttr</link> + </member> + <member> + <link linkend="h5isFile">h5isFile</link> + </member> + <member> + <link linkend="h5isGroup">h5isGroup</link> + </member> + <member> + <link linkend="h5isRef">h5isRef</link> + </member> + <member> + <link linkend="h5isSet">h5isSet</link> + </member> + <member> + <link linkend="h5isSpace">h5isSpace</link> + </member> + <member> + <link linkend="h5isType">h5isType</link> + </member> + <member> + <link linkend="h5label">h5label</link> + </member> + <member> + <link linkend="h5ln">h5ln</link> + </member> + <member> + <link linkend="h5ls">h5ls</link> + </member> + <member> + <link linkend="h5mount">h5mount</link> + </member> + <member> + <link linkend="h5mv">h5mv</link> + </member> + <member> + <link linkend="h5open">h5open</link> + </member> + <member> + <link linkend="h5readattr">h5read</link> + </member> + <member> + <link linkend="h5rm">h5rm</link> + </member> + <member> + <link linkend="h5umount">h5umount</link> + </member> + <member> + <link linkend="h5write">h5write</link> + </member> + <member> + <link linkend="h5writeattr">h5writeattr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5open.xml b/modules/hdf5/help/ja_JP/h5open.xml new file mode 100755 index 000000000..3aaef1f4b --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5open.xml @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5open" xml:lang="ja"> + <refnamediv> + <refname>h5open</refname> + <refpurpose>HDF5ファイルをオープン</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + obj = h5open(filename [, access]) + obj = h5open(filename, access, driver [, driver_options...]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>access</term> + <listitem> + <para>使用するアクセスモードを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>driver</term> + <listitem> + <para>ドライバ名を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>driver_options</term> + <listitem> + <para>ドライバ値に依存する論理値またはdouble</para> + </listitem> + </varlistentry> + <varlistentry> + <term>obj</term> + <listitem> + <para>オープンするファイルに対応するH5Object</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>アクセスモード(デフォルト:"a")を指定してHDF5ファイルをオープンします.</para> + <para>アクセスモードは5つの値の一つです:</para> + <simplelist type="inline"> + <member> + "r": 読み込みのみ, ファイルが存在している必要があります. + </member> + <member> + "r+": 読み込み/書き込み, ファイルが存在している必要があります. + </member> + <member> + "w": ファイルを作成, 既に存在している場合は切り捨てられます. + </member> + <member> + "w-": ファイルを作成, 既に存在している場合は失敗します. + </member> + <member> + "a": 読み込み/書き込み, 既に存在している場合は追記, それ以外は作成 (デフォルト). + </member> + </simplelist> + <para>複数のドライバを使用できます:</para> + <simplelist type="inline"> + <member> + "sec2": バッファリングなし, 標準POSIX関数を使用. + </member> + <member> + "stdio": I/O処理に標準 C stdio.h の関数を使用. + </member> + <member> + "core": (読み書き性能改善のため)メモリ上にファイルを配置して使用. このドライバには2つのオプションがあります: + <simplelist type="inline"> + <member> + backingStore: 論理値, %T (デフォルト) の場合, 変更は実際のファイルに保存されます. + </member> + <member> + blockSize: double: 増加幅(単位：バイト)で,バッファの大きさを増加する際に使用されます (デフォルト: 64K). + </member> + </simplelist> + </member> + <member> + "family": 大きさがオプションmemberSize (double, デフォルト: 2^31 -1) よりも大きい場合に,ファイルを分割できます. + 一連のファイル名を生成するためにファイル名に %d を含める必要があります. + </member> + </simplelist> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = 1:10; +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイルです +// 作成されたファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// ファイルの内容をダンプ +h5dump(a); +// ルート要素の内容の一覧を取得 +h5ls(a) +// SODバージョンを取得 +a.root.SCILAB_sod_version.data +// または名前に文字 'invalid'を含む場合 +a.root("SCILAB_sod_version").data +// データセットxの内容を取得 +a.root.x.data +// パスを指定して直接データセットをオープンできます +// サブグループまたはデータセットは '/' で分割されます +a("/x") +// リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5close">h5close</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5read.xml b/modules/hdf5/help/ja_JP/h5read.xml new file mode 100755 index 000000000..b9801bbf2 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5read.xml @@ -0,0 +1,144 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5read" xml:lang="ja"> + <refnamediv> + <refname>h5read</refname> + <refpurpose>HDF5データセットのデータを読み込む</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5read(obj [, name, [, start, count [, stride [, block]]]]) + h5read(filename, name [, start, count [, stride [, block]]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>新規データセットへのパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>start</term> + <listitem> + <para>hyperslabのstartを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>count</term> + <listitem> + <para>hyperslabのcountを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>stride</term> + <listitem> + <para>hyperslabのstrideを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>block</term> + <listitem> + <para>>hyperslabのblockを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + オプションのhyperslabセレクションに基づきデータセットの内容を読み込みます. + </para> + <para>データにhyperslabセレクションを作成できます.</para> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="../images/hyperslab_selection.png" align="center" valign="middle"/> + </imageobject> + </inlinemediaobject> + </para> + <para>引数 start, count, stride および block の大きさはデータの次元数と等しい必要があります: + <simplelist type="inline"> + <member> + start: セレクションを開始するデータ内の座標を指定. + </member> + <member> + count: 各次元における選択されたブロックの数を指定. + </member> + <member> + stride: 各次元において連続した2つのブロックの間のシフト量を指定します. + strideは対応するブロックの次元より大きくする必要があることに注意してください. + </member> + <member> + block: ブロックの次元を指定. + </member> + </simplelist> + </para> + <para>各次元において,stride および block はデフォルトで 1に設定されています.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = int8(matrix(1:80, 10, 8)); +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイル +// 作成したファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// データセット 'x'からデータを読み込む +dx = h5read(a, "/x") +// ここで,一部を選択 +dx1 = h5read(a, "/x", [3 4], [5 3]) +// ...これは以下と等価 +dx(3:(3+5-1),4:(4+3-1)) +// 処理を完了し, 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5readattr">h5readattr</link> + </member> + <member> + <link linkend="h5write">h5write</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5readattr.xml b/modules/hdf5/help/ja_JP/h5readattr.xml new file mode 100755 index 000000000..cebf561a7 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5readattr.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5readattr" xml:lang="ja"> + <refnamediv> + <refname>h5readattr</refname> + <refpurpose>HDF5属性のデータを読み込む</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5readattr(obj [, location], name) + h5readattr(filename, location, name) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>属性名のパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>属性を有するグループまたはデータセットへのパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>属性の内容を読み込みます.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = int8(matrix(1:80, 10, 8)); +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイルです +// 作成したファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// ルートグループの属性を読み込む +scilab_version = h5readattr(a, "/", "SCILAB_scilab_version") +// 他の属性を読み込む +sod_version = h5readattr(a.root, "SCILAB_sod_version") +// データセットから読み込む +scilab_class = h5readattr(a.root.x, "SCILAB_Class") +// 処理を完了し, 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5read">h5read</link> + </member> + <member> + <link linkend="h5writeattr">h5writeattr</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5rm.xml b/modules/hdf5/help/ja_JP/h5rm.xml new file mode 100755 index 000000000..1aad67744 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5rm.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5rm" xml:lang="ja"> + <refnamediv> + <refname>h5rm</refname> + <refpurpose>HDF5ファイルから要素を削除</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5rm(obj [, names]) + h5rm(filename, names) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>削除する位置を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>HDF5ファイルのパスを指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>ファイルから一つ以上のオブジェクトを削除します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +a = h5open(TMPDIR + "/test.h5", "a"); +// ルート以下に複数のグループを作成可能 +names = "Group_" + string(1:10); +h5group(a, names) +// これらを表示 +h5ls(a) +// ... または +a.root.groups +// これらから一部を削除可能 +names = "Group_" + string(1:2:10); +h5rm(a, names); +// 全てokか確認we check that all is ok +a.root.groups +// 処理を完了し, 全リソースを解放 +h5close(a); +// 属性も削除可能 +x = %pi; +save(TMPDIR + "/x.sod", "x"); // SOD ファイルは HDF5 ファイル +// 作成したファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// 属性を探す +h5ls(a) +// ... または +a.root.attributes +// 'SCILAB_sod_version'を削除 +h5rm(a, "SCILAB_sod_version"), h5ls(a) +// リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5dataset">h5dataset</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5umount.xml b/modules/hdf5/help/ja_JP/h5umount.xml new file mode 100755 index 000000000..01d830546 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5umount.xml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5umount" xml:lang="ja"> + <refnamediv> + <refname>h5umount</refname> + <refpurpose>マウントされたファイルのマウント解除する.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5umount(obj, location) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>a H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>location</term> + <listitem> + <para>マウントポイントを指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>マウントされたファイルのマウントを解除します.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// HDF5ファイルを作成 +a = h5open(TMPDIR + "/test.h5", "w") +// マウントポイントとして使用するグループを作成 +h5group(a, "/mnt"); +// グループとデータセットを有する他のファイルを作成 +b = h5open(TMPDIR + "/test1.h5", "w") +h5group(b, "Group_1"); +h5write(b, "Group_1/Dataset_1", [1 2;3 4]); +// b を a にマウント +h5mount(a, "/mnt", b) +// aと同等にbを修正または読み込み可能 +a.root.mnt.Group_1.Dataset_1.data +h5write(a.root.mnt.Group_1, "Dataset_1", [10 11;12 13]) +// マウントを解除し, マウントポイントを削除できる +h5umount(a, "/mnt") +h5rm(a, "/mnt") +// 全て閉じる +h5close(a, b) +// b の修正がokかどうか確認 +h5dump(TMPDIR + "/test1.h5", "/Group_1/Dataset_1") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5open">h5open</link> + </member> + </simplelist> + <simplelist type="inline"> + <member> + <link linkend="h5mount">h5mount</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5write.xml b/modules/hdf5/help/ja_JP/h5write.xml new file mode 100755 index 000000000..eac0f59a6 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5write.xml @@ -0,0 +1,166 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5write" xml:lang="ja"> + <refnamediv> + <refname>h5write</refname> + <refpurpose>データセットを作成(存在しない場合)し, データを書き込む</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + h5write(obj, name, data [, targetType], [, start, count [, stride [, block]]]) + h5write(filename, name, data [, targetType], [, start, count [, stride [, block]]]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>obj</term> + <listitem> + <para>H5Object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>データセットへのパスを指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>data</term> + <listitem> + <para>Scilabデータ</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetType</term> + <listitem> + <para>目標型を指定する文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>start</term> + <listitem> + <para>hyperslabのstartを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>count</term> + <listitem> + <para>hyperslabのcountを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>stride</term> + <listitem> + <para>hyperslabのstrideを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>block</term> + <listitem> + <para>hyperslabのblockを保持するdouble行ベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>ファイル名を指定する文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 引数として指定されたScilabデータに基づき,新たに名前付きのデータセットを作成(作成済みでない場合)します. + </para> + <para> + ターゲットのHDF5型は, <ulink url="http://www.hdfgroup.org/HDF5/doc/RM/PredefDTypes.html">HDF5マニュアル</ulink>で + 利用可能なリストから選択できます. + この HDF5 型の例は,"H5T_MIPS_U32" または "H5T_STD_B64BE"ですが, 短縮形 "MIPS_U32" または "STD_B64BE" + も使用できます. + </para> + <para>データ上にhyperslabセレクションを作成できます.</para> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="../images/hyperslab_selection.png" align="center" valign="middle"/> + </imageobject> + </inlinemediaobject> + </para> + <para>引数 start, count, stride および block はデータの次元数に等しい大きさとする必要があります: + <simplelist type="inline"> + <member> + start: セレクションを開始するデータ内の座標を指定. + </member> + <member> + count: 各次元で選択されたブロックの数. + </member> + <member> + stride: 各次元において連続する2つのブロック間のシフト量を指定. + </member> + <member> + block: ブロックの次元を指定. + </member> + </simplelist> + デフォルトで各次元のstrideとblockは1に設定されています. + </para> + <para> + 目標の型が "H5T_STD_REF_OBJ"の場合,data行列は + グループまたはデータセットの絶対パスを保持する文字列行列とする必要があります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +x = matrix(1:20, 4, 5); +save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイルです +// 作成されたファイルをオープン +a = h5open(TMPDIR + "/x.sod"); +// "y"という名前の新規データセットを追加 +y = uint32(matrix(10:30, 7, 3)); +h5write(a, "y", y); +// MIPS形式でデータセット"z"を追加 +h5write(a, "z", y, "H5T_MIPS_U32"); +// ここでhyperslabセレクションを作成 +x = uint32(matrix(1:(11*17), 11, 17)); +h5write(a, "t", x, [1 2], [2 4], [5 3], [3 2]); +// 全てokかどうか確認 +x, a("/t").data' +// 処理を完了し, 全リソースを解放 +h5close(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5group">h5group</link> + </member> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/ja_JP/h5writeattr.xml b/modules/hdf5/help/ja_JP/h5writeattr.xml new file mode 100755 index 000000000..8bcb291f3 --- /dev/null +++ b/modules/hdf5/help/ja_JP/h5writeattr.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5writeattr" xml:lang="ja"> + <refnamediv> + <refname>h5writeattr</refname> + <refpurpose>グループまたはデータセット内に属性を書き込む</refpurpose> + </refnamediv> + <refsection> + <para>この関数はh5attrと等価です.</para> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="h5attr">h5attr</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>HDF5モジュールが導入されました.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/hdf5/help/pt_BR/addchapter.sce b/modules/hdf5/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..0dc5f1605 --- /dev/null +++ b/modules/hdf5/help/pt_BR/addchapter.sce @@ -0,0 +1,10 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("HDF5 Management",SCI+"/modules/hdf5/help/pt_BR",%T); diff --git a/modules/hdf5/help/ru_RU/addchapter.sce b/modules/hdf5/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..190a7b062 --- /dev/null +++ b/modules/hdf5/help/ru_RU/addchapter.sce @@ -0,0 +1,10 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("HDF5 Management",SCI+"/modules/hdf5/help/ru_RU",%T); |
