Editing Library Reference (section)

=Matlab API=
Data types are indicated in ''italics''. In the '''Wrapper for''' column, procedure names with no other description belong to the C library. The '''G?''' heading means: "Demo-ed in the [[Guide_to_madagascar_API#MATLAB_interface|Guide to the Matlab API]]?"

{|class="wikitable" align="center" cellspacing="0" border="1"
|-
| '''Name''' || '''Arguments''' || '''What it does''' || '''Wrapper for''' || '''G?''' 
|-
| <tt>rsf_create</tt> || Arg 1: ''string (row vector)'' <tt>new_file_name</tt>;<br /> Arg 2: ''string (row vector)'' <tt>old_file_name</tt>, or ''double (column vector)'' '''in''' <tt>new_file_cube_dims</tt>  || Writes to disk RSF header of native_float hypercube of desired dimensions. Takes as input the name of the new file and either the name of another file with a cube of the same size, or a column with cube dimensions || <tt>sf_fileflush</tt>, or <tt>sf_putint</tt> and <tt>sf_setformat</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> || 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, 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 
|}