Data Table File Format (ODT)
Keywords: userguide

Next: Vector Field File Format Up: OOMMF Documentation Previous: MIF 2.2

#
Data Table File Format (ODT)

Textual output from solver applications that is not of the vector field variety is output in the OOMMF Data Table (ODT) format. This is an ASCII text file format, with column information in the header and one line of data per record. Any line ending in a '`\`' character is joined to the succeeding line before any other processing is performed. Any leading ``#`' characters on the second line are removed.

As with the OVF format, all non-data lines begin with a ``#`' character, comments with two ``#`' characters. (This makes it easier to import the data into external programs, for example, plotting packages.) An example is included below.

The first line of an ODT file should be the file type descriptor

    # ODT 1.0

It is also recommended that ODT files be given names ending in the file extension `.odt` so that ODT files may be easily identified.

The remaining lines of the ODT file format should be comments, data, or any of the following 5 recognized descriptor tag lines:

- `#` Table Start: Optional, used to segment a file containing multiple data table blocks. Anything after the colon is taken as an optional label for the following data block.
- `#` Title: Optional; everything after the colon is interpreted as a title for the table.
- `#` Columns: Required. One parameter per column, designating the label header for that column. Spaces may be embedded in a column label by using the normal Tcl grouping mechanisms (i.e., double-quotes and braces).
- `#` Units: Optional. If given, it should have one parameter for each column, giving a unit label for the corresponding column. Spaces may be embedded in the unit labels, in the same manner as for column headers.
- `#` Table End: Optional, no parameters. Should be paired with a corresponding Table Start record.

Data may appear anywhere after the Columns descriptor record and before any Table End line, with one record per line. The data should be numeric values separated by whitespace. The two character open-close curly brace pair, { }, is used to indicate a missing value.

Embedded newlines and carriage returns are not allowed in the title, columns, or units records.

The command line utility, odtcols, can be a useful tool for examining and partitioning ODT files.

    # ODT 1.0
    # Table Start
    # Title: This is a small sample ODT file.
    #
    ## This is a sample comment.  You can put anything you want
    ## on comment lines.
    #
    # Columns: Iteration "Applied Field"  {Total Energy}    Mx
    # Units:      {}          "mT"           "J/m^3"       "A/m"
                  103          50            0.00636      787840
                 1000          32            0.00603      781120
                10300       -5000            0.00640     -800e3
    # Table End

Figure 10: Sample ODT file. (Description.)

OOMMF Documentation Team
September 29, 2018