mediumlinergb24 for microenable iv vd4-cl/-pocl ... · pdf filemicroenable iv vd4-cl/-pocl...

AcquisitionApplets AdvancedUser Documentation

MediumLineRGB24for microEnable IV VD4-CL/-PoCL

AcquisitionApplets AdvancedUser Documentation

MediumLineRGB24for microEnable IV VD4-CL/-PoCL

Applet Characteristics

Applet Name MediumLineRGB24

Applet Version 2.4.2.2

Type of Applet AcquisitionApplets Advanced

Frame Grabber microEnable IV VD4-CL/-PoCL

No. of Cameras 1

Camera Interface Camera Link MEDIUM Configuration

Sensor Type Line Scan

Color RGB

Processing Bit Depth 8 Bit per Color Component

Supplemental Information

1. Runtime Software documentation: Online at www.siliconsoftware.de/rt5.html or in your runtimesoftware installation [InstDir]/doc2. Applet release notes: Refer to the Runtime Software Documentation, section Image Acquisition. Youfind the release notes in the hardware-specific applet information.3. Software updates you find at www.silicon-software.info/en/downloads.html (English) and www.silicon-software.info/de/downloads.html (German)4. Silicon Software Support department: [email protected], phone: +49 621 789 50 70

Silicon Software Headquarters: Steubenstrasse 46 - D-68163 Mannheim - GermanyTel. +49 (0)621 - 789 50 70, Email: [email protected]

Copyright © 2016 Silicon Software GmbH

All rights reserved. All trademarks and registered trademarks are the property of their respective owners. Any information without obligation. Technicalspecifications and scope of delivery are liability-free and valid until revocation. Changes and errors are excepted.

http://www.siliconsoftware.de/rt5.html

http://www.silicon-software.info/en/downloads.html

http://www.silicon-software.info/de/downloads.html

http://www.silicon-software.info/de/downloads.html

microEnable IV VD4-CL/-PoCL MediumLineRGB24 v2.4.2.2 iii

Table of Contents1. Introduction ...................................................................................................................................... 1

1.1. Features of Applet MediumLineRGB24 ................................................................................... 11.1.1. Parameterization Order ............................................................................................... 2

1.2. Bandwidth ............................................................................................................................. 21.3. Requirements ........................................................................................................................ 3

1.3.1. Software Requirements ............................................................................................... 31.3.2. Hardware Requirements ............................................................................................. 41.3.3. License ....................................................................................................................... 4

1.4. Camera Interface .................................................................................................................. 41.5. Image Transfer to PC Memory .............................................................................................. 4

2. Software Interface ........................................................................................................................... 53. Events ............................................................................................................................................. 64. Camera Link .................................................................................................................................... 7

4.1. FG_CAMERA_LINK_CAMTYPE ............................................................................................... 74.2. FG_USEDVAL ........................................................................................................................ 7

5. ROI .................................................................................................................................................. 95.1. FG_WIDTH ........................................................................................................................... 105.2. FG_HEIGHT ......................................................................................................................... 105.3. FG_XOFFSET ....................................................................................................................... 115.4. FG_YOFFSET ....................................................................................................................... 11

6. Sensor Correction .......................................................................................................................... 136.1. FG_SENSORREADOUT ......................................................................................................... 156.2. FG_SC_SUBSENSORCOUNT ............................................................................................... 156.3. FG_SC_SENSORLENGTH .................................................................................................... 166.4. FG_SC_TAPCOUNT ............................................................................................................. 166.5. FG_SC_ROTATEDSENSOR ................................................................................................... 176.6. FG_SC_READOUTDIRECTION .............................................................................................. 176.7. FG_SC_PIXELORDER ........................................................................................................... 186.8. FG_SC_UPDATESCHEME .................................................................................................... 18

7. CC Signal Mapping ........................................................................................................................ 207.1. FG_CCSEL0 ......................................................................................................................... 207.2. FG_CCSEL1 .......................................................................................................................... 217.3. FG_CCSEL2 ......................................................................................................................... 227.4. FG_CCSEL3 ........................................................................................................................ 22

8. Line Trigger / ExSync .................................................................................................................... 248.1. FG_LINETRIGGERMODE ...................................................................................................... 248.2. FG_EXSYNCON ................................................................................................................... 258.3. Line Trigger Input ............................................................................................................... 26

8.3.1. FG_LINETRIGGERINSRC ........................................................................................... 278.3.2. FG_LINETRIGGERINPOLARITY ................................................................................. 288.3.3. FG_LINETRIGGERDEBOUNCING .............................................................................. 298.3.4. Downscale ............................................................................................................... 29

8.3.4.1. FG_LINE_DOWNSCALE .................................................................................. 298.3.4.2. FG_LINE_DOWNSCALEINIT ........................................................................... 30

8.4. Shaft Encoder A/B Filter ..................................................................................................... 318.4.1. FG_SHAFTENCODERON ........................................................................................... 318.4.2. FG_SHAFTENCODERMODE ...................................................................................... 318.4.3. FG_SHAFTENCODERINSRC ..................................................................................... 328.4.4. FG_SHAFTENCODERLEADING ................................................................................. 33

8.5. ExSync Output .................................................................................................................... 348.5.1. FG_LINEPERIODE ..................................................................................................... 348.5.2. FG_LINEEXPOSURE ................................................................................................. 358.5.3. FG_EXSYNCPOLARITY ............................................................................................. 368.5.4. FG_LINETRIGGERDELAY .......................................................................................... 36

9. Image Trigger / Flash .................................................................................................................... 389.1. FG_IMGTRIGGERMODE ....................................................................................................... 39

Table of Contents

microEnable IV VD4-CL/-PoCL MediumLineRGB24 v2.4.2.2 iv

9.2. FG_IMGTRIGGERON ........................................................................................................... 399.3. FG_FLASHON ..................................................................................................................... 409.4. FG_IMGTRIGGER_ASYNC_HEIGHT ..................................................................................... 409.5. FG_IMGTRIGGER_IS_BUSY .................................................................................................. 419.6. Flash ................................................................................................................................... 41

9.6.1. FG_FLASH_POLARITY .............................................................................................. 429.7. Image Trigger Input ............................................................................................................ 42

9.7.1. FG_IMGTRIGGERINSRC ............................................................................................ 429.7.2. FG_IMGTRIGGERINPOLARITY .................................................................................. 439.7.3. FG_IMGTRIGGERGATEDELAY .................................................................................. 449.7.4. FG_IMGTRIGGERDEBOUNCING ............................................................................... 449.7.5. FG_STROBEPULSEDELAY ........................................................................................ 459.7.6. Software Trigger ...................................................................................................... 45

9.7.6.1. FG_SENDSOFTWARETRIGGER ...................................................................... 459.7.6.2. FG_SETSOFTWARETRIGGER ......................................................................... 46

10. Digital I/O .................................................................................................................................... 4710.1. FG_DIGIO_OUTPUT ............................................................................................................ 4710.2. FG_DIGIO_INPUT ............................................................................................................... 4710.3. Events ............................................................................................................................... 48

10.3.1. FG_TRIGGER_INPUT0_RISING et al. ....................................................................... 4810.3.2. FG_TRIGGER_INPUT0_FALLING et al. .................................................................... 48

11. Overflow ....................................................................................................................................... 5011.1. FG_FILLLEVEL .................................................................................................................... 5011.2. FG_OVERFLOW .................................................................................................................. 5111.3. Events ................................................................................................................................ 51

11.3.1. FG_OVERFLOW_CAM0 ............................................................................................. 5112. Image Selector ............................................................................................................................. 54

12.1. FG_IMG_SELECT_PERIOD .................................................................................................. 5512.2. FG_IMG_SELECT ............................................................................................................... 55

13. White Balance .............................................................................................................................. 5713.1. FG_SCALINGFACTOR_RED ................................................................................................ 5713.2. FG_SCALINGFACTOR_BLUE .............................................................................................. 5713.3. FG_SCALINGFACTOR_GREEN ........................................................................................... 58

14. Lookup Table ............................................................................................................................... 5914.1. FG_LUT_TYPE .................................................................................................................... 5914.2. FG_LUT_VALUE_RED ........................................................................................................ 6014.3. FG_LUT_VALUE_GREEN .................................................................................................... 6014.4. FG_LUT_VALUE_BLUE ....................................................................................................... 6114.5. FG_LUT_CUSTOM_FILE ..................................................................................................... 6114.6. FG_LUT_SAVE_FILE .......................................................................................................... 6314.7. Applet Properties .............................................................................................................. 63

14.7.1. FG_LUT_IMPLEMENTATION_TYPE .......................................................................... 6314.7.2. FG_LUT_IN_BITS .................................................................................................... 6414.7.3. FG_LUT_OUT_BITS ................................................................................................. 64

15. Processing ................................................................................................................................... 6615.1. FG_PROCESSING_OFFSET ................................................................................................. 6715.2. FG_PROCESSING_GAIN ..................................................................................................... 6715.3. FG_PROCESSING_GAMMA ................................................................................................ 6815.4. FG_PROCESSING_INVERT ................................................................................................ 69

16. Output Format .............................................................................................................................. 7116.1. FG_FORMAT ....................................................................................................................... 7116.2. FG_BITALIGNMENT ........................................................................................................... 7116.3. FG_PIXELDEPTH ............................................................................................................... 72

17. Camera Simulator ........................................................................................................................ 7317.1. FG_GEN_ENABLE ............................................................................................................... 7317.2. FG_GEN_START ................................................................................................................. 7417.3. FG_GEN_WIDTH ................................................................................................................ 7417.4. FG_GEN_HEIGHT ............................................................................................................... 75

Table of Contents

microEnable IV VD4-CL/-PoCL MediumLineRGB24 v2.4.2.2 v

17.5. FG_GEN_LINE_GAP ............................................................................................................ 7517.6. FG_GEN_FREQ ................................................................................................................... 7617.7. FG_GEN_ACCURACY ......................................................................................................... 7617.8. FG_GEN_TAP1 et al. ........................................................................................................... 7717.9. FG_GEN_ROLL ................................................................................................................... 7817.10. FG_GEN_ACTIVE .............................................................................................................. 7817.11. FG_GEN_PASSIVE ............................................................................................................ 7817.12. FG_GEN_LINE_WIDTH ...................................................................................................... 79

18. Miscellaneous .............................................................................................................................. 8018.1. FG_TIMEOUT ..................................................................................................................... 8018.2. FG_TURBO_DMA_MODE ................................................................................................... 8018.3. FG_APPLET_VERSION ....................................................................................................... 8118.4. FG_APPLET_REVISION ...................................................................................................... 8118.5. FG_APPLET_ID .................................................................................................................. 8218.6. FG_HAP_FILE .................................................................................................................... 8218.7. FG_DMASTATUS ............................................................................................................... 8318.8. FG_CAMSTATUS ............................................................................................................... 8318.9. FG_CAMSTATUS_EXTENDED ............................................................................................ 83

Glossary ............................................................................................................................................ 85Index .................................................................................................................................................. 87

microEnable IV VD4-CL/-PoCL MediumLineRGB24 v2.4.2.2 1

Chapter 1. IntroductionThis document provides detailed information on the Silicon Software AcquisitionApplets Advanced"MediumLineRGB24" for microEnable IV VD4-CL/-PoCL frame grabbers.

This document will outline the features and benefits of this AcquisitionApplets Advanced. Furthermore,the output formats and the software interface is explained. The main part of this document includesthe detailed description of all applet modules and their parameters which make the AcquisitionAppletsAdvanced adaptable for numerous applications.

1.1. Features of Applet MediumLineRGB24

Figure 1.1. Block Diagram of AcquisitionApplets Advanced MediumLineRGB24

The AcquisitionApplets Advanced "MediumLineRGB24" is a single camera applet. The Camera Linkcamera interface can be configured for Camera Link cameras in Medium-Configuration mode transferringRGB pixels at a bit depth of 24 bits. A multi-functional line trigger is included to control the cameraor external devices using grabber generated, external or software generated trigger pulses. Line scancameras up to a width of 16384 pixels can be processed. The trigger system will generate images of amaximum height of 65535 pixels. The applet is processing data at a bit depth of 8 bits. An image selectorat the camera port facilitates the selection of one image out of a parameterizable sequence of images. Thisenables the distribution of the images to multiple frame grabbers and PCs. The applet includes a sensorcorrection which sorts the taps of subsensors. Acquired images are buffered in frame grabber memory.A region of interest (ROI) can be selected for further processing. The stepsize of the ROI width is 4 pixeland the ROI stepsize for the image height is 1 line. A white balancing module for individual gain of eachcolor component enhances image quality. The 8 bit full resolution lookup table can either be configured byusing a user defined table or by using a processor. The processor gives the opportunity to use pre-definedfunctions such as offset, gain, invert to enhance the image quality. The color components are processedindividually. A gamma correction is possible.

Processed image data are output via a high speed DMA channel. The output pixel format is 24 bits perpixel in BGR color component order.

The applet can easily be included into user applications using the Silicon Software runtime.

Introduction


Table 1.1. Feature Summary of MediumLineRGB24

Feature Applet Property

Applet Name

MediumLineRGB24

Type of Applet AcquisitionApplets Advanced

Board microEnable IV VD4-CL/-PoCL

No. of Cameras 1

Camera Type Camera Link Medium Configuration (24 Bit RGBonly)

Sensor Type Line Scan

Camera Format RGB

Processing Bit Depth 8 Bit per color component

Sensor Correction / Tap Sorting yes

Maximum Images Dimensions 16384 * 65535

ROI Stepsize x: 4, y: 1

Mirroring no

Image Selector Yes

Noise Filter No

Shading Correction No

Dead Pixel Interpolation No

Bayer Filter No

Color White Balancing Yes

Lookup Table Full Resolution

DMA High Speed (DMA900)

DMA Image Output Format BGR 24 bit

Event Generation yes

Overflow Control yes

1.1.1. Parameterization Order

It is recommended to configure the functional blocks which are responsible for sensor setup/correctionfirst. This will be the camera settings, shading correction and dead pixel interpolation, if available.Afterwards, other image enhancement functional blocks can be configured, such as the white balancing,noise filter and lookup table. By default all presets are configured in order to directly receive images.

1.2. Bandwidth

The maximum bandwidths of applet MediumLineRGB24 are listed in the following table.

Introduction


Table 1.2. Bandwidth of MediumLineRGB24

Description Bandwidth

Max. CamClk 85 MHz

Peak Bandwidth per Camera 170 MPixel/s

Mean Bandwidth per Camera 170 MPixel/s

DMA Bandwidth 872 MByte/s (depends on PC mainboard)

Max. CamClk refers to the maximum pixel clock frequency used by the the Camera Link camera. You canuse any lower pixel clock frequency. Lower pixel clock frequencies enable longer CameraLink cables.

The peak bandwidth defines the maximum allowed bandwidth for each camera at the camera interface.When transferring data from the camera to the frame grabber at this bandwidth, the buffer on the framegrabber will fill up as the data can be buffered, but not being processed at that speed. The peak bandwidthis related to the Camera Link interface mode and pixel clock frequency. The product of the used CameraLink taps and the pixel frequency must not exceed the peak bandwidth.

The mean bandwidth per camera describes the maximum allowed mean bandwidth for each camera atthe camera interface. It is the product of the framerate and the image pixels. For example, a 1 Megapixelimage at a framerate of 100 frames per second, the mean bandwidth will be 100 MPixel/s. In case of 8bitper pixel as output format this would be equal to 100 MB per second.

The required output bandwidth of an applet can differ from the input bandwidth. A region of interest (ROI)and the output format can change the required output bandwidth and the maximum mean bandwidth.

Regard the relation between MPixel/s and MByte/s. The MByte/s depends on the applet and itsparameterization concerning the pixel format. It is possible to acquire more than 8 bit per pixel or convertfrom one bit depth to another. 1 MByte is 1,000,000 Byte.

Bandwidth Varies

The exact maximum DMA bandwidth depends on the used PC system and its chipset. Thecamera bandwidth depends on the image size and the selected frame rate. The given valuesof 872 MByte/s for the possible DMA bandwidth might be lower due to the chipset and itsconfiguration. Additionally some PCIe slots do not support the required number of lanes totransfer the requested or expected bandwidth. In these cases have a look at the mainboardspecification. A behaviour like multiplexing between several PCIe slots can be seen in rarecases. Some mainboard manufacturers provide a BIOS feature where you can select the PCIepayload size: Always try to set this to its maximum value or simply automatic. This can helpin specific cases.

1.3. Requirements

In the following, the requirements on software, hardware and frame grabber license are listed.

1.3.1. Software Requirements

To run this AcquisitionApplets Advanced implementation, a Silicon Software runtime installation isrequired. Ensure to use the applet with compatible runtimes only. You should also take care to usethe board firmware and drivers included in the runtime. This applet is included in a runtime installationpackage. Only use the applet in this runtime. For newer runtime versions, check if a newer applet revisionis available.

For integration in 3rd party applications check Chapter 2, 'Software Interface'.

Introduction


1.3.2. Hardware Requirements

To run AcquisitionApplets Advanced "MediumLineRGB24" a Silicon Software microEnable IV VD4-CL/-PoCL frame grabber is required.

For PC system requirements check the frame grabber hardware documentation. The applet itself doesnot require any additional PC system requirements.

1.3.3. License

This applet is of type AcquisitionApplets Advanced. For these types of applets, no license is required. Allcompatible frame grabbers can run the applet using the runtime software.

1.4. Camera Interface

AcquisitionApplets Advanced "MediumLineRGB24" supports one Camera Link camera in mediumconfiguration mode. The frame grabber has two Camera Link connectors. Connect the camera to port 'A'with its base connector and to port 'B' with its medium connector.

Figure 1.2. Camera Interface and Camera Cable Setup

RAM

RAMFPGA

PoCL orCamera LinkMEDIUM ConfigFULL Config

Port A

Port B

Cable BASE

Cable MEDIUM/FULL

1.5. Image Transfer to PC Memory

Image transfer between the frame grabber and the PC is performed by DMA transfers. In this applet, onlyone DMA channel exists to transfer the image data. The DMA channel has index 0. The applet outputformat can be set with the parameters of the output format module. See Chapter 16, 'Output Format'. Alloutputs are little endian coded.

DMA Image Tag

The applet does not generate a valid DMA image tag (FG_IMAGE_TAG). Check for lost orcorrupted frames using the overflow module described in Chapter 11, 'Overflow'.


Chapter 2. Software InterfaceThe software interface is fully compatible to the Silicon Software runtime. Please read the SDK manualof the Silicon Software runtime software to understand how to include the microEnable frame grabbersand their applets into own applications.

The runtime includes functional SDK examples which use the features of the runtime. Most of theseexamples can be used with this AcquisitionApplets Advanced. These examples are very useful to learn onhow to acquire images, set parameters and use events.

This document is focused on the explanation of the functionality and parameterization of the applet. Thenext chapters will list all parameters of this applet. Keep in mind that for multi-camera applets, parameterscan be set for all cameras individually. The sample source codes parameterize the processing componentsof the first camera. The index in the source code examples has to be changed for the other cameras.

Amongst others, parameters of the applet are set and read using functions

• int Fg_setParameter(Fg_Struct *Fg, const int Parameter, const void *Value, const unsigned int index)

• int Fg_setParameterWithType(Fg_Struct *Fg, const int Parameter, const void *Value, const unsignedint index, const enum FgParamTypes type)

• int Fg_getParameter(Fg_Struct *Fg, int Parameter, void *Value, const unsigned int index)

• int Fg_getParameterWithType(Fg_Struct *Fg, const int Parameter, void *Value, const unsigned intindex, const enum FgParamTypes type)

The index is used to address a DMA channel, a camera index or a processing logic index. It isimportant to understand the relations between cameras, processes, parameters and DMA channels.This AcquisitionApplets Advanced is a single camera applet and is using only one DMA channel. Allparameterizations are made using index 0 only.

For applets having multiple DMA channels for each camera, the relation between the indices is morecomplex. Please check the respective documentation of these applets for more details.


Chapter 3. EventsFor this applet several events are generated respectively callback functions can be registered for those.For a general explanation on this see Event.

Besides the events listed here additional ones can be found in the rest of the document.

Table 3.1. Available events of MediumLineRGB24

Event Name Description

CamPortATransferStart Is fired for a starting frame on CameraLink Port A.

CamPortATransferStart Is fired for a end of frame on CameraLink Port A.

CamPortBTransferStart Is fired for a starting frame on CameraLink Port B.

CamPortBTransferStart Is fired for a end of frame on CameraLink Port B.

FG_... events Can be found in the rest of this document.

For additional events regarding other functionality please use the document index.


Chapter 4. Camera LinkThis AcquisitionApplets Advanced can be used with one line scan camera in Camera Link To receivecorrect image data from your camera, it is crucial that the camera output format matches the selectedframe grabber input format. The following parameters configure the grabber's camera interface to matchwith the individual camera properties. Most cameras support different operation modes. Please, consultthe manual of your camera to obtain the necessary information, how to configure the camera to thedesired data format.

Ensure that the lines transferred by the camera do not exceed the maximum allowed line length for thisapplet (16384).

4.1. FG_CAMERA_LINK_CAMTYPE

This parameter specifies the data format of the connected camera.

This camera interface can be configured to support the different data formats specified by the CameraLink standard. In this AcquisitionApplets Advanced,the processing data bit depth is 8 bit. The camerainterface automatically performs a conversion to the 8 bit format using bit shifting independently fromthe selected camera format. If the Camera Link bit depth is greater than the processing bit depth, bits willbe right shifted to meet the internal bit depth. If the Camera Link bit depth is less than the processing bitdepth, bits will be left shifted to meet the internal bit depth. In this case, the lower bits are fixed to zero.

Table 4.1. Parameter properties of FG_CAMERA_LINK_CAMTYPE

Property Value

Name FG_CAMERA_LINK_CAMTYPEType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_CL_MEDIUM_RGB_24 24bit RGB Medium

Default value FG_CL_MEDIUM_RGB_24

Example 4.1. Usage of FG_CAMERA_LINK_CAMTYPE

int result = 0;unsigned int value = FG_CL_MEDIUM_RGB_24;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_CAMERA_LINK_CAMTYPE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_CAMERA_LINK_CAMTYPE, &value, 0, type)) < 0) { /* error handling */}

4.2. FG_USEDVAL

With this parameter it is possible to support cameras that do not fully comply with the Camera Linkspecification. If FG_YES is selected, DVAL, LVAL and FVAL is used to decode valid pixels. If the parameteris set to FG_NO, only LVAL and FVAL is used to decode valid pixels. If you are not sure about the requiredsetting, keep the parameter's value at FG_YES.

Camera Link


Table 4.2. Parameter properties of FG_USEDVAL

Property Value

Name FG_USEDVALType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_YES Yes

FG_NO No

Default value FG_YES

Example 4.2. Usage of FG_USEDVAL

int result = 0;unsigned int value = FG_YES;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_USEDVAL, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_USEDVAL, &value, 0, type)) < 0) { /* error handling */}


Chapter 5. ROIThis module allows the definition of a region of interest (ROI), also called area of interest (AOI). A ROIallows the selection of a smaller subset pixel area from the input image. It is defined by using parametersFG_XOFFSET, FG_WIDTH, FG_YOFFSET and FG_HEIGHT. The following figure illustrates the parameters.

Figure 5.1. Region of Interest

As can be seen, the region of interest lies within the input image dimensions. Thus, if the image dimensionprovided by the camera is greater or equal to the specified ROI parameters, the applet will fully cut-outthe ROI subset pixel area. However, if the image provided by the camera is smaller than the specified ROI,lines will be filled with random pixel content and the image height might be cut or filled with random imagelines as illustrated in the following.

Figure 5.2. Region of Interest Selection Outside the Input Image Dimensions

Furthermore, mind that the image sent by the camera must not exceed the maximum allowed imagedimensions. This applet allows a maximum image width of 16384 pixels and a maximum image height of65535 lines. The chosen ROI settings can have a direct influence on the maximum bandwidth of the appletas they define the image size and thus, define the amount of data.

The parameters have dynamic value ranges. For example an x-offset cannot be set if the sum of the offsetand the image width will exceed the maximum image width. To set a high x-offset, the image width hasto be reduced, first. Hence, the order of setting the parameters for this module is important. The returnvalues of the function calls in the SDK should always be evaluated to check if changes were accepted.

ROI


Mind the minimum step size of the parameters. This applet has a minimum step size of 4 pixel for thewidth and the x-offset, while the step size for the height and the y-offset is 1.

The settings made in this module will define the display size and buffer size if the applet is used inmicroDisplay. If you use the applet in your own programs, ensure to define a sufficient buffer size for theDMA transfers in your PC memory.

All ROI parameters can only be changed if the acquisition is not started i.e. stopped.

Camera ROI

Most cameras allow the setting of a ROI inside the camera. The ROI settings described in thissection are independent from the camera settings.

Influence on Bandwidth

A ROI might cause a strong reduction of the required bandwidth. If possible, the camera framedimension should be reduced directly in the camera to the desired size instead of reducingthe size in the applet. This will reduce the required bandwidth between the camera and theframe grabber.

5.1. FG_WIDTH

The parameter specifies the width of the ROI. The values of parameters FG_WIDTH + FG_XOFFSET mustnot exceed the maximum image width of 16384 pixels.

Table 5.1. Parameter properties of FG_WIDTH

Property Value

Name FG_WIDTHType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 8

Maximum 16384Stepsize 4

Default value 1024Unit of measure pixel

Example 5.1. Usage of FG_WIDTH

int result = 0;unsigned int value = 1024;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_WIDTH, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_WIDTH, &value, 0, type)) < 0) { /* error handling */}

5.2. FG_HEIGHT

The parameter specifies the height of the ROI. The values of parameters FG_HEIGHT + FG_YOFFSET mustnot exceed the maximum image height of 65535 pixels.

ROI


Table 5.2. Parameter properties of FG_HEIGHT

Property Value

Name FG_HEIGHTType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 8



Example 5.2. Usage of FG_HEIGHT


if ((result = Fg_setParameterWithType(FG_HEIGHT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_HEIGHT, &value, 0, type)) < 0) { /* error handling */}

5.3. FG_XOFFSET

The x-offset is defined by this parameter.

Table 5.3. Parameter properties of FG_XOFFSET

Property Value

Name FG_XOFFSETType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 0



Example 5.3. Usage of FG_XOFFSET


if ((result = Fg_setParameterWithType(FG_XOFFSET, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_XOFFSET, &value, 0, type)) < 0) { /* error handling */}

5.4. FG_YOFFSET

ROI


The y-offset is defined by this parameter.

Table 5.4. Parameter properties of FG_YOFFSET

Property Value

Name FG_YOFFSETType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 0



Example 5.4. Usage of FG_YOFFSET


if ((result = Fg_setParameterWithType(FG_YOFFSET, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_YOFFSET, &value, 0, type)) < 0) { /* error handling */}


Chapter 6. Sensor CorrectionMost camera sensors are read out sequentially in the so called raster scan format (line by line from top-left to bottom-right). However, to speed up the data transfer, some sensors can be configured to read outseveral pixels in parallel. As a result, succeeding pixels which are transferred via the Camera Link cableare not necessarily neighboring pixels. The sensor readout correction can re-order the pixels on board ofthe frame grabber and transform the grabbed image in the usual raster-scan fashion. All common readoutstrategies are supported to save computational power of the host system.

The sensor correction module in this AcquisitionApplets Advanced is configured by a set ofparameters to perform the desired correction. Namely, the parameters are FG_SC_SENSORLENGTH,FG_SC_SUBSENSORCOUNT, FG_SC_TAPCOUNT, FG_SC_ROTATEDSENSOR, FG_SC_READOUTDIRECTIONand FG_SC_PIXELORDER.

Use preset parameter FG_SENSORREADOUT

Instead of using the parameters described above, one of the presets defined byFG_SENSORREADOUT can be used.

• FG_SC_SENSORLENGTH:

This parameter has to be set to the actual sensor length of the camera without any ROI or offsetconsiderations defined in the applet. In the current version of this AcquisitionApplets Advanced, thisparameter has no influence on the functionality and is included for compatibility reasons for futurereleases only.

• FG_SC_SUBSENSORCOUNT:

The sensor of the camera is assumed to be divided into several subsensors. The number of thesesubsensors is set by this parameter. For this AcquisitionApplets Advanced this can either be 1 or 2subsensors.

• FG_SC_TAPCOUNT:

The number of taps, the camera uses to transfer the pixels is defined by this parameter. For thisAcquisitionApplets Advanced this can either be 1 or 2 subsensors.

These taps are not related to the taps known from Camera Link transfers but the numer is equal in manycases.

• FG_SC_ROTATEDSENSOR:

It is assumed that the subsensors of the camera will be read in a linear fashion e.g. first subsensor 0,next subsensor 1, next subsensor 2 and finally subsensor 3. It is not possible to read subsensors in ashuffled order such as 0, 2, 1, 3 for example. For some cameras, the sensor is read out in rotated orderi.e. 3, 2, 1, 0. This can be defined by this parameter.

• FG_SC_READOUTDIRECTION:

The read out direction defines the order to read out pixels out of a subsensor i.e. in forward = 0 orbackward = 1 direction. This is a field parameter, where a value can be set for every subsensor.

• FG_SC_PIXELORDER:

The pixel order defines the read out order of a pixel in a subsensor. This parameter only has effect ifmore than one tap is used to transfer the pixels of a subsensor. This is a field parameter, where a valuecan be set for every subsensor.

The following image will illustrate the functionality of the sensor correction parameters. In this example,the camera sensor has 4 subsensors and transfers data via Camera Link using 8 taps. As can be seen fromthe figure, the subsensors are read in linear order and start with subsensor 0 i.e. the whole sensor is not

Sensor Correction


rotated. Subsensors 0 and 1 are read in forward direction and are not mirrored. However, subsensors 2and 3 are read in backward direction. Furthermore, the pixel order is mirrored as subsensor 2 transfersthe first i.e. even numbered pixels via tap "F' and the second i.e. odd numbered pixels via tap "E".

Note that the figure is an example only. This applet might have other configuration options.

Figure 6.1. Illustration of Sensor Correction Parameters and Functionality. Example only. This applet might differ.

Please consult the user manual of the camera manufacturer to get information about the camera specificsensor read out.

The current implementation of this AcquisitionApplets Advanced does not allow any permutation of theparameters described above. The following table lists all allowed combinations.

FG_SC_SUBSENSORCOUNT

no. of subsensors

FG_SC_TAPCOUNT

no. of taps

FG_SC_ROTATEDSENSOR

rotated sensor

FG_SC_READOUTDIRECTION

readout direction

FG_SC_PIXELORDER

pixel order

old SC notation

1 1 no forward don't care |-> |

1 1 false backward don't care | <-|

1 1 true forward don't care | <-|

2 2 false forward, forward don't care, don't care |1> 2> |

2 2 true forward, forward don't care, don't care | <2 <1|

2 2 false forward, backward don't care, don't care |1> <2|

After all settings have been made, the configuration is enabled by writing to parameterFG_SC_UPDATESCHEME. If the parameter settings are not correct or if they do not match with one of thesensor correction modes described in the tables, writing to this parameter will return an error code.

Sensor Correction


6.1. FG_SENSORREADOUT

Select one of the presets to configure the sensor correction. The selected preset will directly overwritethe other parameters which define the sensor correction. Writing to parameter FG_SC_UPDATESCHEMEit not required when a preset is used.

Table 6.1. Parameter properties of FG_SENSORREADOUT

Property Value

Name FG_SENSORREADOUTType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values SMODE_UNCHANGED SMODE_UNCHANGED|-> |

SMODE_REVERSE SMODE_REVERSE | <-|SMODE_TAB2_0 SMODE_TAB2_0 |1> 2> |SMODE_TAB2_1 SMODE_TAB2_1 | <2 <1|SMODE_TAB2_2 SMODE_TAB2_2 |1> <2|

Default value SMODE_UNCHANGED

Example 6.1. Usage of FG_SENSORREADOUT

int result = 0;unsigned int value = SMODE_UNCHANGED;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SENSORREADOUT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SENSORREADOUT, &value, 0, type)) < 0) { /* error handling */}

6.2. FG_SC_SUBSENSORCOUNT

Specify the number of subsensors by use of this parameter. Don't forget to update any modifications tothe applet using parameter FG_SC_UPDATESCHEME.

Table 6.2. Parameter properties of FG_SC_SUBSENSORCOUNT

Property Value

Name FG_SC_SUBSENSORCOUNTType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 1

Maximum 2Stepsize 1

Default value 1

Example 6.2. Usage of FG_SC_SUBSENSORCOUNT


Sensor Correction


if ((result = Fg_setParameterWithType(FG_SC_SUBSENSORCOUNT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SC_SUBSENSORCOUNT, &value, 0, type)) < 0) { /* error handling */}

6.3. FG_SC_SENSORLENGTH

This parameter is used for compatibility reasons and has no functionality in the current release of thisAcquisitionApplets Advanced. Future versions will have extended sensor correction functionalities usingthis parameter.

Table 6.3. Parameter properties of FG_SC_SENSORLENGTH

Property Value

Name FG_SC_SENSORLENGTHType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 8


Default value 1024

Example 6.3. Usage of FG_SC_SENSORLENGTH


if ((result = Fg_setParameterWithType(FG_SC_SENSORLENGTH, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SC_SENSORLENGTH, &value, 0, type)) < 0) { /* error handling */}

6.4. FG_SC_TAPCOUNT

The number of taps is defined by this parameter. Don't forget to update any modifications to the appletusing parameter FG_SC_UPDATESCHEME.

Table 6.4. Parameter properties of FG_SC_TAPCOUNT

Property Value

Name FG_SC_TAPCOUNTType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 1

Maximum 2Stepsize 1

Default value 1

Sensor Correction


Example 6.4. Usage of FG_SC_TAPCOUNT


if ((result = Fg_setParameterWithType(FG_SC_TAPCOUNT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SC_TAPCOUNT, &value, 0, type)) < 0) { /* error handling */}

6.5. FG_SC_ROTATEDSENSOR

Set this parameter to FG_TRUE if the camera has a rotated sensor. Don't forget to update anymodifications to the applet using parameter FG_SC_UPDATESCHEME.

Table 6.5. Parameter properties of FG_SC_ROTATEDSENSOR

Property Value

Name FG_SC_ROTATEDSENSORType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_FALSE False

FG_TRUE True

Default value FG_FALSE

Example 6.5. Usage of FG_SC_ROTATEDSENSOR

int result = 0;unsigned int value = FG_FALSE;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SC_ROTATEDSENSOR, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SC_ROTATEDSENSOR, &value, 0, type)) < 0) { /* error handling */}

6.6. FG_SC_READOUTDIRECTION

This field parameter is used to set the readout direction for each subsensor. Value 0 represents option"forward" and value 1 represents option "backward". Index 0 corresponds to subsensor 0. Index 1corresponds to subsensor 1 etc. Don't forget to update any modifications to the applet using parameterFG_SC_UPDATESCHEME.

Table 6.6. Parameter properties of FG_SC_READOUTDIRECTION

Property Value

Name FG_SC_READOUTDIRECTIONType Unsigned Integer FieldAccess policy Read/Write/ChangeStorage policy TransientDefault value 0

Sensor Correction


Example 6.6. Usage of FG_SC_READOUTDIRECTION

int result = 0;

FieldParameterInt access;const enum FgParamTypes type = FG_PARAM_TYPE_STRUCT_FIELDPARAMINT;

for (unsigned int i = 0; i < 2; ++i){ access.index = i; access.value = 0;

if ((result = Fg_setParameterWithType(FG_SC_READOUTDIRECTION, &access, 0, type)) < 0) { /* error handling */ }

if ((result = Fg_getParameterWithType(FG_SC_READOUTDIRECTION, &access, 0, type)) < 0) { /* error handling */ }}

6.7. FG_SC_PIXELORDER

The pixel order defines whether the camera's sub sensors are read in forward or in reverse direction.Set the parameter to 0 for forward direction and 1 for reverse direction. Don't forget to update anymodifications to the applet using parameter FG_SC_UPDATESCHEME.

Table 6.7. Parameter properties of FG_SC_PIXELORDER

Property Value

Name FG_SC_PIXELORDERType Unsigned Integer FieldAccess policy Read/Write/ChangeStorage policy TransientDefault value 0

Example 6.7. Usage of FG_SC_PIXELORDER

int result = 0;



if ((result = Fg_setParameterWithType(FG_SC_PIXELORDER, &access, 0, type)) < 0) { /* error handling */ }

if ((result = Fg_getParameterWithType(FG_SC_PIXELORDER, &access, 0, type)) < 0) { /* error handling */ }}

6.8. FG_SC_UPDATESCHEME

After the sensor correction has been configured using the parameters described above, the actualconfiguration can be enabled in the frame grabber. Use this parameter to start verification of the settingsmade and transfer to the grabber. The parameter may only be changed while no acquisition is started.

If the parameter settings are not correct or if they do not match with one of the sensor correction modesdescribed in the tables above, writing to this parameter will return an error code.

Sensor Correction


Table 6.8. Parameter properties of FG_SC_UPDATESCHEME

Property Value

Name FG_SC_UPDATESCHEMEType EnumerationAccess policy Read/Write/ChangeStorage policy TransientAllowed values FG_APPLY Apply

Default value FG_APPLY

Example 6.8. Usage of FG_SC_UPDATESCHEME

int result = 0;unsigned int value = FG_APPLY;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SC_UPDATESCHEME, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SC_UPDATESCHEME, &value, 0, type)) < 0) { /* error handling */}


Chapter 7. CC Signal MappingThe CameraLink interface specifies four camera input signals, i.e. CC1, CC2, CC3 and CC4. Usually thecamera will use one particular CC-signal to trigger the data acquisition and define the exposure time.Please consult the vendor's manual of your camera to identify the required signals and their mapping tothe CC1-CC4 signals.

This AcquisitionApplets Advanced provides eight different methods to map five source signals to any ofthe four CC-signal lines:

• CC_EXSYNC

The ExSync signal is used to trigger the line acquisition of the camera. It can be generated periodically,or triggered by one of the eight trigger input signals. When generated periodically by the frame grabber(grabber controlled), it determines the framerate. Depending on the operation mode of the camera, itsactive-time can determine the exposure time. For details refer to the trigger section of this document.

• CC_NOT_EXSYNC

The inverted signal to CC_EXSYNC.

• CC_EXSYNC2

A delayed copy of line trigger ExSync is provided by ExSync2

• CC_NOT_EXSYNC2

The inverted signal to ExSync2.

• CC_STROBEPULSE

A delayed copy of the image trigger is provided by the flash. It has as separate delay and is usually usedto control external flashes. For details refer to the Image Trigger System.

• CC_NOT_STROBEPULSE

The inverted signal to CC_STROBEPULSE.

• CC_GND

Ground, corresponding to a low state.

• CC_VCC

VCC, corresponding to a high state.

7.1. FG_CCSEL0

Select one of the options described above.

CC Signal Mapping


Table 7.1. Parameter properties of FG_CCSEL0

Property Value

Name FG_CCSEL0Type EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values CC_EXSYNC Exsync

CC_NOT_EXSYNC !ExsyncCC_EXSYNC2 Exsync2CC_NOT_EXSYNC2 !Exsync2CC_STROBEPULSE FlashCC_NOT_STROBEPULSE !FlashCC_GND GndCC_VCC Vcc

Default value CC_EXSYNC

Example 7.1. Usage of FG_CCSEL0

int result = 0;unsigned int value = CC_EXSYNC;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_CCSEL0, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_CCSEL0, &value, 0, type)) < 0) { /* error handling */}

7.2. FG_CCSEL1



Property Value



Default value CC_VCC


int result = 0;

CC Signal Mapping


unsigned int value = CC_VCC;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;



7.3. FG_CCSEL2



Property Value





int result = 0;unsigned int value = CC_VCC;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;



7.4. FG_CCSEL3


CC Signal Mapping



Property Value





int result = 0;unsigned int value = CC_VCC;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;




Chapter 8. Line Trigger / ExSyncThe line trigger function block uses signals to control the line scan acquisition of the specific camera. Aexternal synchronization signal or internal generated puls with fixed frequency being sent to the line scancamera is called ExSync. With the help of this signal it is possible to control the exposure of the connectedcamera.

The camera needs to be configured accordingly to use the ExSync as control signal. Furthermore thecamera might expect the ExSync at a particular CC signal and/or polarity.

In most cases for CameraLink the the exposure control is expected at CameraControl signal CC1.

An sensor exposure control based on pulse length/duration is very common. Please make sure that theexposure time is less than the period of the expected maximum line frequency. Consult the camera'smanual for more details because these are device specific. More details concerning ExSync can be foundin the parameter description of FG_EXSYNCON.

Basically two different generation modes for the ExSync signals are available,

• a simple periodical and

• an externally triggered generation.

Additionally, two variants of these are available,

• the first is independent from the image gate,

• and the second is gated by the image gate, which creates ExSync signals only during the actualacquisition.

All details can be found in the parameter description of FG_LINETRIGGERMODE.

For the mapping of the ExSync signals to the digital outputs check Chapter 10, 'Digital I/O'.

8.1. FG_LINETRIGGERMODE

Please choose one of the line trigger modes described here. Make sure that the operation modes of theframe grabber and the camera are the same.

Image independent ExSync modes:

• Grabber Controlled

For the grabber controlled line trigger, the ExSync signal is a simple periodical signal. Its period definesthe line frequency and its active time is used by many cameras to define the exposure time.

• External Trigger

The external trigger mode for ExSync generates a single ExSync pulse when the external trigger sourcebecomes active. The ExSync defines the exposure time for the camera. During the exposure time is notpossible to re-trigger the ExSync. If the camera needs an additional setup time, it is possible to extendthe deadtime of the trigger - the time where no re-trigger is possible - beyond the exposure time. Ifyou want to trigger fewer lines than pulses available at the trigger input, it is possible to downscale thetrigger input, e.g. a downscaler of 2 will generate an ExSync every 2nd input pulse, a downscaler of 3only every third of the input pulses, and so on.

Image gate dependent ExSync modes:

Line Trigger / ExSync


• Grabber Controlled Gated

For the grabber controlled gated line trigger, the ExSync signal is generated the very same way as forthe grabber controlled mode described above. However, the generator for the ExSync is starting therising image gate and stops with the image gate becoming inactive. This gives a smaller jitter for thetime from the start of the image gate and the generation of the first ExSync, especially for very longExSync periods.

• External Trigger Gated

For the external trigger gated controlled line trigger, the ExSync signal is generated the very same wayas for the external trigger mode described above. However, the generator for the ExSync is starting therising image gate and stops with the image gate becoming inactive. For this mode two downscalers areavailable. The first is the downscaler from the beginning of the image gate to the first ExSync, it is calledphase. The second is downscaling all succeeding input triggers and is the same as the downscaler usedin external trigger mode described above. The options downscale and phase allow further adjustment ofthe camera trigger with respect to its external source, the trigger input. The value downscale determinesthe divisor of the input frequency, e.g. a downscale of 16 will produce an ExSync every 16 * n of the inputtrigger. Furthermore, the phase gives the possibility to shift the camera trigger. A phase shift of 90°is achieved when setting phase to 4, which produces a camera trigger at times 16 * n + 4 of the inputtrigger signal.

Table 8.1. Parameter properties of FG_LINETRIGGERMODE

Property Value

Name FG_LINETRIGGERMODEType EnumerationAccess policy Read/WriteStorage policy PersistentAllowed values GRABBER_CONTROLLED Grabber controlled

ASYNC_TRIGGER Async External TriggerGRABBER_CONTROLLED_GATED Gated, Grabber controlledASYNC_GATED Gated, External Triggered

Default value GRABBER_CONTROLLED

Example 8.1. Usage of FG_LINETRIGGERMODE

int result = 0;unsigned int value = GRABBER_CONTROLLED;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_LINETRIGGERMODE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINETRIGGERMODE, &value, 0, type)) < 0) { /* error handling */}

8.2. FG_EXSYNCON

This parameter enables the transmission of ExSync signals to the camera.

Please take care to first start the acquisition before setting this ExSyncOn parameter to On (FG_ON) if youwant to acquire all lines being generated by the camera. The signal will be sent as soon as the ExSync hasbeen started. As soon as the acquisition is started the used timeout parameter becomes valid independentof the ExSyncOn parameter being On (FG_ON) or Off (FG_OFF). By switching this parameter On (FG_ON)and Off (FG_OFF) during an acquisition you can check if the camera is configured to use this external signalfor exposure start.



Whether the ExSync is really used by the camera is based on the settings of the camera. Consult thecamera's manual for more details because these are device specific.

Table 8.2. Parameter properties of FG_EXSYNCON

Property Value

Name FG_EXSYNCONType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_ON

Example 8.2. Usage of FG_EXSYNCON

int result = 0;unsigned int value = FG_ON;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_EXSYNCON, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_EXSYNCON, &value, 0, type)) < 0) { /* error handling */}

8.3. Line Trigger Input

In the line trigger input category of the line trigger module, the applet is configured for a possible externalline trigger input. Here, debouncing times, downscales, polarities and a shaft encoder input are configured.

The external peripheral line trigger source will be in most cases a shaft encoder, also called a rotaryencoder. These devices convert the objects movement over an angular motion into relative incrementalpulses. The angular motion is taken from the motor axis or a wheel being connected to the translationalmotion of the scanned object. For most line scan applications it is relevant to get exact feedback of therelative motion between camera and object. By this a certain number of incremental pulses per distanceis given to the frame grabber trigger input interface. Depending on the used incremental shaft encodersa certain number (500, 1000, ...) of incremental pulses per rotation is produced.

Most incremental shaft encoders provide 2 signals that are called A & B. By using these two signals therelative increments can be seen at the edges of these signals and a direction. In one direction the A-phasehigh state rises before the B-phase in the other direction, i.e. vice versa. If we do not need a direction forour application, only the A-phase is necessary. A combination of A & B may provide a higher resolution.Please see FG_SHAFTENCODERMODE and FG_SHAFTENCODERON for this.

Figure 8.1. Shaft Encoder, A & B phase, direction



During an acquisition the shaft encoder signals trigger the ExSync signals and force the sensor to performan exposure. After the sensor exposure the line is read-out and transfered. The time between exposureand transfer is for most line scan cameras very short.

Figure 8.2. Shaft Encoder, A & B signal, acquisition

The different phases are defined as seen in the following table. A positive phase increment is forwarddirection, a negative means reverse. This induces rising/falling edge A before B equals forward directionand rising/falling edge B before A means reverse.

Table 8.3. Phases of an A/B Shaft Encoder

Phase A-state B-state

1 low high

2 low low

3 high low

4 high high

Some shaft encoders provide a third signal that is pulsed for each full rotation which is called Z or index.This signal Z could become interesting for an image trigger mode. For more details see Chapter 9, 'ImageTrigger / Flash'.

For most applications and several camera or line scan sensor types it is necessary to have the sameresolution in X and Y direction of an image. Due to this the number of pixels per mm in sensor- and motion-direction needs to be the same. In case of an 1024 pixel line scan sensor looking at 10 cm we have 10.24pixel per mm orthogonal to the web direction. In order to reach an 1:1 scaling we need 10.24 ExSync signalsper mm. If a perfectly round object is scanned with an 1:1 scaling then it is exactly round in the image too.When the result becomes elliptic, the scaling is not perfect and some line scan sensor architectures (Bi/Tri-Linear, Dual-Line, ...) will show some additional artefacts.

8.3.1. FG_LINETRIGGERINSRC

This parameter specifies the digital signal source for phase A, which is used to trigger the ExSyncsignal. If an A/B shaft encoder is used, configure source B at FG_SHAFTENCODERINSRC, too. For moredetails please consider the runtime manual installed along the runtime or on our homepage at http://www.silicon-software.de.

It is possible to use the shaft encoder A phase only if the direction of scanning is not of interest in the targetapplication. Concerning more details to the shaft encoder please consider the introduction of Section 8.3,'Line Trigger Input'.



Table 8.4. Parameter properties of FG_LINETRIGGERINSRC

Property Value

Name FG_LINETRIGGERINSRCType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values TRGINSRC_0 Trigger Source 0

TRGINSRC_1 Trigger Source 1TRGINSRC_2 Trigger Source 2TRGINSRC_3 Trigger Source 3TRGINSRC_4 Trigger Source 4TRGINSRC_5 Trigger Source 5TRGINSRC_6 Trigger Source 6TRGINSRC_7 Trigger Source 7

Default value TRGINSRC_1

Example 8.3. Usage of FG_LINETRIGGERINSRC

int result = 0;unsigned int value = TRGINSRC_1;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_LINETRIGGERINSRC, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINETRIGGERINSRC, &value, 0, type)) < 0) { /* error handling */}

8.3.2. FG_LINETRIGGERINPOLARITY

The parameter defines the polarity of the external input trigger signal encoder source A and sourceB. When set to LowActive, the ExSync generator starts on a falling edge of the signal specified by theparameter FG_LINETRIGGERINSRC. Otherwise, the ExSync generation starts on a rising edge. This is onlyrelevant if the FG_LINETRIGGERMODE is set to an external trigger.

Table 8.5. Parameter properties of FG_LINETRIGGERINPOLARITY

Property Value

Name FG_LINETRIGGERINPOLARITYType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values HIGH_ON_ZERO_LOW Low Active

HIGH_ON_ZERO_HIGH High Active

Default value FG_ZERO

Example 8.4. Usage of FG_LINETRIGGERINPOLARITY

int result = 0;unsigned int value = FG_ZERO;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_LINETRIGGERINPOLARITY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINETRIGGERINPOLARITY, &value, 0, type)) < 0) { /* error handling */}



8.3.3. FG_LINETRIGGERDEBOUNCING

This parameter specifies the debouncing time. This is the time for which the input line trigger signals mustkeep the same value to be detected as such. Fast signal changes within the debouncing time will be filteredout.

Table 8.6. Parameter properties of FG_LINETRIGGERDEBOUNCING

Property Value

Name FG_LINETRIGGERDEBOUNCINGType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.016

Maximum 30.0Stepsize 0.016

Default value 0.112Unit of measure µs

Example 8.5. Usage of FG_LINETRIGGERDEBOUNCING

int result = 0;double value = 0.112;const enum FgParamTypes type = FG_PARAM_TYPE_DOUBLE;

if ((result = Fg_setParameterWithType(FG_LINETRIGGERDEBOUNCING, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINETRIGGERDEBOUNCING, &value, 0, type)) < 0) { /* error handling */}

8.3.4. Downscale

8.3.4.1. FG_LINE_DOWNSCALE

Sets the value after how many pulses of the input trigger signal a single one is passed through as ExSync.For example, a value of 2 creates an ExSync pulse at each 2nd input trigger signal. This is only relevant ifthe FG_LINETRIGGERMODE is set to an external trigger mode. The parameter FG_LINE_DOWNSCALEINITselects an initial delay of incoming pulses.

Figure 8.3. Downscale and Init phase behaviour



Table 8.7. Parameter properties of FG_LINE_DOWNSCALE

Property Value

Name FG_LINE_DOWNSCALEType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 1


Default value 1Unit of measure pulses

Example 8.6. Usage of FG_LINE_DOWNSCALE


if ((result = Fg_setParameterWithType(FG_LINE_DOWNSCALE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINE_DOWNSCALE, &value, 0, type)) < 0) { /* error handling */}

8.3.4.2. FG_LINE_DOWNSCALEINIT

In addition to the downscale value this parameter sets a phase position. This parameter specifies thenumber of external input trigger signals, which are needed to generate the first ExSync of a frame. Thisis only relevant if the FG_LINETRIGGERMODE is set to an image gate dependent ExSync mode. This valueis applied after the image start pulse. The parameter FG_LINE_DOWNSCALE represents the number ofpossible steps and an explaining figure is found in its description (Init=1).

Table 8.8. Parameter properties of FG_LINE_DOWNSCALEINIT

Property Value

Name FG_LINE_DOWNSCALEINITType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 1


Default value 1Unit of measure pulses

Example 8.7. Usage of FG_LINE_DOWNSCALEINIT


if ((result = Fg_setParameterWithType(FG_LINE_DOWNSCALEINIT, &value, 0, type)) < 0) { /* error handling */}



if ((result = Fg_getParameterWithType(FG_LINE_DOWNSCALEINIT, &value, 0, type)) < 0) { /* error handling */}

8.4. Shaft Encoder A/B Filter

With the support of signal A/B for shaft encoders it is possible to detect the rotary direction of anattached encoder and filter the encoder signals accordingly. Also a compensation is performed for up to16,777,216 reverse encoder signals. A brief description about this feature is found in the shaft encoderdocumentation.

8.4.1. FG_SHAFTENCODERON

Switch the shaft encoder filter On or Off. This is only relevant if the FG_LINETRIGGERMODE is set toan external trigger mode. The functionalities of FG_SHAFTENCODERMODE, FG_SHAFTENCODERINSRC,FG_SHAFTENCODERLEADING become relevant in the case this parameter is set to On = FG_ON. Whenenabling the shaft encoder, a reset of the encoder compensation is performed. If this filter is switchedon an correct A & B encoder signal is expected and necessary for correct functionality. Please be awarethat the input signal at FG_SHAFTENCODERINSRC is interpreted as phase B and the input signal atFG_LINETRIGGERINSRC as phase A. A sketch of the signal can be found in the description of parameterFG_LINETRIGGERINSRC.

Table 8.9. Parameter properties of FG_SHAFTENCODERON

Property Value

Name FG_SHAFTENCODERONType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_OFF

Example 8.8. Usage of FG_SHAFTENCODERON

int result = 0;unsigned int value = FG_OFF;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SHAFTENCODERON, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SHAFTENCODERON, &value, 0, type)) < 0) { /* error handling */}

8.4.2. FG_SHAFTENCODERMODE

The shaft encoder mode can be run in three operation modes. Please choose the according operationmode for your application. This feature can be used if FG_SHAFTENCODERON is switched on. It enablesyou to adjust the number of increments per rotation of the shaft encoder. Together with the parameterFG_LINE_DOWNSCALE you can adjust the increment re-scaling.

The following modes are available:

• Filter x1



ExSync is generated for a forward rotation of the shaft encoder in single resolution, i.e. a trigger pulsefor rising edge of Source A.

• Filter x2

ExSync is generated for a forward rotation of the shaft encoder in double resolution, i.e. a trigger pulsefor a rising and falling edge of Source A, edges of Source B are not used.

• Filter x4

ExSync is generated for a forward rotation of the shaft encoder in quad resolution, i.e. a trigger pulsefor a rising and falling edge of Source A and a rising and falling edge of Source B.

Figure 8.4. Shaft Encoder Mode : Filter x4, x2, x1

Table 8.10. Parameter properties of FG_SHAFTENCODERMODE

Property Value

Name FG_SHAFTENCODERMODEType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FILTER_X1 Filter x1

FILTER_X2 Filter x2FILTER_X4 Filter x4

Default value FILTER_X1

Example 8.9. Usage of FG_SHAFTENCODERMODE

int result = 0;unsigned int value = FILTER_X1;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SHAFTENCODERMODE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SHAFTENCODERMODE, &value, 0, type)) < 0) { /* error handling */}

8.4.3. FG_SHAFTENCODERINSRC

Specifies the input signal source / phase B for the shaft encoder filter. Signal source B of the shaft encoderis 90 degree phase shifted to source / phase A. In this document you can get more explanations regardingthe input pins in the context of parameter FG_LINETRIGGERINSRC and concerning the shaft encoder in



the introduction of Section 8.3, 'Line Trigger Input'. Please check the hardware documentation of themicroEnable trigger board considering the runtime manual installed along the runtime or our homepageat http://www.siliconsoftware.de for more details.

Table 8.11. Parameter properties of FG_SHAFTENCODERINSRC

Property Value

Name FG_SHAFTENCODERINSRCType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values TRGINSRC_0 Trigger Source 0

TRGINSRC_1 Trigger Source 1TRGINSRC_2 Trigger Source 2TRGINSRC_3 Trigger Source 3TRGINSRC_4 Trigger Source 4TRGINSRC_5 Trigger Source 5TRGINSRC_6 Trigger Source 6TRGINSRC_7 Trigger Source 7


Example 8.10. Usage of FG_SHAFTENCODERINSRC


if ((result = Fg_setParameterWithType(FG_SHAFTENCODERINSRC, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SHAFTENCODERINSRC, &value, 0, type)) < 0) { /* error handling */}

8.4.4. FG_SHAFTENCODERLEADING

This parameter defines the leading signal (= direction) of the shaft encoder filter. This induces rising/falling edge A before B equals forward direction and rising/falling edge B before A means reverse. Thedefault setting is A as the leading signal. Flipping the input pins or their polarity will have the same effectas changing this to B as the leading signal. It simply defines the valid direction of the scan. An explanationof the direction detection based on an encoder A / B signal is found in Section 8.3, 'Line Trigger Input'.

Table 8.12. Parameter properties of FG_SHAFTENCODERLEADING

Property Value

Name FG_SHAFTENCODERLEADINGType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values SOURCE_A Source A

SOURCE_B Source B

Default value SOURCE_A

Example 8.11. Usage of FG_SHAFTENCODERLEADING

int result = 0;



unsigned int value = SOURCE_A;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SHAFTENCODERLEADING, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SHAFTENCODERLEADING, &value, 0, type)) < 0) { /* error handling */}

8.5. ExSync Output

This category includes parameters to specify and parameterize the generated ExSync output signals.

8.5.1. FG_LINEPERIODE

This parameter specifies the period of the ExSync signal. Therefore, it defines the line frequency whenusing the grabber controlled mode to trigger the connected camera. This period is of interest if a grabbercontrolled line trigger mode is used; more details for this can be found at FG_LINETRIGGERMODE. The lineperiod is not allowed to be shorter than the minimum period - maximum line frequency - being supportedby the camera, or in other words:

Please do not try to trigger the camera at a higher frequency than possible.

This maximum frequency is limited by the exposure time and the line scan sensor maximum speed. Pleaseconsider the camera manual for more details.

The following equations are mentioned in order to support the setup process if no period forFG_LINEPERIODE is mentioned:

• Frequency

The period T is the duration of time of one cycle in a repeating event, so the period is the reciprocal ofthe frequency f.

Equation 8.1. Frequency to Period

T =1

f

Equation 8.2. Example: 17.6 kHz to Period

T =1

F=

1

17:6kHz=

1

17600HzT = 0:0000568s = 0:0568ms = 56:8¹s

• Velocity and Pixel / mm

The period T is the duration of time of one cycle in a repeating event. At a velocity v and a given numbern of pixels / mm together with the number n of pixels / mm being based on the resolution count r of theline scan sensor pixels and the width of view w in mm the following equations are valid.

Equation 8.3. Velocity and Resolution to Period

n =r

w

v =distance

timef = v ¤ n

T =1

f



Equation 8.4. Example: v = 53.4 m/min, r = 4096 pixels, w = 19.2 cm Wide Web to Period

n =r

w=

4096

19:2cm=

4096

192mm=21:33

mm

v =distance

time=53:4m

min=53:4m

60s= 0:89

m

s

f = v ¤ n = 0:89ms¤ 21:33mm

= 890mm

s¤ 21:33mm

=890 ¤ 21:33

s=18983:7

s= 18983:7Hz = 18:9837kHz

T =1

f

=1

18983:7Hz= 52:68¹s

Table 8.13. Parameter properties of FG_LINEPERIODE

Property Value

Name FG_LINEPERIODEType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 1.024



Example 8.12. Usage of FG_LINEPERIODE


if ((result = Fg_setParameterWithType(FG_LINEPERIODE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINEPERIODE, &value, 0, type)) < 0) { /* error handling */}

8.5.2. FG_LINEEXPOSURE

This parameter specifies the pulse width of the ExSync signal, which can be used by many cameras tospecify the exposure time. It is possible to adjust the exposure time via software, even while grabbing.The value is set in microseconds and may not exceed the period time of the ExSync FG_LINEPERIODE. Inorder to check the polarity simply increase this value and the resulting frame should become brighter. Ifthis behaves in an opposite way check the polarity using FG_EXSYNCPOLARITY.



Table 8.14. Parameter properties of FG_LINEEXPOSURE

Property Value

Name FG_LINEEXPOSUREType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 1.024



Example 8.13. Usage of FG_LINEEXPOSURE


if ((result = Fg_setParameterWithType(FG_LINEEXPOSURE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINEEXPOSURE, &value, 0, type)) < 0) { /* error handling */}

8.5.3. FG_EXSYNCPOLARITY

The parameter adjusts the polarity of the ExSync signal generator. Use Low Active, if the camera opensthe shutter on a falling edge, otherwise use High Active. For the mapping of the ExSync signals to thedigital outputs check Chapter 10, 'Digital I/O'.

Table 8.15. Parameter properties of FG_EXSYNCPOLARITY

Property Value

Name FG_EXSYNCPOLARITYType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_LOW Low Active

FG_HIGH High Active

Default value FG_ONE

Example 8.14. Usage of FG_EXSYNCPOLARITY

int result = 0;unsigned int value = FG_ONE;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_EXSYNCPOLARITY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_EXSYNCPOLARITY, &value, 0, type)) < 0) { /* error handling */}

8.5.4. FG_LINETRIGGERDELAY



This parameter specifies the delay between the generated ExSync and ExSync2 signals with respect to anexternal trigger input. Therefore, the ExSync2 signal is a delayed clone of the ExSync (polarity, period, etc.are the same as for ExSync). For the mapping of the ExSync signals to the digital outputs check Chapter10, 'Digital I/O'.

Table 8.16. Parameter properties of FG_LINETRIGGERDELAY

Property Value

Name FG_LINETRIGGERDELAYType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.0



Example 8.15. Usage of FG_LINETRIGGERDELAY


if ((result = Fg_setParameterWithType(FG_LINETRIGGERDELAY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LINETRIGGERDELAY, &value, 0, type)) < 0) { /* error handling */}


Chapter 9. Image Trigger / FlashThe image trigger for line-scan cameras is in charge to generate an internal signal called image gate. Linessent by the camera are only accepted if this image gate is active = open. Therefore, with help of the ImageGate it is possible to define frames by grouping all lines that belong to the same image gate into one frame.

This AcquisitionApplets Advanced supports three distinct operation modes of the image trigger:

• Free run

In free run mode the image gate basically remains active all time. Therefore, all lines sent by thecamera are grabbed. Moreover, it cuts the input lines into frames of the height specified by parameterFG_HEIGHT of the display module. Also, offsets defined by FG_YOFFSET are covered and removed fromthe camera transfers for each image.

• Async Trigger

For the external trigger mode of the image trigger, the image gate is inactive = closed until an externaltrigger signal activates the image gate for FG_HEIGHT + FG_YOFFSET lines. Therefore, for each externaltrigger event, the frame grabber records a frame of the specified height.

• Async Trigger Multi Buffer

For the external trigger mode of the image trigger, the image gate is inactive = closed until an externaltrigger signal activates the image gate. In contrast to the Async Trigger mode, the gate is open forFG_IMGTRIGGER_ASYNC_HEIGHT lines while this image is split into smaller chunks of FG_HEIGHT lines.Therefore, for each external trigger event, the frame grabber records a frame of a large specified heightand split the large image into smaller chunks. The purpose of the mode is to start processing in PC whilethe image is still recorded.

The parameter value of FG_YOFFSET is without influence in this mode.

• Gated, Trigger

For the external gated mode of the image trigger, the image gate is active as long as the external triggersource is active, but is becoming inactive when FG_HEIGHT + FG_YOFFSET lines have been grabbed.Therefore, during an external trigger phase the frame grabber records a frame with a height dependingon the duration of active time of the external trigger signal, but is not exceeding an image height ofFG_HEIGHT + FG_YOFFSET lines.

• Gated Multi Buffer, Triggered

Equal to the 'Gated Trigger' mode, for the 'Gated Multi Buffer Trigger' the image gate is active as longas the external trigger source is active. In contrast, it does not limit the height to FG_HEIGHT lines. Itwill cut the image after FG_HEIGHT lines and start a new frame. Thus, for each gate, multiple frames aregenerated when a gate is active for more lines than defined by FG_HEIGHT.

All images of a generated sequence will have a height of FG_HEIGHT lines. However, the last image ofeach sequence might have a lower number of lines in the image.

To detect the last image of a sequence in your software. Parameter FG_IMAGE_TAG can be used. Thisparameter is of type unsigned 32 bit integer. The most significant bit i.e. bit 31 includes a flag which isset to one if the respective image is the last image of a multi buffer sequence.

uint32_t imageTag = 0;int returnCode = Fg_getParameterEx(fg, FG_IMAGE_TAG, &imageTag, 0, pmem0, imageNumber);bool isLastImageOfSequence = imageTagRAW >> 31;

All other bits of parameter FG_IMAGE_TAG are fixed to value 0. The image tag parameter does notoutput the image number as available for older AcquisitionApplets.

Image Trigger / Flash


Note that the value of parameter FG_YOFFSET is not considered if the 'Gated Multi Buffer Trigger' modeis used. An y-offset cannot be set in the applet.

9.1. FG_IMGTRIGGERMODE

Choose one of the image trigger modes described above. Please make sure that the operation mode offrame grabber and camera is the same.

Table 9.1. Parameter properties of FG_IMGTRIGGERMODE

Property Value

Name FG_IMGTRIGGERMODEType EnumerationAccess policy Read/WriteStorage policy PersistentAllowed values FREE_RUN Free Run

ASYNC_TRIGGER Async External TriggerASYNC_TRIGGER_MULTIFRAME Async Multi Buffer External TriggerASYNC_GATED Gated, External TriggeredASYNC_GATED_MULTIFRAME Gated Multi Buffer, External Triggered

Default value FREE_RUN

Example 9.1. Usage of FG_IMGTRIGGERMODE

int result = 0;unsigned int value = FREE_RUN;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_IMGTRIGGERMODE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGERMODE, &value, 0, type)) < 0) { /* error handling */}

9.2. FG_IMGTRIGGERON

The generation of image triggers can be switched on or off by use of this parameter. When the imagetrigger is disabled and the image trigger is not running in free-run mode, the image acquisition isterminated. If the image trigger is enabled, the acquisition will start immediately.

Table 9.2. Parameter properties of FG_IMGTRIGGERON

Property Value

Name FG_IMGTRIGGERONType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_ON



Example 9.2. Usage of FG_IMGTRIGGERON


if ((result = Fg_setParameterWithType(FG_IMGTRIGGERON, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGERON, &value, 0, type)) < 0) { /* error handling */}

9.3. FG_FLASHON

To enable the flash output use this parameter.

For the mapping of the flash signal to the digital IO check Chapter 10, 'Digital I/O'.

Table 9.3. Parameter properties of FG_FLASHON

Property Value

Name FG_FLASHONType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_ON

Example 9.3. Usage of FG_FLASHON


if ((result = Fg_setParameterWithType(FG_FLASHON, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_FLASHON, &value, 0, type)) < 0) { /* error handling */}

9.4. FG_IMGTRIGGER_ASYNC_HEIGHT

This parameter only has influcence in the image trigger mode FG_IMGTRIGGERMODE Async Trigger MultiFrame ASYNC_TRIGGER_MULTIFRAME. The value is used to define the image height of the frame after thetrigger pulse. Whereas parameter FG_HEIGHT defines the chunk height.

If the value of FG_IMGTRIGGER_ASYNC_HEIGHT is less than FG_HEIGHT, the frame is not split intomultiple frames an will result in a smaller output frame.



Table 9.4. Parameter properties of FG_IMGTRIGGER_ASYNC_HEIGHT

Property Value

Name FG_IMGTRIGGER_ASYNC_HEIGHTType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 8


Default value 1024Unit of measure lines

Example 9.4. Usage of FG_IMGTRIGGER_ASYNC_HEIGHT


if ((result = Fg_setParameterWithType(FG_IMGTRIGGER_ASYNC_HEIGHT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGER_ASYNC_HEIGHT, &value, 0, type)) < 0) { /* error handling */}

9.5. FG_IMGTRIGGER_IS_BUSY

The image trigger is busy if the current requested frame from the camera has not been completelytransferred to the grabber. This parameter can be used to check if the camera can accept a new softwaretrigger pulse.

Table 9.5. Parameter properties of FG_IMGTRIGGER_IS_BUSY

Property Value

Name FG_IMGTRIGGER_IS_BUSYType EnumerationAccess policy Read-OnlyStorage policy TransientAllowed values IS_BUSY Busy Flag is set

IS_NOT_BUSY Busy Flag is not set

Example 9.5. Usage of FG_IMGTRIGGER_IS_BUSY

int result = 0;unsigned int value = IS_NOT_BUSY;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_getParameterWithType(FG_IMGTRIGGER_IS_BUSY, &value, 0, type)) < 0) { /* error handling */}

9.6. Flash

If enabled, the applet can generate a flash signal triggered by an external image trigger input such as theimage gate. It lasts for one line tick and is output on the trigger connector of the framegrabber or on anattached trigger extension board .



9.6.1. FG_FLASH_POLARITY

The polarity of the generated flash signal can be changed with this parameter. For the mapping of the flashsignal to the digital outputs check Chapter 10, 'Digital I/O'.

Table 9.6. Parameter properties of FG_FLASH_POLARITY

Property Value

Name FG_FLASH_POLARITYType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_LOW Low Active

FG_HIGH High Active

Default value FG_ONE

Example 9.6. Usage of FG_FLASH_POLARITY

int result = 0;unsigned int value = FG_ONE;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_FLASH_POLARITY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_FLASH_POLARITY, &value, 0, type)) < 0) { /* error handling */}

9.7. Image Trigger Input

This category includes parameters to specify and control the image trigger inputs. The input can eitherbe input pins of the frame grabber's trigger connector or trigger pulses generated by software registeraccesses.

9.7.1. FG_IMGTRIGGERINSRC

This parameter specifies the signal source, which is used to trigger the image acquisition gate. If a softwareimage trigger has to be used select option TRG_IN_SOURCE_SOFTWARE.



Table 9.7. Parameter properties of FG_IMGTRIGGERINSRC

Property Value

Name FG_IMGTRIGGERINSRCType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values TRGINSRC_0 Trigger Source 0

TRGINSRC_1 Trigger Source 1TRGINSRC_2 Trigger Source 2TRGINSRC_3 Trigger Source 3TRGINSRC_4 Trigger Source 4TRGINSRC_5 Trigger Source 5TRGINSRC_6 Trigger Source 6TRGINSRC_7 Trigger Source 7TRGINSOFTWARE Software Trigger


Example 9.7. Usage of FG_IMGTRIGGERINSRC


if ((result = Fg_setParameterWithType(FG_IMGTRIGGERINSRC, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGERINSRC, &value, 0, type)) < 0) { /* error handling */}

9.7.2. FG_IMGTRIGGERINPOLARITY

The parameter defines the polarity of the external input trigger signal.

Table 9.8. Parameter properties of FG_IMGTRIGGERINPOLARITY

Property Value

Name FG_IMGTRIGGERINPOLARITYType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values HIGH_ON_ZERO_LOW Low Active

HIGH_ON_ZERO_HIGH High Active


Example 9.8. Usage of FG_IMGTRIGGERINPOLARITY


if ((result = Fg_setParameterWithType(FG_IMGTRIGGERINPOLARITY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGERINPOLARITY, &value, 0, type)) < 0) { /* error handling */



}

9.7.3. FG_IMGTRIGGERGATEDELAY

With this parameter, a delay of lines can be configured before the activation of the image gate. This delaysthe start of the image acquisition. The parameter y-offest (as in free run mode) rejects the first lines fromthe camera. Delay and y-offset seem to have the same effect, however the difference is, that y-offsetdoesn't affect the image gate, which is relevant while using the gated line trigger mode.

Table 9.9. Parameter properties of FG_IMGTRIGGERGATEDELAY

Property Value

Name FG_IMGTRIGGERGATEDELAYType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 0



Example 9.9. Usage of FG_IMGTRIGGERGATEDELAY


if ((result = Fg_setParameterWithType(FG_IMGTRIGGERGATEDELAY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGERGATEDELAY, &value, 0, type)) < 0) { /* error handling */}

9.7.4. FG_IMGTRIGGERDEBOUNCING

This parameter specifies the debouncing time. This is the time for which the input image trigger signalmust keep the same value to be detected as such. Fast signal changes within the debounce time will befiltered out.

Table 9.10. Parameter properties of FG_IMGTRIGGERDEBOUNCING

Property Value

Name FG_IMGTRIGGERDEBOUNCINGType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.016





Example 9.10. Usage of FG_IMGTRIGGERDEBOUNCING


if ((result = Fg_setParameterWithType(FG_IMGTRIGGERDEBOUNCING, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMGTRIGGERDEBOUNCING, &value, 0, type)) < 0) { /* error handling */}

9.7.5. FG_STROBEPULSEDELAY

This parameter specifies the delay of the generated flash signal with respect to an external trigger input.Therefore, it is possible to synchronize the flash to the external trigger input. The delay is set in imageline ticks.

Table 9.11. Parameter properties of FG_STROBEPULSEDELAY

Property Value

Name FG_STROBEPULSEDELAYType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 0



Example 9.11. Usage of FG_STROBEPULSEDELAY


if ((result = Fg_setParameterWithType(FG_STROBEPULSEDELAY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_STROBEPULSEDELAY, &value, 0, type)) < 0) { /* error handling */}

9.7.6. Software Trigger

For the image trigger it is possible to use a software generated trigger signal to replace the external triggerinput.

The software trigger control modules allows the to either generate a software trigger pulse or allows toset the state of the software trigger signal to generate a gate i.e. for gated image trigger mode.

9.7.6.1. FG_SENDSOFTWARETRIGGER

A software trigger pulse can be sent by use of this parameter.



Table 9.12. Parameter properties of FG_SENDSOFTWARETRIGGER

Property Value

Name FG_SENDSOFTWARETRIGGERType EnumerationAccess policy Read/Write/ChangeStorage policy TransientAllowed values FG_APPLY Apply

Default value FG_APPLY

Example 9.12. Usage of FG_SENDSOFTWARETRIGGER

int result = 0;unsigned int value = FG_APPLY;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_SENDSOFTWARETRIGGER, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SENDSOFTWARETRIGGER, &value, 0, type)) < 0) { /* error handling */}

9.7.6.2. FG_SETSOFTWARETRIGGER

The software trigger state can be set to zero = low or one = high.

Table 9.13. Parameter properties of FG_SETSOFTWARETRIGGER

Property Value

Name FG_SETSOFTWARETRIGGERType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_LOW Low Active

FG_HIGH High Active


Example 9.13. Usage of FG_SETSOFTWARETRIGGER


if ((result = Fg_setParameterWithType(FG_SETSOFTWARETRIGGER, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SETSOFTWARETRIGGER, &value, 0, type)) < 0) { /* error handling */}


Chapter 10. Digital I/OThe frame grabber provides eight digital inputs and outputs. The current state of the digital inputs canbe obtained using parameter FG_DIGIO_INPUT. Digital inputs can be selected by the respective modulesof the applets e.g. trigger inputs. Digital outputs are mapped to functions. The following table shows themapping of modules to outputs. The front GPIO and GPIO provide the same signal.

Table 10.1. Trigger Output Mapping

Camera Index (Port) Function Output Index

0 (Port A) Flash 0

0 (Port A) ExSync 2 1

0 (Port A) ExSync 2

0 (Port A) Digital Output parameterFG_DIGIO_OUTPUT

3

Outputs 3 and 7 can be arbitrarily set to 0 or 1 using parameter FG_DIGIO_OUTPUT.

Besides reading the current state by parameters, events can be used for notification on changes.

10.1. FG_DIGIO_OUTPUT

Set the output value of outputs 3 and 7 using this parameter. Bit 0 of the parameter refers to the valueat output 3, while bit 1 refers to output 7.

Table 10.2. Parameter properties of FG_DIGIO_OUTPUT

Property Value

Name FG_DIGIO_OUTPUTType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0

Maximum 3Stepsize 1

Default value 3Unit of measure

Example 10.1. Usage of FG_DIGIO_OUTPUT


if ((result = Fg_setParameterWithType(FG_DIGIO_OUTPUT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_DIGIO_OUTPUT, &value, 0, type)) < 0) { /* error handling */}

10.2. FG_DIGIO_INPUT

Digital I/O


Parameter FG_DIGIO_INPUT is used to monitor the digital inputs of the frame grabber. ThisAcquisitionApplets Advanced has eight digital inputs. You can read the current state of these inputs usingparameter FG_DIGIO_INPUT. Bit 0 of the read value represents input 0, bit 1 represents input 1 and so on.For example, if you obtain the value 37 or hexadecimal 0x25 the frame grabber will have high level on it'sdigital inputs 0, 2 and 5.

Table 10.3. Parameter properties of FG_DIGIO_INPUT

Property Value

Name FG_DIGIO_INPUTType Unsigned IntegerAccess policy Read-OnlyStorage policy PersistentAllowed values Minimum 0


Unit of measure

Example 10.2. Usage of FG_DIGIO_INPUT


if ((result = Fg_getParameterWithType(FG_DIGIO_INPUT, &value, 0, type)) < 0) { /* error handling */}

10.3. Events

In programming or runtime environments, a callback function is a piece of executable code that is passedas an argument, which is expected to call back (execute) exactly that time an event is triggered. Thisapplet can generate some software callback events based on trigger inputs as explained in the followingsection. These events are not related to a special camera functionality. Other event sources are describedin additional sections of this document.

Our Runtime/SDK enables an application to get these event notifications about certain state changesat the data flow from camera to RAM and the image and trigger processing as well. Please consult ourRuntime/SDK documentation for more details concerning the implementation of this functionality.

10.3.1. FG_TRIGGER_INPUT0_RISING et al.

Note

This description applies also to the following events: FG_TRIGGER_INPUT1_RISING,FG_TRIGGER_INPUT2_RISING, FG_TRIGGER_INPUT3_RISING,FG_TRIGGER_INPUT4_RISING, FG_TRIGGER_INPUT5_RISING,FG_TRIGGER_INPUT6_RISING, FG_TRIGGER_INPUT7_RISING

This Event is generated for each rising signal edge at trigger input 0. Except for the timestamp, the eventhas no additional data included. Keep in mind that fast changes of the input signal can cause high interruptrates which might slow down the system. This event can occur independent of the acquisition status.

10.3.2. FG_TRIGGER_INPUT0_FALLING et al.

Digital I/O


Note

This description applies also to the following events: FG_TRIGGER_INPUT1_FALLING,FG_TRIGGER_INPUT2_FALLING, FG_TRIGGER_INPUT3_FALLING,FG_TRIGGER_INPUT4_FALLING, FG_TRIGGER_INPUT5_FALLING,FG_TRIGGER_INPUT6_FALLING, FG_TRIGGER_INPUT7_FALLING

This Event is generated for each falling signal edge at trigger input 0. Except for the timestamp, the eventhas no additional data included. Keep in mind that fast changes of the input signal can cause high interruptrates which might slow down the system. This event can occur independent of the acquisition status.


Chapter 11. OverflowThe applet processes image data as fast as possible. Any image data sent by the camera is immediatelyprocessed and sent to the PC. The latency is minimal. In general, only one concurrent image line is storedand processed in the frame grabber. However, the transfer bandwidth to the PC via DMA channel can varycaused by interrupts, other hardware and the current CPU load. Also, the camera frame rate can vary dueto an fluctuating trigger. For these cases, the applet is equipped with a memory to buffer the input frames.This buffer can store up to 32,000 image lines. The fill level of the buffer can be obtained by reading fromparameter FG_FILLLEVEL.

In normal operation conditions the buffer will always remain almost empty. For fluctuating camerabandwidths or for short and fast acquisitions, the buffer can easily fill up quickly. Of course, the inputbandwidth must not exceed the maximum bandwidth of the applet. Check Section 1.2, 'Bandwidth' formore information.

If the buffer's fill level reaches 100%, the applet is in overflow condition, as no more data can be bufferedand camera data will be discarded. This can result in two different behaviors:

• Corrupted Frames:

The transfer of a current frame is interrupted by an overflow. This means, the first pixels or lines ofthe frame were transfered into the buffer, but not the full frame. The output of the applet i.e. the DMAtransfer will be shorter. The output image will not have it's full height.

• Lost Frames:

A full camera frame was discarded due to a full buffer memory. No DMA transfer will exist for thediscarded frame. This means the number of applet output images can differ from the number of appletinput images.

A way to detect the overflows is to read parameter FG_OVERFLOW or check for eventFG_OVERFLOW_CAM0. Reading from the parameter will provide information about an overflow condition.As soon as the parameter is read, it will reset. Using the parameter an overflow condition can be detect,but it is not possible to obtain the exact image number and the moment. For this, the overflow event canbe used.

11.1. FG_FILLLEVEL

The fill-level of the frame grabber buffers used in this AcquisitionApplets Advanced can be read-out byuse of this parameter. The value allows to check if the mean input bandwidth of the camera is to high tobe processed with the applet.

Table 11.1. Parameter properties of FG_FILLLEVEL

Property Value

Name FG_FILLLEVELType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0


Unit of measure %

Example 11.1. Usage of FG_FILLLEVEL

int result = 0;

Overflow


unsigned int value = 0;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_getParameterWithType(FG_FILLLEVEL, &value, 0, type)) < 0) { /* error handling */}

11.2. FG_OVERFLOW

If the applet runs into overflow, a value "1" can be read by the use of this parameter. Note that an overflowresults in loss of images. To avoid overflows reduce the mean input bandwidth.

The parameter is reset at each readout cycle. The program microDisplay will continuously poll the value,thus the occurrence of an overflow might not be visible in microDisplay.

A more effective and robust way is to detect overflows is the use of the event system.

Table 11.2. Parameter properties of FG_OVERFLOW

Property Value

Name FG_OVERFLOWType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0

Maximum 1Stepsize 1

Example 11.2. Usage of FG_OVERFLOW


if ((result = Fg_getParameterWithType(FG_OVERFLOW, &value, 0, type)) < 0) { /* error handling */}

11.3. Events

In programming or runtime environments, a callback function is a piece of executable code that is passedas an argument, which is expected to call back (execute) exactly that time an event is triggered. This appletcan generate some software callback events based on the memory overflow condition as explained in thefollowing section. These events are not related to a special camera functionality. Other event sources aredescribed in additional sections of this document.

Our Runtime/SDK enables an application to get these event notifications about certain state changesat the data flow from camera to RAM and the image and trigger processing as well. Please consult ourRuntime/SDK documentation for more details concerning the implementation of this functionality.

11.3.1. FG_OVERFLOW_CAM0

Overflow events are generated for each corrupted or lost frame. In contrast to the other events presentedin this document, the overflow event transports data, namely the type of overflow, the image number andthe timestamp. The following figure illustrates the event data. Data is included in a 64 Bit data packet. Thefirst 32 Bit include the frame number. Bits 32 to 47 include an overflow mask.

Overflow


Figure 11.1. Illustration of Overflow Data Packet

Note that the frame number is reset on acquisition start. Also note that the first frame will have framenumber zero, while a DMA transfer starts with frame number one. The frame number is a 32 Bit value. If it'smaximum is reached, it will start from zero again. Keep in mind that on a 64 Bit runtime, the DMA transfernumber will be a 64 Bit value. If the frame corrupted flag is set, the frame with the frame number in theevent is corrupted i.e. it will not have it's full length but is still transfered via DMA channel. If the frame lostflag is set, the frame with the frame number in the event was fully discarded. No DMA transfer will existfor this frame. The corrupted frame flag and the frame lost flag will never occur for the same event. Theflag "event loss occured before" is an additional security mechanism. It means that an event has been lost.This can only happen at very high event rates and should not happen under normal conditions.

The analysis of the overflow events depends on the user requirements. In the following, an example isshown on how to ensure the integrity if the DMA data by analyzing the events and DMA transfers.

Overflow


Figure 11.2. Analysis of Overflow Data

t

frames at camera port / overflow operator

0

1

2

3

4

5

6

7

8

9

10

11

Event lost

Event lost

frames at DMA

1

2->3

4

5->6

7

+1 DMA offset

Frame 2 was lost. add 1 to all frames from now on

Frame 5 was lost. add 1 to all frames from now on

+1 DMA offset

Event corrupt

8

+1 DMA offset

Frame 8 was marked as corrupt

9

10

11

12

10 out of 12 frames ware passed through overflow.Two of these frames are corrupt

10 frames were received at the DMA channel

In the example, two frames got lost and one is marked as corrupted. As the events are not synchronouswith the DMA transfers, for analysis a software queue (push and pull) is required to allocate the eventsto the DMA transfers.


Chapter 12. Image SelectorThe Image Selector allows the user to cut out a period of p images from the image stream and select aparticular image n from it.

A typical setup to use this module would be the following: 2 frame grabbers and 1 CameraLink IO board(CLIO) in one PC or two PCs.

The CLIO module distributes the camera output to p frame grabbers by copying the image data. Theimage selector at each frame grabber is programmed to accept only one of p images, which decreases theprocessing frame rate in the grabber and thus, the frame rate at the PCI Express interface. This can beuseful if a PC cannot compute the full data rate or if different pre-processing is required to be performedin the frame grabbers.

Figure 12.1. CameraLink IO Board Setup

RAM

RAM

FPGA FPGA

PoCL

RAM

RAM

FPGA FPGA

PoCL

PoCL orCamera LinkBASE Config

PoCL orCamera LinkBASE Config

microEnable IV A-series or V-series

microEnable IV V-series

CLIO 4

Data output

Data output

CLIOInterface

The following example will explain the settings of p and n which represent the frame grabber parametersFG_IMG_SELECT_PERIOD and FG_IMG_SELECT. Suppose two frame grabbers which are connected via aCLIO board to one camera. Grabber 0 is required to process all even frames, while grabber 1 is requiredto process all odd frames. The settings will then be:

1. Grabber 0:

• FG_IMG_SELECT_PERIOD = 2

FG_IMG_SELECT = 0

2. Grabber 1:

• FG_IMG_SELECT_PERIOD = 2

FG_IMG_SELECT = 1

Ensure that both grabbers are used synchronously. This is possible with a triggered camera. To do so,initialize and configure both frame grabbers. Configure the camera for external trigger and the triggersystem of master grabber which is directly connected to the camera.

Image Selector


12.1. FG_IMG_SELECT_PERIOD

This parameter specifies the period length p. The parameter can be changed at any time. However,changing during acquisition can result in an asynchronous switching which will result in the loss of asynchronous grabbing. It is recommended to change the parameter only when the acquisition is stopped.

The parameter's value has to be greater than FG_IMG_SELECT.

Table 12.1. Parameter properties of FG_IMG_SELECT_PERIOD

Property Value

Name FG_IMG_SELECT_PERIODType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 1


Default value 1Unit of measure image

Example 12.1. Usage of FG_IMG_SELECT_PERIOD


if ((result = Fg_setParameterWithType(FG_IMG_SELECT_PERIOD, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMG_SELECT_PERIOD, &value, 0, type)) < 0) { /* error handling */}

12.2. FG_IMG_SELECT

The parameter FG_IMG_SELECT specifies a particular image from the image set defined byFG_IMG_SELECT_PERIOD. This parameter can be changed at any time. However, changing duringacquisition can result in an asynchronous switching which will result in the loss of a synchronous grabbing.It is recommended to change the parameter only when the acquisition is stopped.

The parameter's value has to be less than FG_IMG_SELECT_PERIOD.

Table 12.2. Parameter properties of FG_IMG_SELECT

Property Value

Name FG_IMG_SELECTType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0


Default value 0Unit of measure image

Image Selector


Example 12.2. Usage of FG_IMG_SELECT


if ((result = Fg_setParameterWithType(FG_IMG_SELECT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_IMG_SELECT, &value, 0, type)) < 0) { /* error handling */}


Chapter 13. White BalanceThe applet enables a spectral adaptation of the image to the lighting situation of the application. The colorvalues for the red, green and blue components can be individually enhanced or reduced by a scaling factorto adjust the spectral sensibility of the camera sensor.

13.1. FG_SCALINGFACTOR_RED

Table 13.1. Parameter properties of FG_SCALINGFACTOR_RED

Property Value

Name FG_SCALINGFACTOR_REDType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.0

Maximum 3.9990234375Stepsize 9.765625E-4

Default value 1.0

Example 13.1. Usage of FG_SCALINGFACTOR_RED


if ((result = Fg_setParameterWithType(FG_SCALINGFACTOR_RED, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SCALINGFACTOR_RED, &value, 0, type)) < 0) { /* error handling */}

13.2. FG_SCALINGFACTOR_BLUE

Table 13.2. Parameter properties of FG_SCALINGFACTOR_BLUE

Property Value

Name FG_SCALINGFACTOR_BLUEType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.0


Default value 1.0

Example 13.2. Usage of FG_SCALINGFACTOR_BLUE


if ((result = Fg_setParameterWithType(FG_SCALINGFACTOR_BLUE, &value, 0, type)) < 0) { /* error handling */

White Balance


}

if ((result = Fg_getParameterWithType(FG_SCALINGFACTOR_BLUE, &value, 0, type)) < 0) { /* error handling */}

13.3. FG_SCALINGFACTOR_GREEN

Table 13.3. Parameter properties of FG_SCALINGFACTOR_GREEN

Property Value

Name FG_SCALINGFACTOR_GREENType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.0


Default value 1.0

Example 13.3. Usage of FG_SCALINGFACTOR_GREEN


if ((result = Fg_setParameterWithType(FG_SCALINGFACTOR_GREEN, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_SCALINGFACTOR_GREEN, &value, 0, type)) < 0) { /* error handling */}


Chapter 14. Lookup TableThis AcquisitionApplets Advanced includes a full resolution lookup table (LUT) for each of the three colorcomponents. Settings are applied to the acquired images just before transferring them to the host PC.Thus, it is the last pre-processing step on the frame grabber.

A lookup table includes one entry for every allowed input pixel value. The pixel value will be replaced by thevalue of the lookup table element. In other words, a new value is assigned to each pixel value. This can beused for image quality enhancements such as an added offset, a gain factor or gamma correction whichcan be performed by use of the processing module of this applet in a convenient way (see Module Chapter15, 'Processing'). The lookup table can also be loaded with custom values. Application areas are customimage enhancements or correct pixel classifications.

This applet is processing data with a resolution of 8 bits. Thus, the lookup table has 8 input bits i.e. pixelvalues can be in the range [0, 255]. For each of these 256 elements, a table entry exists containing a newoutput value. The new values are in the range from 0 to 255. All color components are treated separately.

In the following the parameters to use the lookup table are explained. Parameter FG_LUT_TYPE isimportant to be set correctly as it defines the lookup table operation mode.

14.1. FG_LUT_TYPE

There exist two basic possibilities to use and configure the lookup table. One possibility is to use theinternal processor which allows a convenient way to improve the image quality using parameters such asoffset, gain and gamma. Check category Chapter 15, 'Processing' for more detailed documentation. Setthis parameter to LUT_TYPE_PROCESSING to use the processor.

The second possibility to use the lookup table is to load a file containing custom values to the lookup table.Set the parameter to LUT_TYPE_CUSTOM to enable the possibility to load a custom file with lookup tableentries.

Beside these two possibilities it is always possible to directly write to the lookup table entries using thefield parameters FG_LUT_VALUE_RED, FG_LUT_VALUE_GREEN and FG_LUT_VALUE_BLUE. The use ofthese parameters will overwrite the settings made with the processor or the custom input file. Vice versa,changing a processing parameter or loading a custom lookup table file, will overwrite the settings madeby the field parameters.

Table 14.1. Parameter properties of FG_LUT_TYPE

Property Value

Name FG_LUT_TYPEType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values LUT_TYPE_PROCESSING Processor

LUT_TYPE_CUSTOM User file

Default value LUT_TYPE_PROCESSING

Example 14.1. Usage of FG_LUT_TYPE

int result = 0;unsigned int value = LUT_TYPE_PROCESSING;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_LUT_TYPE, &value, 0, type)) < 0) { /* error handling */

Lookup Table


}

if ((result = Fg_getParameterWithType(FG_LUT_TYPE, &value, 0, type)) < 0) { /* error handling */}

14.2. FG_LUT_VALUE_RED

Table 14.2. Parameter properties of FG_LUT_VALUE_RED

Property Value

Name FG_LUT_VALUE_REDType Unsigned Integer FieldAccess policy Read/Write/ChangeStorage policy TransientDefault value 0

Example 14.2. Usage of FG_LUT_VALUE_RED

int result = 0;



if ((result = Fg_setParameterWithType(FG_LUT_VALUE_RED, &access, 0, type)) < 0) { /* error handling */ }

if ((result = Fg_getParameterWithType(FG_LUT_VALUE_RED, &access, 0, type)) < 0) { /* error handling */ }}

14.3. FG_LUT_VALUE_GREEN

Table 14.3. Parameter properties of FG_LUT_VALUE_GREEN

Property Value

Name FG_LUT_VALUE_GREENType Unsigned Integer FieldAccess policy Read/Write/ChangeStorage policy TransientDefault value 0

Example 14.3. Usage of FG_LUT_VALUE_GREEN

int result = 0;


for (unsigned int i = 0; i < 256; ++i){ access.index = i;

Lookup Table


access.value = 0;

if ((result = Fg_setParameterWithType(FG_LUT_VALUE_GREEN, &access, 0, type)) < 0) { /* error handling */ }

if ((result = Fg_getParameterWithType(FG_LUT_VALUE_GREEN, &access, 0, type)) < 0) { /* error handling */ }}

14.4. FG_LUT_VALUE_BLUE

Table 14.4. Parameter properties of FG_LUT_VALUE_BLUE

Property Value

Name FG_LUT_VALUE_BLUEType Unsigned Integer FieldAccess policy Read/Write/ChangeStorage policy TransientDefault value 0

Example 14.4. Usage of FG_LUT_VALUE_BLUE

int result = 0;



if ((result = Fg_setParameterWithType(FG_LUT_VALUE_BLUE, &access, 0, type)) < 0) { /* error handling */ }

if ((result = Fg_getParameterWithType(FG_LUT_VALUE_BLUE, &access, 0, type)) < 0) { /* error handling */ }}

14.5. FG_LUT_CUSTOM_FILE

If parameter FG_LUT_TYPE is set to LUT_TYPE_CUSTOM, the according path and filename to the filecontaining the custom lookup table entries can be set here. If the file is valid, the file values will be loadedto the lookup table. If the file is invalid, the call to this parameter will return an error.

A convenient way of getting a draft file, is to save the current lookup table settings to file using parameterFG_LUT_SAVE_FILE.

Please make sure to activate the Type of LUT FG_LUT_TYPE to "UserFile"/LUT_TYPE_CUSTOM in order tomake the changes and file names taking effect.

This section describes the file formats which are in use to fill the so called look-up tables (LUT). Thepurpose of a LUT is a transformation of pixel values from a input (source) image to the pixel values ofan output image. This transformation is done by a kind of table, which contains the assignment betweenthese pixel values (input pixel values - output pixel values). Basically the LUT is defined for gray formatand color formats as well. When defining a LUT for color formats, the definition of tables has to be donefor each color component. The LUT file format consists of 2 parts:

Lookup Table


• Header section containing control and description information.

• Main section containing the assignment table for transforming pixel values form a source (input) imageto a destination (output) image.

The following example shows how a grey scale lookup table description could look like:

# Lut data file v1.1id=3;nrOfElements=4096;format=0;number=0;0,0;1,1;2,2;3,3;4,4;5,5;6,6;…4095,4095;

General Properties:

• File format extension should be ".lut"

• LUT file format is an ASCII file format consisting of multiple lines of data.

• Lines are defined by a line separator a <CR> <LF> line feed (0x3D 0x0D 0x0A).

• Lines consist of key / value pairs. Key and value are separated by "=". The value has to be followed bya semicolon ; (0x3B)

• Formats consist of header data, containing control information and the assignment table for a specificcolor component (gray / red, green, blue).

• Basically the LUT file color format follows the same rules as the gray image format. In addition, due tothe fact, that each color component can has its own transformation, the definitions are repeated foreach color component.

The following example shows how a color scale lookup table description could look like:

# Lut data file v1.1[red]id=0;nrOfElements=256;format=0;number=0;0,0;1,1;..255,255;[green]id=1;nrOfElements=256;format=0;number=0;0,0;1,1;..255,255;[blue]id=2;nrOfElements=256;format=0;number=0;0,0;1,1;..255,255;

A more detailed explanation of the lookup table file format can be found in our runtime's SDK manual.

Lookup Table


Table 14.5. Parameter properties of FG_LUT_CUSTOM_FILE

Property Value

Name FG_LUT_CUSTOM_FILEType StringAccess policy Read/Write/ChangeStorage policy PersistentDefault value ""

Example 14.5. Usage of FG_LUT_CUSTOM_FILE

int result = 0;char* value = "";const enum FgParamTypes type = FG_PARAM_TYPE_CHAR_PTR;

if ((result = Fg_setParameterWithType(FG_LUT_CUSTOM_FILE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LUT_CUSTOM_FILE, &value, 0, type)) < 0) { /* error handling */}

14.6. FG_LUT_SAVE_FILE

To save the current lookup table configuration to a file, write the according output filename to thisparameter. Keep in mind that you need to have full write access to the specified path.

Writing the current lookup table settings to a file is also a convenient way to exploit the settings made bythe processor. Moreover, you will get a draft version of the lookup table file format. The values in the outputfile can directly be used to be loaded to the lookup table again using parameter FG_LUT_CUSTOM_FILE.

Table 14.6. Parameter properties of FG_LUT_SAVE_FILE

Property Value

Name FG_LUT_SAVE_FILEType StringAccess policy Read/Write/ChangeStorage policy TransientDefault value ""

Example 14.6. Usage of FG_LUT_SAVE_FILE


if ((result = Fg_setParameterWithType(FG_LUT_SAVE_FILE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_LUT_SAVE_FILE, &value, 0, type)) < 0) { /* error handling */}

14.7. Applet Properties

In the following, some properties of the lookup table implementation are listed.

14.7.1. FG_LUT_IMPLEMENTATION_TYPE

Lookup Table


In this applet, a full lookup table is implemented and can be setup in a custom way. By default a linearrepresentation is performed.

Table 14.7. Parameter properties of FG_LUT_IMPLEMENTATION_TYPE

Property Value

Name FG_LUT_IMPLEMENTATION_TYPEType EnumerationAccess policy Read-OnlyStorage policy TransientAllowed values LUT_IMPLEMENTATION_FULL_LUTFull LUT

LUT_IMPLEMENTATION_KNEELUTKneeLUT

Example 14.7. Usage of FG_LUT_IMPLEMENTATION_TYPE

int result = 0;unsigned int value = LUT_IMPLEMENTATION_FULL_LUT;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_getParameterWithType(FG_LUT_IMPLEMENTATION_TYPE, &value, 0, type)) < 0) { /* error handling */}

14.7.2. FG_LUT_IN_BITS

This applet is using 8 lookup table input bits.

Table 14.8. Parameter properties of FG_LUT_IN_BITS

Property Value

Name FG_LUT_IN_BITSType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientUnit of measure bit

Example 14.8. Usage of FG_LUT_IN_BITS


if ((result = Fg_getParameterWithType(FG_LUT_IN_BITS, &value, 0, type)) < 0) { /* error handling */}

14.7.3. FG_LUT_OUT_BITS

This applet is using 8 lookup table output bits.

Table 14.9. Parameter properties of FG_LUT_OUT_BITS

Property Value

Name FG_LUT_OUT_BITSType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientUnit of measure bit

Lookup Table


Example 14.9. Usage of FG_LUT_OUT_BITS


if ((result = Fg_getParameterWithType(FG_LUT_OUT_BITS, &value, 0, type)) < 0) { /* error handling */}


Chapter 15. ProcessingA convenient way to improve the image quality are the processing parameters. Using these parametersan offset, gain and gamma correction can be performed. Moreover, the image can be inverted.

Processor Activation

The processing parameters use the lookup table for determination of the correction values.For activation of the processing parameters, set FG_LUT_TYPE of category lookup table toLUT_TYPE_PROCESSING . Otherwise, parameter changes will have no effect.

All transformations apply in the following order:

1. Offset Correction, range [-1.0, +1.0], identity = 0

2. Gain Correction, range [0, 2^8[, identity = 1.0

3. Gamma Correction, range ]0, inf], identity = 1.0

4. Invert, identity = 'off'

In this applet, a full lookup table with m = 8 input bits and n = 8 outputs bits is used to perform thecorrections. Values are determined by

Equation 15.1. LUT Processor without Inversion

Output(x) =

"·gain ¤

µx

28 ¡ 1+ offset

¶¸ 1gamma

#¤¡28 ¡ 1

¢:

If the inversion is used, output values are determined by

Equation 15.2. LUT Processor with Inversion

Output(x) = 28 ¡ 1¡

"·gain ¤

µx

28 ¡ 1+ offset

¶¸ 1gamma

#¤¡28 ¡ 1

¢;

where x represents the input pixel value i.e. is in the range from 0 to 2^8 - 1. If the determined output valueis less than 0, it will be set to 0. If the determined output value is greater than 2^8 - 1 it is set to 2^8 - 1.

This applet processes each color component separately using the same processing parameters for eachcomponent.

If no parameters are changed, i.e. they are set to identity, the output values will be equal to the inputvalues as shown in the figure below. In the following, you will find detailed explanations for all processingparameters.

Figure 15.1. Lookup Table Processing: Identity

0 (2^m)-10

(2^n)-1

m = input bit depthn = output bit depth

Processing


15.1. FG_PROCESSING_OFFSET

The offset is a relative value added to each pixel, which leads to a behavior similar to a brightnesscontroller. A relative offset means, that e. g. 0.5 adds half of the total brightness to each pixel. In absolutenumbers when using 8 bit/pixel, 128 is added to each pixel (0.5 x 255 = 127.5). If you rather want to addan absolute value to each pixel do the following calculation: e. g. add -51 to an 8 bit/pixel offset = -51 / 255= -0.2.Figure 15.2 shows an example of an offset.

Figure 15.2. Lookup Table Processing: Offset

Table 15.1. Parameter properties of FG_PROCESSING_OFFSET

Property Value

Name FG_PROCESSING_OFFSETType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum -1.0


Default value 0.0

Example 15.1. Usage of FG_PROCESSING_OFFSET


if ((result = Fg_setParameterWithType(FG_PROCESSING_OFFSET, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_PROCESSING_OFFSET, &value, 0, type)) < 0) { /* error handling */}

15.2. FG_PROCESSING_GAIN

The gain is a multiplicative coefficient applied to each pixel, which leads to a behavior similar to a contrastcontroller. Each pixel value will be multiplied with the given value. For identity select value 1.0.

Processing


Figure 15.3. Lookup Table Processing: Gain

0 (2^m)-10

(2^n)-1


Table 15.2. Parameter properties of FG_PROCESSING_GAIN

Property Value

Name FG_PROCESSING_GAINType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0.0


Default value 1.0

Example 15.2. Usage of FG_PROCESSING_GAIN


if ((result = Fg_setParameterWithType(FG_PROCESSING_GAIN, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_PROCESSING_GAIN, &value, 0, type)) < 0) { /* error handling */}

15.3. FG_PROCESSING_GAMMA

The gamma correction is a power-law transformation applied to each pixel. Normalized pixel values pranging [0, 1.0] transform like p0 = p1=gamma .

Figure 15.4. Lookup Table Processing: Gamma

0 (2^m)-10

(2^n)-1


Processing


Table 15.3. Parameter properties of FG_PROCESSING_GAMMA

Property Value

Name FG_PROCESSING_GAMMAType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum -1000.0


Default value 1.0

Example 15.3. Usage of FG_PROCESSING_GAMMA


if ((result = Fg_setParameterWithType(FG_PROCESSING_GAMMA, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_PROCESSING_GAMMA, &value, 0, type)) < 0) { /* error handling */}

15.4. FG_PROCESSING_INVERT

When FG_PROCESSING_INVERT is set to FG_ON, the output is the negative of the input. Normalized pixelvalues p ranging [0, 1.0] transform to p' = 1 - p.

Figure 15.5. Lookup Table Processing: Invert

0 (2^m)-10

(2^n)-1


Table 15.4. Parameter properties of FG_PROCESSING_INVERT

Property Value

Name FG_PROCESSING_INVERTType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_OFF

Example 15.4. Usage of FG_PROCESSING_INVERT

int result = 0;unsigned int value = FG_OFF;

Processing


const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_PROCESSING_INVERT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_PROCESSING_INVERT, &value, 0, type)) < 0) { /* error handling */}


Chapter 16. Output FormatThe following parameter can be used to configure the applet's image output format i.e. the format andbit alignment.

16.1. FG_FORMAT

Parameter FG_FORMAT is used to set and determine the output formats of the DMA channels. An outputformat value specifies the number of bits and the color format of the output.

This applet (MediumLineRGB24) can only output a single output format.

Table 16.1. Parameter properties of FG_FORMAT

Property Value

Name FG_FORMATType EnumerationAccess policy Read/WriteStorage policy PersistentAllowed values FG_COL24 Color 24bit

Default value FG_COL24

Example 16.1. Usage of FG_FORMAT

int result = 0;unsigned int value = FG_COL24;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

if ((result = Fg_setParameterWithType(FG_FORMAT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_FORMAT, &value, 0, type)) < 0) { /* error handling */}

16.2. FG_BITALIGNMENT

This parameter has no function in applet MediumLineRGB24.

Table 16.2. Parameter properties of FG_BITALIGNMENT

Property Value

Name FG_BITALIGNMENTType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_LEFT_ALIGNED Left Aligned

FG_RIGHT_ALIGNED Right Aligned

Default value FG_LEFT_ALIGNED

Example 16.2. Usage of FG_BITALIGNMENT

int result = 0;unsigned int value = FG_LEFT_ALIGNED;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

Output Format


if ((result = Fg_setParameterWithType(FG_BITALIGNMENT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_BITALIGNMENT, &value, 0, type)) < 0) { /* error handling */}

16.3. FG_PIXELDEPTH

The pixel depth read-only parameter is used to determine the number of bits used to process a pixel inthe applet. It represents the internal bit width.

Table 16.3. Parameter properties of FG_PIXELDEPTH

Property Value

Name FG_PIXELDEPTHType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0


Unit of measure bit

Example 16.3. Usage of FG_PIXELDEPTH


if ((result = Fg_getParameterWithType(FG_PIXELDEPTH, &value, 0, type)) < 0) { /* error handling */}


Chapter 17. Camera SimulatorThe camera simulator is a convenient way to simulate cameras for first time applet tests. If the simulatoris enabled it generates pattern frames of specified size and frequency. The image data is replaced at theposition of the camera i.e. all applet processing functionalities are applied to the generated images. Notethat camera specific settings of the applet will not have any functionality. The generated patterns will usethe full bit depth available for the applet i.e. they will have a bit depth of 8Bit for this applet.

The generated images are diagonal grayscale patterns, such as the one shown in the following figure.

Figure 17.1. Generator Pattern

No Sub-Sensor Sorting in Generated Images

The camera simulator will generate a simple grayscale pattern. If the camera or this appletuses sub sensor pixel sorting (sensor correction), the simulator will not generate images whichrepresent the camera sensor.

17.1. FG_GEN_ENABLE

The generator is enabled with this parameter. Note that an activated generator will have effect onparameter FG_CAMSTATUS.

Table 17.1. Parameter properties of FG_GEN_ENABLE

Property Value

Name FG_GEN_ENABLEType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_CAMPORT Camera

FG_GENERATOR Generator

Default value FG_CAMPORT

Example 17.1. Usage of FG_GEN_ENABLE

int result = 0;unsigned int value = FG_CAMPORT;const enum FgParamTypes type = FG_PARAM_TYPE_UINT32_T;

Camera Simulator


if ((result = Fg_setParameterWithType(FG_GEN_ENABLE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_ENABLE, &value, 0, type)) < 0) { /* error handling */}

17.2. FG_GEN_START

This will enable or disable the generation of image data.

Table 17.2. Parameter properties of FG_GEN_START

Property Value

Name FG_GEN_STARTType EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_ON

Example 17.2. Usage of FG_GEN_START


if ((result = Fg_setParameterWithType(FG_GEN_START, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_START, &value, 0, type)) < 0) { /* error handling */}

17.3. FG_GEN_WIDTH

The width of the generated frame is set with this parameter.

Table 17.3. Parameter properties of FG_GEN_WIDTH

Property Value

Name FG_GEN_WIDTHType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0



Example 17.3. Usage of FG_GEN_WIDTH


Camera Simulator


if ((result = Fg_setParameterWithType(FG_GEN_WIDTH, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_WIDTH, &value, 0, type)) < 0) { /* error handling */}

17.4. FG_GEN_HEIGHT

The height of the generated frame is set with this parameter. This parameter has no effect on line scancamera applets.

Table 17.4. Parameter properties of FG_GEN_HEIGHT

Property Value

Name FG_GEN_HEIGHTType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0



Example 17.4. Usage of FG_GEN_HEIGHT


if ((result = Fg_setParameterWithType(FG_GEN_HEIGHT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_HEIGHT, &value, 0, type)) < 0) { /* error handling */}

17.5. FG_GEN_LINE_GAP

The line gap can be specified with this parameter. A high value reduces the line rate of the camerasimulator.

Table 17.5. Parameter properties of FG_GEN_LINE_GAP

Property Value

Name FG_GEN_LINE_GAPType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0



Camera Simulator


Example 17.5. Usage of FG_GEN_LINE_GAP


if ((result = Fg_setParameterWithType(FG_GEN_LINE_GAP, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_LINE_GAP, &value, 0, type)) < 0) { /* error handling */}

17.6. FG_GEN_FREQ

This parameter sets the pixel frequency. Note that the generator only simulates cameras. It is made fora first time use of the applet and user SDK verification. The camera simulator cannot reflect the exacttimings and frequencies of cameras.

Using the pixel frequency, the resulting frame rate (fps) can be obtained.

Equation 17.1. Shading Correction

fps =FG GEN FREQ

(FG GEN WIDTH+ FG GEN LINE GAP) ¤ FG GEN HEIGHT

Table 17.6. Parameter properties of FG_GEN_FREQ

Property Value

Name FG_GEN_FREQType DoubleAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 3.0


Default value 40.0Unit of measure MHz

Example 17.6. Usage of FG_GEN_FREQ


if ((result = Fg_setParameterWithType(FG_GEN_FREQ, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_FREQ, &value, 0, type)) < 0) { /* error handling */}

17.7. FG_GEN_ACCURACY

The accuracy enhances the allowed frequency range, but downgrades the accuracy itself.

Camera Simulator


Table 17.7. Parameter properties of FG_GEN_ACCURACY

Property Value

Name FG_GEN_ACCURACYType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 1


Default value 25

Example 17.7. Usage of FG_GEN_ACCURACY


if ((result = Fg_setParameterWithType(FG_GEN_ACCURACY, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_ACCURACY, &value, 0, type)) < 0) { /* error handling */}

17.8. FG_GEN_TAP1 et al.

Note

This description applies also to the following parameters: FG_GEN_TAP2, FG_GEN_TAP3,FG_GEN_TAP4

If a tap is disabled, it will output black pixels instead of the generated pattern.

Table 17.8. Parameter properties of FG_GEN_TAP1

Property Value

Name FG_GEN_TAP1Type EnumerationAccess policy Read/Write/ChangeStorage policy PersistentAllowed values FG_ON On

FG_OFF Off

Default value FG_ON

Example 17.8. Usage of FG_GEN_TAP1


if ((result = Fg_setParameterWithType(FG_GEN_TAP1, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_TAP1, &value, 0, type)) < 0) { /* error handling */}

Camera Simulator


17.9. FG_GEN_ROLL

The generated pattern can be 'rolled'. The speed is controlled by this parameter.

Table 17.9. Parameter properties of FG_GEN_ROLL

Property Value

Name FG_GEN_ROLLType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 0


Default value 0

Example 17.9. Usage of FG_GEN_ROLL


if ((result = Fg_setParameterWithType(FG_GEN_ROLL, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_GEN_ROLL, &value, 0, type)) < 0) { /* error handling */}

17.10. FG_GEN_ACTIVE

Table 17.10. Parameter properties of FG_GEN_ACTIVE

Property Value

Name FG_GEN_ACTIVEType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0


Example 17.10. Usage of FG_GEN_ACTIVE


if ((result = Fg_getParameterWithType(FG_GEN_ACTIVE, &value, 0, type)) < 0) { /* error handling */}

17.11. FG_GEN_PASSIVE

Camera Simulator


Table 17.11. Parameter properties of FG_GEN_PASSIVE

Property Value

Name FG_GEN_PASSIVEType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0


Example 17.11. Usage of FG_GEN_PASSIVE


if ((result = Fg_getParameterWithType(FG_GEN_PASSIVE, &value, 0, type)) < 0) { /* error handling */}

17.12. FG_GEN_LINE_WIDTH

Table 17.12. Parameter properties of FG_GEN_LINE_WIDTH

Property Value

Name FG_GEN_LINE_WIDTHType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0


Unit of measure pixel

Example 17.12. Usage of FG_GEN_LINE_WIDTH


if ((result = Fg_getParameterWithType(FG_GEN_LINE_WIDTH, &value, 0, type)) < 0) { /* error handling */}


Chapter 18. MiscellaneousThe miscellaneous module category summarizes other read and write parameters such as the camerastatus, buffer fill levels, DMA transfer lengths, time stamps and buffer fill-levels.

18.1. FG_TIMEOUT

This parameter is used to set a timeout for DMA transfers. After a timeout the acquisition is stopped. Butit is only a internal value that should not be used directly. Please use the timeout value described in theruntime SDK or microDisplay for acquisition in order to handle the functionality correctly.

Table 18.1. Parameter properties of FG_TIMEOUT

Property Value

Name FG_TIMEOUTType Unsigned IntegerAccess policy Read/Write/ChangeStorage policy PersistentAllowed values Minimum 2


Default value 1000000Unit of measure seconds

Example 18.1. Usage of FG_TIMEOUT


if ((result = Fg_setParameterWithType(FG_TIMEOUT, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_TIMEOUT, &value, 0, type)) < 0) { /* error handling */}

18.2. FG_TURBO_DMA_MODE

This applet is equipped with a high speed DMA frame grabber to PC image transfer. For most scenarios,the speed of the DMA is sufficient. In some cases an even higher DMA bandwidth is required. Using thisparameter, a DMA turbo mode can be activated for further increase of the bandwidth. Set the parameterto value one for activation of the turbo mode.

PC Mainboard Dependency

Some mainboards cannot handle increased data rates. These mainboards might significantlydecrease the bandwith when the DMA turbo mode is activated. Test your mainboard forcompatibility of the DMA turbo mode.

Global Setting of the Turbo Mode

The default value of the parameter is overwritten if a global setting for the DMA turbo modeis set in the used Silicon Software runtime. Check the runtime documentation for further

Miscellaneous


information. If an MCF file is used, the global setting is overwritten by the value in theconfiguration file.

Table 18.2. Parameter properties of FG_TURBO_DMA_MODE

Property Value

Name FG_TURBO_DMA_MODEType Unsigned IntegerAccess policy Read/WriteStorage policy PersistentAllowed values Minimum 0

Maximum 1Stepsize 1

Default value 0

Example 18.2. Usage of FG_TURBO_DMA_MODE


if ((result = Fg_setParameterWithType(FG_TURBO_DMA_MODE, &value, 0, type)) < 0) { /* error handling */}

if ((result = Fg_getParameterWithType(FG_TURBO_DMA_MODE, &value, 0, type)) < 0) { /* error handling */}

18.3. FG_APPLET_VERSION

This parameter represents the version number of the AcquisitionApplets Advanced. Please report thisvalue for any support of the applet.

Table 18.3. Parameter properties of FG_APPLET_VERSION

Property Value

Name FG_APPLET_VERSIONType Unsigned IntegerAccess policy Read-OnlyStorage policy Transient

Example 18.3. Usage of FG_APPLET_VERSION


if ((result = Fg_getParameterWithType(FG_APPLET_VERSION, &value, 0, type)) < 0) { /* error handling */}

18.4. FG_APPLET_REVISION

This parameter represents the revision number of the AcquisitionApplets Advanced. Please report thisvalue for any support case with the applet.

Miscellaneous


Table 18.4. Parameter properties of FG_APPLET_REVISION

Property Value

Name FG_APPLET_REVISIONType Unsigned IntegerAccess policy Read-OnlyStorage policy Transient

Example 18.4. Usage of FG_APPLET_REVISION


if ((result = Fg_getParameterWithType(FG_APPLET_REVISION, &value, 0, type)) < 0) { /* error handling */}

18.5. FG_APPLET_ID

This value is for internal use only.

Table 18.5. Parameter properties of FG_APPLET_ID

Property Value

Name FG_APPLET_IDType Unsigned IntegerAccess policy Read-OnlyStorage policy Transient

Example 18.5. Usage of FG_APPLET_ID


if ((result = Fg_getParameterWithType(FG_APPLET_ID, &value, 0, type)) < 0) { /* error handling */}

18.6. FG_HAP_FILE

The name of the Hardware-Applet (HAP) file on which this AcquisitionApplets Advanced is based. Pleasereport this read-only string parameter for any support case of the AcquisitionApplets Advanced.

Table 18.6. Parameter properties of FG_HAP_FILE

Property Value

Name FG_HAP_FILEType StringAccess policy Read-OnlyStorage policy Transient

Example 18.6. Usage of FG_HAP_FILE


if ((result = Fg_getParameterWithType(FG_HAP_FILE, &value, 0, type)) < 0) {

Miscellaneous


/* error handling */}

18.7. FG_DMASTATUS

Using this parameter the status of a DMA channel can be obtained. Value "1" represents a started DMAi.e. a started acquisition. Value "0" represents a stopped acquisition.

Table 18.7. Parameter properties of FG_DMASTATUS

Property Value

Name FG_DMASTATUSType Unsigned IntegerAccess policy Read-OnlyStorage policy Transient

Example 18.7. Usage of FG_DMASTATUS


if ((result = Fg_getParameterWithType(FG_DMASTATUS, &value, 0, type)) < 0) { /* error handling */}

18.8. FG_CAMSTATUS

The camera status shows whether the camera clock signal can be recognized by frame grabber or not. Ifvalue "1" is determined from this read parameter, the grabber recognized a camera clock signal.

Table 18.8. Parameter properties of FG_CAMSTATUS

Property Value

Name FG_CAMSTATUSType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0

Maximum 1Stepsize 1

Example 18.8. Usage of FG_CAMSTATUS


if ((result = Fg_getParameterWithType(FG_CAMSTATUS, &value, 0, type)) < 0) { /* error handling */}

18.9. FG_CAMSTATUS_EXTENDED

This parameter provides extended information on the pixel clock from the camera, LVAL and FVAL, as wellas the camera trigger signals, external trigger signals, buffer overflow status and buffer status. Each bitof the eight bit output word represents one parameter listed in the following:

Miscellaneous


• 0 = CameraClk, provided by CameraLink interface. Shows if CL PixelClock is available.

• 1 = CameraLval, provided by CameraLink interface. Shows if CameraLink LVAL is available, representinga line being transferred into frame grabber.

• 2 = CameraFval, provided by CameraLink interface. Shows if CameraLink FVAL is available, representingframes being transferred into frame grabber. Not relevant for standard line scan applets.

• 3 = Camera CC1 Signal, available for CameraLink interface.

• 4 = ExTrg / external trigger, provided by CameraLink interface.

• 5 = BufferOverflow

• 6 = BufStatus, LSB

• 7 = BufStatus, MSB

Table 18.9. Parameter properties of FG_CAMSTATUS_EXTENDED

Property Value

Name FG_CAMSTATUS_EXTENDEDType Unsigned IntegerAccess policy Read-OnlyStorage policy TransientAllowed values Minimum 0


Example 18.9. Usage of FG_CAMSTATUS_EXTENDED


if ((result = Fg_getParameterWithType(FG_CAMSTATUS_EXTENDED, &value, 0, type)) < 0) { /* error handling */}


GlossaryArea of Interest (AOI) See Region of Interest.

Board A Silicon Software hardware. Usually, a board is represented by a framegrabber. Boards might comprise multiple devices.

Board ID Number An identification number of a Silicon Software board in a PC system. Thenumber is not fixed to a specific hardware but has to be unique in a PCsystem.

Camera Index The index of a camera connected to a frame grabber. The first camera willhave index zero. Mind the difference between the camera index and theframe grabber camera port.See also Camera Port.

Camera Port The Silicon Software frame grabber connectors for cameras are calledcamera ports. They are numbered {0, 1, 2, ...} or enumerated {A, B, C, ... }.Depending on the interface one camera could be connected to multiplecamera ports. Also, multiple cameras could be connected to one cameraport.

Camera Tap See Tap.

Device A board can consist of multiple devices. Devices are numbered. The firstdevice usually has number one.

Direct Memory Access(DMA)

A DMA transfer allows hardware subsystems within the computer toaccess the system memory independently of the central processing unit(CPU).

SiliconSoftware uses DMAs for data transfer such as image data betweena board e.g. a frame grabber and a PC. Data transfers can be establishedin multiple directions i.e. from a frame grabber to the PC (download) andfrom the PC to a frame grabber (upload). Multiple DMA channels may existfor one board. Control and configuration data usually do not use DMAchannels.

DMA Channel See DMA Index.

DMA Index The index of a DMA transfer channel.See also Direct Memory Access.

Event In programming or runtime environments, a callback function is a piece ofexecutable code that is passed as an argument, which is expected to callback (execute) exactly that time an event is triggered. These events arenot related to a special camera functionality and based on frame grabberinternal functionality.

SiliconSoftware uses hardware interrupts for the event transfer andprocessing is absolutely optimized for low latency. These interrupts areonly produced by the grabber if an event is registered and activated bysoftware. If an event is fired at a very high frequency this may influencethe system performance.

For example these events can be used to check the reliability between aframe trigger input and the resulting and expected camera frame.

Our Runtime/SDK enables an application to get these event notificationsabout certain state changes at the data flow from camera to RAM and the

Glossary


image and trigger processing as well. Please consult our Runtime/SDKdocumentation for more details concerning the implementation of thisfunctionality. Some events are enabled to produce additional data, whichis described for the event itself.

Port See Camera Port.

Process An image or signal data processing block. A process can include one ormore cameras, one or more DMA channels and modules.

Region of Interest (ROI) Represents a part of a frame. Mostly rectangular and within the originalimage boundaries. Defined by source coordinates and its dimension. Theframe grabber cuts the region of interest from the camera image. A regionof interest might reduce or increase the required bandwidth and thecorresponding image dimension.

Sensor Tap See Tap.

Software Callback See Event.

Tap Some cameras have multiple taps. This means, they can acquire ortransfer more than one pixel at a time which increses the camera'sacquisition speed. The camera sensor tap readout order varies. Somecameras read the pixels interlaced using multiple taps, while somecameras read the pixel simultaneously from different locations onthe sensor. The reconstruction of the frame is called sensor readoutcorrection.

The Camera Link interface is also using multiple taps for image transfer toincrease the bandwidth. These taps are independent from the sensor taps.

Trigger In machine vision and image processing, a trigger is an event which causesan action. This can be for example the initiation of a new line or frameacquisition, the control of external hardware such as flash lights or actionsby a software applications. Trigger events can be initiated by externalsources, an internal frequency generator (timer) or software applications.The event itself is mostly based on a rising or falling edge of a electricalsignal.

Trigger Input A logic input of a trigger IO. The first input has index 0. Check mapping ofinput pins to logic inputs in the hardware documentation.

Trigger Output A logic output of a trigger IO. The first output has index 1. Please check themapping of output pins to logic outputs in the hardware documentation.The electrical characteristics and specification can be found related to theselected or used trigger board/connector.

Trigger Reliability See Event.

User Interrupt See Event.


IndexAArea of Interest, 9

BBandwidth, 2

CCamera

Format, 7Interface, 4

Camera Link, 7, 7Camera Simulator, 73, 73CC Signal Mapping, 20

DDigital I/O, 47, 47Digital I/O::Events, 48

EEvents

CL Transfer, 6Overflow, 51Trigger, 48

FFeatures, 1FG_APPLET_ID, 82FG_APPLET_REVISION, 81FG_APPLET_VERSION, 81FG_BITALIGNMENT, 71FG_CAMERA_LINK_CAMTYPE, 7FG_CAMSTATUS, 83FG_CAMSTATUS_EXTENDED, 83FG_CCSEL0, 20FG_CCSEL1, 21FG_CCSEL2, 22FG_CCSEL3, 22FG_DIGIO_INPUT, 47FG_DIGIO_OUTPUT, 47FG_DMASTATUS, 83FG_EXSYNCON, 25FG_EXSYNCPOLARITY, 36FG_FILLLEVEL, 50FG_FLASHON, 40FG_FLASH_POLARITY, 42FG_FORMAT, 71FG_GEN_ACCURACY, 76FG_GEN_ACTIVE, 78FG_GEN_ENABLE, 73FG_GEN_FREQ, 76FG_GEN_HEIGHT, 75FG_GEN_LINE_GAP, 75FG_GEN_LINE_WIDTH, 79FG_GEN_PASSIVE, 78

Index


FG_GEN_ROLL, 78FG_GEN_START, 74FG_GEN_TAP1, 77FG_GEN_TAP2, 77FG_GEN_TAP3, 77FG_GEN_TAP4, 77FG_GEN_WIDTH, 74FG_HAP_FILE, 82FG_HEIGHT, 10FG_IMGTRIGGERDEBOUNCING, 44FG_IMGTRIGGERGATEDELAY, 44FG_IMGTRIGGERINPOLARITY, 43FG_IMGTRIGGERINSRC, 42FG_IMGTRIGGERMODE, 39FG_IMGTRIGGERON, 39FG_IMGTRIGGER_ASYNC_HEIGHT, 40FG_IMGTRIGGER_IS_BUSY, 41FG_IMG_SELECT, 55FG_IMG_SELECT_PERIOD, 55FG_LINEEXPOSURE, 35FG_LINEPERIODE, 34FG_LINETRIGGERDEBOUNCING, 29FG_LINETRIGGERDELAY, 36FG_LINETRIGGERINPOLARITY, 28FG_LINETRIGGERINSRC, 27FG_LINETRIGGERMODE, 24FG_LINE_DOWNSCALE, 29FG_LINE_DOWNSCALEINIT, 30FG_LUT_CUSTOM_FILE, 61FG_LUT_IMPLEMENTATION_TYPE, 63FG_LUT_IN_BITS, 64FG_LUT_OUT_BITS, 64FG_LUT_SAVE_FILE, 63FG_LUT_TYPE, 59FG_LUT_VALUE_BLUE, 61FG_LUT_VALUE_GREEN, 60FG_LUT_VALUE_RED, 60FG_OVERFLOW, 51FG_OVERFLOW_CAM0, 51FG_PIXELDEPTH, 72FG_PROCESSING_GAIN, 67FG_PROCESSING_GAMMA, 68FG_PROCESSING_INVERT, 69FG_PROCESSING_OFFSET, 67FG_SCALINGFACTOR_BLUE, 57FG_SCALINGFACTOR_GREEN, 58FG_SCALINGFACTOR_RED, 57FG_SC_PIXELORDER, 18FG_SC_READOUTDIRECTION, 17FG_SC_ROTATEDSENSOR, 17FG_SC_SENSORLENGTH, 16FG_SC_SUBSENSORCOUNT, 15FG_SC_TAPCOUNT, 16FG_SC_UPDATESCHEME, 18FG_SENDSOFTWARETRIGGER, 45FG_SENSORREADOUT, 15FG_SETSOFTWARETRIGGER, 46FG_SHAFTENCODERINSRC, 32

Index


FG_SHAFTENCODERLEADING, 33FG_SHAFTENCODERMODE, 31FG_SHAFTENCODERON, 31FG_STROBEPULSEDELAY, 45FG_TIMEOUT, 80FG_TRIGGER_INPUT0_FALLING, 48FG_TRIGGER_INPUT0_RISING, 48FG_TRIGGER_INPUT1_FALLING, 49FG_TRIGGER_INPUT1_RISING, 48FG_TRIGGER_INPUT2_FALLING, 49FG_TRIGGER_INPUT2_RISING, 48FG_TRIGGER_INPUT3_FALLING, 49FG_TRIGGER_INPUT3_RISING, 48FG_TRIGGER_INPUT4_FALLING, 49FG_TRIGGER_INPUT4_RISING, 48FG_TRIGGER_INPUT5_FALLING, 49FG_TRIGGER_INPUT5_RISING, 48FG_TRIGGER_INPUT6_FALLING, 49FG_TRIGGER_INPUT6_RISING, 48FG_TRIGGER_INPUT7_FALLING, 49FG_TRIGGER_INPUT7_RISING, 48FG_TURBO_DMA_MODE, 80FG_USEDVAL, 7FG_WIDTH, 10FG_XOFFSET, 11FG_YOFFSET, 11Format, 71

GGenerator, 73

IImage Select, 54Image Selector, 54Image Transfer, 4Image Trigger / Flash, 38Image Trigger / Flash::Flash, 41Image Trigger / Flash::Image Trigger Input, 42Image Trigger / Flash::Image Trigger Input::Software Trigger, 45

LLine Trigger / ExSync, 24Line Trigger / ExSync::ExSync Output, 34Line Trigger / ExSync::Line Trigger Input, 26Line Trigger / ExSync::Line Trigger Input::Downscale, 29Line Trigger / ExSync::Shaft Encoder A/B Filter, 31Lookup Table, 59, 59Lookup Table::Applet Properties, 63

MMiscellaneous, 80

OOutput Format, 71Overflow, 50, 50

Events, 51Overflow::Events, 51

Index


PPC Interface, 4Processing, 66Processor, 66

RRegion of Interest, 9ROI, 9

SSensor Correction, 13, 13Software Interface, 5Specifications, 1

TTrigger

Digital Input, 48Events, 48Input, 48

WWhite Balance, 57, 57

mediumlinergb24 for microenable iv vd4-cl/-pocl ... · pdf filemicroenable iv vd4-cl/-pocl...

Documents