areaDetector
3-13
EPICS areaDetector framework
|
Writes NDArrays in the TIFF file format. More...
#include <NDFileTIFF.h>
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. More... | |
virtual asynStatus | openFile (const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray) |
Opens a TIFF file. More... | |
virtual asynStatus | readFile (NDArray **pArray) |
Reads single NDArray from a TIFF file;. More... | |
virtual asynStatus | writeFile (NDArray *pArray) |
Writes single NDArray to the TIFF file. More... | |
virtual asynStatus | closeFile () |
Closes the TIFF file. More... | |
Public Member Functions inherited from NDPluginFile | |
NDPluginFile (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize, int maxThreads, bool compressionAware=false) | |
Constructor for NDPluginFile; all parameters are simply passed to NDPluginDriver::NDPluginDriver. More... | |
virtual void | processCallbacks (NDArray *pArray) |
Callback function that is called by the NDArray driver with new NDArray data. More... | |
virtual asynStatus | writeInt32 (asynUser *pasynUser, epicsInt32 value) |
Called when asyn clients call pasynInt32->write(). More... | |
virtual asynStatus | writeNDArray (asynUser *pasynUser, void *genericPointer) |
Public Member Functions inherited from NDPluginDriver | |
NDPluginDriver (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize, int maxThreads, bool compressionAware=false) | |
Constructor for NDPluginDriver; most parameters are simply passed to asynNDArrayDriver::asynNDArrayDriver. More... | |
~NDPluginDriver () | |
virtual asynStatus | writeFloat64 (asynUser *pasynUser, epicsFloat64 value) |
Called when asyn clients call pasynFloat64->write(). More... | |
virtual asynStatus | writeOctet (asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual) |
Called when asyn clients call pasynOctet->write(). More... | |
virtual asynStatus | readInt32Array (asynUser *pasynUser, epicsInt32 *value, size_t nElements, size_t *nIn) |
Called when asyn clients call pasynInt32Array->read(). More... | |
virtual void | driverCallback (asynUser *pasynUser, void *genericPointer) |
Method that is called from the driver with a new NDArray. More... | |
virtual void | run (void) |
Starts the thread that receives NDArrays from the epicsMessageQueue. More... | |
virtual asynStatus | start (void) |
Starts the plugin threads. More... | |
void | sortingTask () |
Method runs as a separate thread, periodically doing NDArray callbacks to downstream plugins. More... | |
Public Member Functions inherited from asynNDArrayDriver | |
asynNDArrayDriver (const char *portName, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) | |
This is the constructor for the asynNDArrayDriver class. More... | |
virtual | ~asynNDArrayDriver () |
virtual asynStatus | readGenericPointer (asynUser *pasynUser, void *genericPointer) |
This method copies an NDArray object from the asynNDArrayDriver to an NDArray pointer passed in by the caller. More... | |
virtual asynStatus | writeGenericPointer (asynUser *pasynUser, void *genericPointer) |
This method currently does nothing, but it should be implemented in this base class. More... | |
virtual asynStatus | setIntegerParam (int index, int value) |
Sets the value for an integer in the parameter library. More... | |
virtual asynStatus | setIntegerParam (int list, int index, int value) |
Sets the value for an integer in the parameter library. More... | |
virtual void | report (FILE *fp, int details) |
Report status of the driver. More... | |
virtual asynStatus | createFilePath (const char *path, int pathDepth) |
Function to create a directory path for a file. More... | |
virtual asynStatus | checkPath () |
Checks whether the directory specified NDFilePath parameter exists. More... | |
virtual bool | checkPath (std::string &filePath) |
Checks whether the directory specified exists. More... | |
virtual asynStatus | createFileName (int maxChars, char *fullFileName) |
Build a file name from component parts. More... | |
virtual asynStatus | createFileName (int maxChars, char *filePath, char *fileName) |
Build a file name from component parts. More... | |
virtual asynStatus | readNDAttributesFile () |
Create this driver's NDAttributeList (pAttributeList) by reading an XML file This clears any existing attributes from this drivers' NDAttributeList and then creates a new list based on the XML file. More... | |
virtual asynStatus | getAttributes (NDAttributeList *pAttributeList) |
Get the current values of attributes from this driver and appends them to an output attribute list. More... | |
virtual void | updateTimeStamps (NDArray *pArray) |
asynStatus | incrementQueuedArrayCount () |
asynStatus | decrementQueuedArrayCount () |
int | getQueuedArrayCount () |
void | updateQueuedArrayCount () |
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.
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.
[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. |
|
virtual |
Closes the TIFF file.
Implements NDPluginFile.
|
virtual |
Opens a TIFF file.
[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.
|
virtual |
Reads single NDArray from a TIFF file;.
[in] | pArray | Pointer to the NDArray to be read |
Implements NDPluginFile.
|
virtual |
Writes single NDArray to the TIFF file.
[in] | pArray | Pointer to the NDArray to be written |
Implements NDPluginFile.