Editing Library Reference (section)

== SWIG API ==
The SWIG API includes three classes.  The methods that each class exposes are as follows:

=== RSF ===
<java>
public RSF(String[] args);                           // Constructor, pass the command line arguments
public float getFloat(String key, float default);    // Gets the command line argument associated with this key.
public int getInt(String key, int default);          // Gets an int from the command line associated with this key.
public boolean getBool(String key, boolean default); // Gets a boolean from the command line associated with this key.
public String getString(String key, String default); // Gets a string corresponding to this key.
</java>

=== Input ===
<java>
public Input(String name);                           // Constructor, pass a filename.  "in" defaults to stdin
public int getN(int index);                          // Gets the number of elements in the file for that index.  Counting starts at 1. Returns 1 if not found.
public float getDelta(int index);                    // Gets the delta for that index. Returns 0.0 if not found.
public float getOrigin(int index);                   // Gets the origin for that file. Returns 0.0 if not found.  
public String getLabel(int index);                   // Gets the label name for the index.  Returns "" if not found.
public String getUnit(int index);                    // Gets the unit for the index.  Returns "" if not found.
public void close();                                 // Close the file.
public void read(float[] array);                     // Read data from the open RSF file into the given array.  Reads the length of the array only.
public void read(float[][] array);                   // The following methods all read data from the RSF file in the given shape of the array.
public void read(float[][][] array);
public void read(float[][][][] array);
public void read(float[][][][][] array);
public void read(float[][][][][][] array);
public void read(float[][][][][][][] array);
public void read(float[][][][][][][][] array);
public void read(float[][][][][][][][][] array);
</java>

=== Output ===
<java>
public Output(String name);                           // Constructor, pass a filename.  "out" points to standard out.
public void setN(int index, int n);                   // Gets the number of elements in the file for that index.  Counting starts at 1. Returns 1 if not found.
public void setDelta(int index, float delta);         // Gets the delta for that index. Returns 0.0 if not found.
public void setOrigin(int index, float origin);       // Gets the origin for that file. Returns 0.0 if not found.  
public void setLabel(int index, String label);        // Gets the label name for the index.  Returns "" if not found.
public void setUnit(int index, String unit);          // Gets the unit for the index.  Returns "" if not found.
public void close();                                  // Close the file.
public void write(float[] array);                     // Writes data to the RSF file from the given array.  Writes the shape of the array only.
public void write(float[][] array);                   // The following methods all write data using the given shape of the array.
public void write(float[][][] array);
public void write(float[][][][] array);
public void write(float[][][][][] array);
public void write(float[][][][][][] array);
public void write(float[][][][][][][] array);
public void write(float[][][][][][][][] array);
public void write(float[][][][][][][][][] array);
</java>

Additional notes:

Java does not support complex numbers by default.  To use complex numbers, you must convert complex valued RSF files to floating point numbers using sfdd .