NDFileTIFF Class Reference

Writes NDArrays in the TIFF file format. More...

#include <NDFileTIFF.h>

Inheritance diagram for NDFileTIFF:

NDPluginFile NDPluginDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 NDFileTIFF (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int priority, int stackSize)
 Constructor for NDFileTIFF; all parameters are simply passed to NDPluginFile::NDPluginFile.
virtual asynStatus openFile (const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray)
 Opens a TIFF file.
virtual asynStatus readFile (NDArray **pArray)
 Reads single NDArray from a TIFF file; NOT CURRENTLY IMPLEMENTED.
virtual asynStatus writeFile (NDArray *pArray)
 Writes single NDArray to the TIFF file.
virtual asynStatus closeFile ()
 Closes the TIFF file.


Detailed Description

Writes NDArrays in the TIFF file format.

Tagged Image File Format is a file format for storing images. The format was originally created by Aldus corporation and is currently developed by Adobe Systems Incorporated. This plugin was developed using the libtiff library to write the file. The current version is only capable of writing 2-D images with one image per file.


Constructor & Destructor Documentation

NDFileTIFF::NDFileTIFF ( const char *  portName,
int  queueSize,
int  blockingCallbacks,
const char *  NDArrayPort,
int  NDArrayAddr,
int  priority,
int  stackSize 
)

Constructor for NDFileTIFF; all parameters are simply passed to NDPluginFile::NDPluginFile.

Parameters:
[in] portName The name of the asyn port driver to be created.
[in] queueSize The number of NDArrays that the input queue for this plugin can hold when NDPluginDriverBlockingCallbacks=0. Larger queues can decrease the number of dropped arrays, at the expense of more NDArray buffers being allocated from the underlying driver's NDArrayPool.
[in] blockingCallbacks Initial setting for the NDPluginDriverBlockingCallbacks flag. 0=callbacks are queued and executed by the callback thread; 1 callbacks execute in the thread of the driver doing the callbacks.
[in] NDArrayPort Name of asyn port driver for initial source of NDArray callbacks.
[in] NDArrayAddr asyn port driver address for initial source of NDArray callbacks.
[in] priority The thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in] stackSize The stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.


Member Function Documentation

asynStatus NDFileTIFF::closeFile (  )  [virtual]

Closes the TIFF file.

Implements NDPluginFile.

asynStatus NDFileTIFF::openFile ( const char *  fileName,
NDFileOpenMode_t  openMode,
NDArray pArray 
) [virtual]

Opens a TIFF file.

Parameters:
[in] fileName The name of the file to open.
[in] openMode Mask defining how the file should be opened; bits are NDFileModeRead, NDFileModeWrite, NDFileModeAppend, NDFileModeMultiple
[in] pArray A pointer to an NDArray; this is used to determine the array and attribute properties.

Implements NDPluginFile.

asynStatus NDFileTIFF::readFile ( NDArray **  pArray  )  [virtual]

Reads single NDArray from a TIFF file; NOT CURRENTLY IMPLEMENTED.

Parameters:
[in] pArray Pointer to the NDArray to be read

Implements NDPluginFile.

asynStatus NDFileTIFF::writeFile ( NDArray pArray  )  [virtual]

Writes single NDArray to the TIFF file.

Parameters:
[in] pArray Pointer to the NDArray to be written

Implements NDPluginFile.


The documentation for this class was generated from the following files:

Generated on Tue Aug 9 14:44:38 2011 for areaDetector by  doxygen 1.5.7.1