Library Reference - Revision history

Nick: /* Calling standalone madagascar programs from Python */

2011-07-24T18:54:52Z

Calling standalone madagascar programs from Python

← Older revision		Revision as of 18:54, 24 July 2011
Line 367:		Line 367:
	On systems with recent versions of Python (at least 2.4), and with Numpy and Swig installed, use [http://www.reproducibility.org/rsflog/index.php?/archives/264-Running-Madagascar-in-an-interactive-console.html the m8r module].		On systems with recent versions of Python (at least 2.4), and with Numpy and Swig installed, use [http://www.reproducibility.org/rsflog/index.php?/archives/264-Running-Madagascar-in-an-interactive-console.html the m8r module].

	On old systems where dependencies cannot be easily installed (i.e. industrial clusters), the <tt>sf</tt> module (i.e. <tt>import rsf.user.sf as sf</tt>).		On old systems where dependencies cannot be easily installed (i.e. industrial clusters), use the <tt>sf</tt> module (i.e. <tt>import rsf.user.sf as sf</tt>).

	=SCons custom methods=		=SCons custom methods=

Nick: /* Calling standalone madagascar programs from Python */

2011-07-24T18:48:53Z

Calling standalone madagascar programs from Python

← Older revision		Revision as of 18:48, 24 July 2011
Line 365:		Line 365:

	=Calling standalone madagascar programs from Python=		=Calling standalone madagascar programs from Python=
	On systems with recent versions of Python (at least 2.4), and with Numpy and Swig installed, use [http://www.reproducibility.org/rsflog/index.php?/archives/264-Running-Madagascar-in-an-interactive-console.html the m8r module.		On systems with recent versions of Python (at least 2.4), and with Numpy and Swig installed, use [http://www.reproducibility.org/rsflog/index.php?/archives/264-Running-Madagascar-in-an-interactive-console.html the m8r module].

	On old systems where dependencies cannot be easily installed (i.e. industrial clusters), the <tt>sf</tt> module (i.e. <tt>import rsf.user.sf as sf</tt>).		On old systems where dependencies cannot be easily installed (i.e. industrial clusters), the <tt>sf</tt> module (i.e. <tt>import rsf.user.sf as sf</tt>).

Nick: /* SCons custom methods */

2011-07-24T18:48:39Z

SCons custom methods

← Older revision		Revision as of 18:48, 24 July 2011
Line 363:		Line 363:
	\|Vppen		\|Vppen
	\|}		\|}

			=Calling standalone madagascar programs from Python=
			On systems with recent versions of Python (at least 2.4), and with Numpy and Swig installed, use [http://www.reproducibility.org/rsflog/index.php?/archives/264-Running-Madagascar-in-an-interactive-console.html the m8r module.

			On old systems where dependencies cannot be easily installed (i.e. industrial clusters), the <tt>sf</tt> module (i.e. <tt>import rsf.user.sf as sf</tt>).

	=SCons custom methods=		=SCons custom methods=

Nick: /* Python API */

2011-07-24T18:39:04Z

Python API

← Older revision		Revision as of 18:39, 24 July 2011
Line 318:		Line 318:

	To use the python api, you need to import the rsf package via: <tt>import rsf.api</tt> .		To use the python api, you need to import the rsf package via: <tt>import rsf.api</tt> .

			'''NOTE: Madagascar now has automatic documentation, currently with Epydoc, and more to come. The information in the table below will be merged into it.'''

	The rsf package has the following members:		The rsf package has the following members:

Nick: /* Matlab API */ complex data in rsf_read

2011-02-19T12:37:27Z

Matlab API: complex data in rsf_read

← Older revision		Revision as of 12:37, 19 February 2011
Line 190:		Line 190:
	\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N		\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N
	\|-		\|-
	\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or ~~SF_INT~~ type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y		\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT, SF_INT or SF_COMPLEX type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt>, <tt>sf_complexread</tt> \|\| Y
	\|-		\|-
	\| <tt>rsf_write</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Writes <tt>data_array</tt> to <tt>filename</tt>. Data to be written can be integer, float, double or complex. It will get cast to RSF's native_float or native_complex encoding. \|\| <tt>sf_floatwrite</tt>, <tt>sf_complexwrite</tt> \|\| Y		\| <tt>rsf_write</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Writes <tt>data_array</tt> to <tt>filename</tt>. Data to be written can be integer, float, double or complex. It will get cast to RSF's native_float or native_complex encoding. \|\| <tt>sf_floatwrite</tt>, <tt>sf_complexwrite</tt> \|\| Y

Nick: /* Matlab API */ rsf_write

2010-12-15T01:44:44Z

Matlab API: rsf_write

← Older revision		Revision as of 01:44, 15 December 2010
Line 192:		Line 192:
	\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y		\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y
	\|-		\|-
	\| <tt>rsf_write</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Writes <tt>data_array</tt> to <tt>filename</tt>. Data to be written can be integer, float, double or complex. It will get cast to RSF's native_float or native_complex encoding \|\| <tt>sf_floatwrite</tt>, <tt>sf_complexwrite</tt> \|\| Y		\| <tt>rsf_write</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Writes <tt>data_array</tt> to <tt>filename</tt>. Data to be written can be integer, float, double or complex. It will get cast to RSF's native_float or native_complex encoding. \|\| <tt>sf_floatwrite</tt>, <tt>sf_complexwrite</tt> \|\| Y
	\|}		\|}

Nick: /* Matlab API */

2010-12-15T01:44:26Z

Matlab API

← Older revision		Revision as of 01:44, 15 December 2010
Line 192:		Line 192:
	\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y		\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y
	\|-		\|-
	\| <tt>rsf_write</tt> \|\| '''~~Arguments~~''' \|\| '''~~What it does~~''' \|\| '~~''Wrapper for'''~~ \|\| Y		\| <tt>rsf_write</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Writes <tt>data_array</tt> to <tt>filename</tt>. Data to be written can be integer, float, double or complex. It will get cast to RSF's native_float or native_complex encoding \|\| <tt>sf_floatwrite</tt>, <tt>sf_complexwrite</tt> \|\| Y
	\|}		\|}

Nick: /* Matlab API */ finished rsf_read

2010-12-15T01:31:52Z

Matlab API: finished rsf_read

← Older revision		Revision as of 01:31, 15 December 2010
Line 190:		Line 190:
	\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N		\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N
	\|-		\|-
	\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y		\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type. The <tt>same</tt> parameter is a way to indicate if the data is read from the same file as before or from a newly opened file. If <tt>same</tt> is not given, the data will be read from the beginning of the file. \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y
	\|-		\|-
	\| <tt>rsf_write</tt> \|\| '''Arguments''' \|\| '''What it does''' \|\| '''Wrapper for''' \|\| Y		\| <tt>rsf_write</tt> \|\| '''Arguments''' \|\| '''What it does''' \|\| '''Wrapper for''' \|\| Y

Nick: /* Matlab API */ rsf_read

2010-12-13T21:08:18Z

Matlab API: rsf_read

← Older revision		Revision as of 21:08, 13 December 2010
Line 190:		Line 190:
	\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N		\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N
	\|-		\|-
	\| <tt>rsf_read</tt> \|\| '''~~Arguments~~''' \|\| '''~~What it does~~''' \|\| ~~'''Wrapper for'''~~ \|\| Y		\| <tt>rsf_read</tt> \|\| Arg 1: ''double'' <tt>data_array</tt>;<br /> Arg 2: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 3 (optional): ''string (row vector)'' <tt>same</tt>. If Arg 3 is given, value should be "same" \|\| Reads <tt>data_array</tt> from <tt>filename</tt>. Input data should be of SF_FLOAT or SF_INT type \|\| <tt>sf_floatread</tt>, <tt>sf_intread</tt> \|\| Y
	\|-		\|-
	\| <tt>rsf_write</tt> \|\| '''Arguments''' \|\| '''What it does''' \|\| '''Wrapper for''' \|\| Y		\| <tt>rsf_write</tt> \|\| '''Arguments''' \|\| '''What it does''' \|\| '''Wrapper for''' \|\| Y

Nick: /* Matlab API */ rsf_par

2010-12-13T19:19:24Z

Matlab API: rsf_par

← Older revision		Revision as of 19:19, 13 December 2010
Line 188:		Line 188:
	\| <tt>rsf_dim</tt> \|\| Arg1: ''string (row vector)'' <tt>filename</tt> \|\| Returns a 9-element vector [n1, n2, ... n9] with the dimensions of the hypercube as described in the RSF header '''filename'''. Missing dimensions are given the value 1 \|\| <tt>sf_filedims</tt> \|\| Y		\| <tt>rsf_dim</tt> \|\| Arg1: ''string (row vector)'' <tt>filename</tt> \|\| Returns a 9-element vector [n1, n2, ... n9] with the dimensions of the hypercube as described in the RSF header '''filename'''. Missing dimensions are given the value 1 \|\| <tt>sf_filedims</tt> \|\| Y
	\|-		\|-
	\| <tt>rsf_par</tt> \|\| '''~~Arguments~~''' \|\| '''~~What it does~~''' \|\| ''~~'Wrapper for'~~'' \|\| N		\| <tt>rsf_par</tt> \|\| Arg 1: ''string (row vector)'' <tt>filename</tt>;<br /> Arg 2: ''string (row vector)'' <tt>par_name</tt>;<br /> Arg 3: ''string (row vector)'' <tt>par_type</tt>: i[nt], l[ogical], f[loat];<br /> Arg 4: ''double (scalar)'' <tt>default_val</tt> \|\| Returns a scalar parameter read from a RSF header \|\| <tt>sf_histint</tt>, <tt>sf_histbool</tt>, <tt>sf_histfloat</tt> \|\| N
	\|-		\|-
	\| <tt>rsf_read</tt> \|\| '''Arguments''' \|\| '''What it does''' \|\| '''Wrapper for''' \|\| Y		\| <tt>rsf_read</tt> \|\| '''Arguments''' \|\| '''What it does''' \|\| '''Wrapper for''' \|\| Y