From 86043efb6e953665320fbe2d963558349de81e69 Mon Sep 17 00:00:00 2001 From: rivers Date: Tue, 23 Sep 2008 13:29:51 +0000 Subject: [PATCH] Documented netCDF file contents and IDL file reading function git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@7670 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/NDPluginFile.html | 82 ++++++++++++++++++++++++++++++--- 1 file changed, 76 insertions(+), 6 deletions(-) diff --git a/documentation/NDPluginFile.html b/documentation/NDPluginFile.html index 3681a53..d253da5 100755 --- a/documentation/NDPluginFile.html +++ b/documentation/NDPluginFile.html @@ -1,4 +1,4 @@ - +a areaDetector Plugin NDPluginFile @@ -19,6 +19,9 @@
  • Overview
  • Configuration
  • Screen shots
    • +
  • netCDF file contents
    • +
  • IDL file reading function
    • +
  • Future plans

    • Overview @@ -31,8 +34,7 @@ netCDF file format, which is a portable self-describing binary file format supported by UniData at UCAR (University Corporation for Atmospheric - Research). Additional file formats, such as TIFF and HDF may be supported - in the future. + Research).

    The NDArray callback data can be written to disk in 1 of 3 modes: @@ -80,9 +82,9 @@ public: }

    - NDPluginFile also supports all of the file saving parameters defined in ADStdDriverParams.h - described above, e.g.ADFilePath, ADFileName, etc. Thus, the same interface that - is used for saving files directly in a driver are used for this plugin. + NDPluginFile supports all of the file saving parameters defined in + ADStdDriverParams.h, e.g. ADFilePath, ADFileName, etc. Thus, the same interface + that is used for saving files directly in a driver is used for this plugin.

    Configuration

    @@ -154,5 +156,73 @@ public:

    NDFile.png

    +

    + netCDF file contents

    +

    + The following is the header contents of a netCDF file produced by this plugin. This + information was produced with the following command:

    + 
    +ncdump -h test_A_2.nc
+
+netcdf test_A_2 {
+dimensions:
+	numArrays = 200 ;
+	dim0 = 480 ;
+	dim1 = 640 ;
+variables:
+	int uniqueId(numArrays) ;
+	double timeStamp(numArrays) ;
+	byte array_data(numArrays, dim0, dim1) ;
+
+// global attributes:
+		:dataType = 0 ;
+		:numArrayDims = 2 ;
+		:dimSize = 640, 480 ;
+		:dimOffset = 0, 0 ;
+		:dimBinning = 1, 1 ;
+		:dimReverse = 0, 0 ;
+}
+
    +

    + This is an explanation of this output: +

    + +

    + IDL file reading function

    +

    + There is an IDL function, + read_nd_netcdf that can be used to read the netCDF files created by this plugin. + This routine is contained in the + CARS IDL detector package. This function is currently limited to reading the + entire file at once, so it may fail for very large files on machines with insufficient + virtual memory. This will be fixed in a future release. +

    +

    + Future plans

    +

    + Additional file formats, such as TIFF and HDF may be supported in the future. +

    +

    + The IDL function described above will be enhanced to allow reading only a subset + of the file at a time. +