NeXus  4.4.3
 All Data Structures Files Functions Variables Typedefs Macros Pages
NeXus API documentation

2000-2008 NeXus Group

Purpose of API

The NeXus Application Program Interface is a suite of subroutines, written in C but with wrappers in C++, JAVA, PYTHON, Fortran 77 and 90. The subroutines call HDF routines to read and write the NeXus files with the correct structure.

An API serves a number of useful purposes:

Core API

The core API provides the basic routines for reading, writing and navigating NeXus files. It is designed to be modal; there is a hidden state that determines which groups and data sets are open at any given moment, and subsequent operations are implicitly performed on these entities. This cuts down the number of parameters to pass around in API calls, at the cost of forcing a certain pre-approved mode d'emploi. This mode d'emploi will be familiar to most: it is very similar to navigating a directory hierarchy; in our case, NeXus groups are the directories, which contain data sets and/or other directories.

The core API comprises several functional groups which are listed on the Modules tab.

C programs that call the above routines should include the following header file:

* #include "napi.h"
See Also