Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::io::FileGrabberPluginCSV Class Reference

FileGrabber plugins for writing ".csv" files (Comma-Separated Values) More...

#include <FileGrabberPluginCSV.h>

Inheritance diagram for icl::io::FileGrabberPluginCSV:
icl::io::FileGrabberPlugin

Public Member Functions

 FileGrabberPluginCSV ()
 Create a new Plugin. More...
 
 ~FileGrabberPluginCSV ()
 Destructor. More...
 
virtual void grab (utils::File &file, core::ImgBase **dest)
 grab implementation More...
 
- Public Member Functions inherited from icl::io::FileGrabberPlugin
virtual ~FileGrabberPlugin ()
 

Private Attributes

core::Img64fm_poReadBuffer
 internally used reading buffer More...
 
utils::Mutexm_poReadBufferMutex
 internally used mutex to protect the reading buffer More...
 

Detailed Description

FileGrabber plugins for writing ".csv" files (Comma-Separated Values)

image parameters can be found by three different means:

  1. Encoded into the file name. When using the ICLFileWriter to write csv files, it can be set up to encode the images parameter into the filename using a string extension of the underlying filename. The following pattern is used for this: "DIR/ORIG_FILE_BASE_NANE-ICL:WxHxC:DEPTH:format.csv"
  2. As comment block Although the CSV-file convention does not include comments, a common standard is to add a "#"-character to signal comment lines. By this means, a default ".icl"-header can be used to define an csv-images shape and parameters.
  3. Interpret a csv file as matrix data If no of the other two possibilities were successful to determine a csv-image's size, the file is interpreted as double-matrix. The line count of the matrix defines the image height; its horizontal comma-separated token count defines its width.

Constructor & Destructor Documentation

◆ FileGrabberPluginCSV()

icl::io::FileGrabberPluginCSV::FileGrabberPluginCSV ( )

Create a new Plugin.

◆ ~FileGrabberPluginCSV()

icl::io::FileGrabberPluginCSV::~FileGrabberPluginCSV ( )

Destructor.

Member Function Documentation

◆ grab()

virtual void icl::io::FileGrabberPluginCSV::grab ( utils::File file,
core::ImgBase **  dest 
)
virtual

grab implementation

Implements icl::io::FileGrabberPlugin.

Member Data Documentation

◆ m_poReadBuffer

core::Img64f* icl::io::FileGrabberPluginCSV::m_poReadBuffer
private

internally used reading buffer

◆ m_poReadBufferMutex

utils::Mutex* icl::io::FileGrabberPluginCSV::m_poReadBufferMutex
private

internally used mutex to protect the reading buffer


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