Nan Eye Labview API. 07/05/13 Version DATE: 07/05/13 PAGE: 1/14

Transcription

1 Nan Eye Labview API DATE: PAGE: 1/14

2 Revision History: Version Date Modifications Author Document creation Duarte Goncalves DATE: PAGE: 2/14

3 Table of Contents 1 Introduction Nan Eye Labview API - How to Install: Labview Functions Basic Nan Eye Interface Functions Description Manager Init Set Source Start Get Next Frame Pipe Config Config Sensor Stop Manager De Init Get Error Text Get Version Get Frame Dimensions...14 DATE: PAGE: 3/14

4 Index of Tables Index of Figures Figure 1: Nan Eye Functions Library...5 Figure 2: Destination Folder of the Library Files...8 Figure 3: Nan Eye application example...9 Figure 4: Pixel buffer data initialization...11 DATE: PAGE: 4/14

5 1 Introduction The Nan Eye Labview API retrieves and displays images from the Nan Eye Sensor using the EFM 001 USB device and the NanEye USB 2.0. It allows the user to configure the sensor using for that top level functions. The API functions are complied on a Labview Library as shown on the above picture. That can be easily integrated on any Labview Development Environment.The LabView API is created and tested with LabView It is expected that newer versions of LabView are compatible as well. As the API is designed to only use standard language elements, there is a good chance that older LabView implementations can be used too, but they are not officially supported. Figure 1: Nan Eye Functions Library The Functions Library has following functions: Config Sensor.vi Finish Destination.vi Get Error Text.vi Get Frame Dimensions.vi Get Next Frame.vi Get Version.vi DATE: PAGE: 5/14

6 Load Black Level Dimensions.vi Load Black Level.vi Load Pixel Linearisation.vi Load White Level Dimensions.vi Load White Level.vi Manager De Init.vi Manager Init.vi Pause.vi PipeConfig.vi Save Black Level.vi Save White Level.vi Seek.vi Set Black Level.vi Set White Level.vi SetSource.vi Start.vi Stop.vi DATE: PAGE: 6/14

7 2 Nan Eye Labview API - How to Install: Before using this Labview API, the CESYS USB drivers must already installed, therefore we recommend you to first install the Awaiba Nan Eye Viewer software. After Nan Eye software installation you should extract the files in "LabView_API.zip". The awcore folder contains the library with all API functions and *.dll files. This folder should be placed under the following location: :\Program Files\National Instruments\LabVIEW ####\user.lib\... #### stands for the LabView version you have installed. this library should show up on the LabView function palette, after restarting LabView. To start working with the NanEye LabView API, there s an example project called NanEyeViewer, that uses the most basic set of functions to get images form the sensor, and perform a couple of configuration steps. The Naneye_Example folder you can extract anywhere. Please make sure the efm01_awaiba_viewer_top.bin is always present on the same folder your vi. Steps to use the Labview API are : 1) Install the Cesys UDK USB Driver, preferentially trough the NanEye Viewer installation. DATE: PAGE: 7/14

8 Figure 2: Destination Folder of the Library Files 2) Extract the Labview Library awcore to the user.lib folder as in Figure 2. 3) Extract the Labview Nan Eye Example to anywhere. We recommend you to place it under Labview Data folder on My Documents folder. 4) Connect the sensor to the USB port, and wait for the drivers installation warnings. 5) Open the NanEyeViewer.lproj project, and star to operate the Nan Eye Camera. DATE: PAGE: 8/14

9 3 Labview Functions The Labview API functions library provides you with group of 23 functions as mentioned in chapter 1. This functions call the awcore.dll API to interact with the Awaiba Nan Eye Camera. 3.1 Basic Nan Eye Interface A sample project is provided to shorten the development time of a Labview interface for your NanEye camera. This application uses only the fundamental function, that permit you to get and send data to the camera system. Figure 3: Nan Eye application example This interface displays images, and enables the user to configure the camera frame parameters through the PipeConfig tab. It presents all the configuration parameters concerning the PipeConfig.vi. In order to correctly initialize and operate the camera there's a particular set of functions that must be always called by this specific order: 1. ManagerInit.vi 2. SetSource.vi 3. Star.vi To get images the frames from the frame buffer GetNextframe.vi must be called one time for every frame. In order to stop operation is important to call : 1. Stop.vi 2. ManagerDeInit.vi DATE: PAGE: 9/14

10 3.2 Functions Description In this sub-section we only pretend to give you an insight on how to use the most fundamental functions to manage Nan Eye API resources. To get a deeper understanding of this API we recommend you to read the Awaiba NanEye API Manager Init This Function is responsible starting the singleton instance of the type Manager Set Source Function that creates an instance of the source type Start Start function initializes the frame buffer and loads the FPGA bit file on the camera usb base station system. DATE: PAGE: 10/14

11 3.2.4 Get Next Frame This Function pulls frame data out from the buffer. Retrieving the frame data should be implemented within a loop. Having a Wait Until Next ms Multiple Function is highly recommendable. The correct initialization of the Pixel array and rawpixels array is essential. So having by default the 248 x 248 resolution these variables have to accommodate for all pixels data. Therefore they should be initialized in the following manner : Figure 4: Pixel buffer data initialization Pipe Config Function that affects most of the image software processing routines. In order to obtain RGB data this instance must be invoked and configured. Append Array comprehends a set of 6 boolean arguments to configure the image processing, the one that enables the output of RGB pixel data is DeMosaic. Skipping Threshold, if the frame skipping is enabled on the Append Array the frame buffer drops the new coming frames if the stored frame number exceeds threshold is limit value. Bad Pixel replacement Threshold, if enabled, single pixels surrounded by other ones with largely different values are replaced by the median value of the neighbouring pixels. Pixel Adjust is a 4 element array that allows to change the gain of each colour channel (red, green and blue); DATE: PAGE: 11/14

12 The Color Matrix is a 3x3 matrix The sum of each line should always be 1.This is used to adjust the colors: To saturate the red, the first row should be changed, increasing the first value and decreasing the other two: Changing the matrix values from: to ; This is analogue to the other colour channels: Green channel Second Row; Blue channel Third Row. The Brightness parameter is final scaler to the out going RGB data. Default value is 1.00 It will not change the pixel value.the values can be chosen between 0.5 and Config Sensor This function configures a basic set of parameters on the camera hardware. Gain: Can have values between 0 and 3; 0 is the darkest and 3 is the brightest level; Offset: Can have values between 0 and 3; 0 is the darkest and 3 is the brightest level; Exposure: Can have values between 1 and 250; 1 is the brightest level and 250 is the darkest; The Digipot allows to receive more, or less frames per second, between 45 fps, at the lowest digipot, and 60 fps, when the digipot is at its max Stop DATE: PAGE: 12/14

13 This function is responsible for closing the frame buffer and other related instances Manager De Init This function closes the Manager instance Get Error Text This function interprets all error codes Error Index, and outputs a string with the error description Get Version A basic function that returns the camera firmware version. Important on the debugging process to assure the communication with USB station, doesn't need no other instance to be called. DATE: PAGE: 13/14

14 Get Frame Dimensions This function gets the frame dimensions, by default the systems works with 248 (width) x 248 (Height ) configuration. DATE: PAGE: 14/14