USER’S MANUAL Document Number: DA00063006 Release Date: 7 December 2010
For customers in the U.S.A. This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications.
Contacting Basler Support Worldwide Europe: Basler AG Ander Strusbek 60 - 62 22926 Ahrensburg Germany Tel.: +49-4102-463-515 Fax.: +49-4102-463-599 bc.support.europe@baslerweb.com Americas: Basler, Inc. 855 Springdale Drive, Suite 203 Exton, PA 19341 U.S.A. Tel.: +1-610-280-0171 Fax.: +1-610-280-7608 bc.support.usa@baslerweb.com Asia: Basler Asia Pte. Ltd. 8 Boon Lay Way # 03 - 03 Tradehub 21 Singapore 609964 Tel.: +65-6425-0472 Fax.: +65-6425-0473 bc.support.asia@baslerweb.com www.baslerweb.
DRAFT Contents Table of Contents 1 Introduction 1.1 Documentation Applicability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 1.2 Performance Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 1.3 Camera Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 1.4 Spectral Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRAFT Contents 3.6 Area of Interest (AOI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19 3.6.1 Changing AOI Parameters “On-the-Fly” . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20 3.6.2 Changes to the Frame Rate with AOI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21 3.7 Low Smear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23 3.8 Color Creation in the A102fc . . .
DRAFT Contents 4.4.2.5 Control and Status Registers for Format 7, Mode 1 . . . . . . . . . . . 4-34 4.4.2.6 Control and Status Registers for the PIO Control Function . . . . . . 4-41 4.4.2.7 Control and Status Registers for the Strobe Signal Function . . . . 4-42 4.4.3 Advanced Features Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46 5 Image Data Formats and Structures 5.1 Image Data Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents DRAFT 6.7.9 Lossless Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28 6.7.10 Trigger Flag and Trigger Counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29 6.7.11 Output Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30 6.7.12 Startup Memory Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33 6.7.13 Shutter Time Base. . . . . . . . . . . . . . . .
DRAFT Introduction 1 Introduction 1.1 Documentation Applicability This User’s Manual applies to A102f monochrome cameras with a firmware ID number of 31 or A102fc color cameras with a firmware ID number of 34. Cameras with a lower or a higher firmware ID number may have fewer features or have more features than described in this manual. Features on cameras with a lower or a higher firmware ID number may not operate exactly as described in this manual.
DRAFT Introduction 1.2 Performance Specifications Specification A102f A102fc Sensor Type Sony ICX-285 Progressive Scan CCD Sensor Pixels 1392 (H) × 1040 (V) Pixel Size 6.45 µm (H) × 6.45 µm (V) Mono / Color Mono Anti-blooming Yes Max. Frame Rate (at full resolution) 15.1 frames/s (in 8 bit output modes) Video Output Formats Mono 8, 8 bits/pixel Mono 8, 8 bits/pixel Mono 16, 16 bits per pixel (12 bits effective) Raw 8, 8 bits/pixel 1388 (H) x 1038 (V) Color 11.
DRAFT Introduction 1.3 Camera Models The camera is available in a monochrome model (the A102f) and a color model (the A102fc). Throughout the manual, the camera will be called the A102f. Passages that are only valid for a specific model will be so indicated. 1.4 Spectral Response The spectral response for the A102f monochrome cameras is shown in Figure 1-2. 1.0 0.9 0.8 0.7 0.6 0.5 0.4 0.3 0.2 0.
DRAFT Introduction The spectral response for A102fc color cameras is shown in Figure 1-3. Figure 1-3: A102f Spectral Response - Color Cameras L The spectral response curves exclude lens characteristics and light source characteristics. To get the best performance from A102fc color cameras, use of a dielectric IR cut-off filter is recommended. The filter should transmit in a range of 400 nm to 700...720 nm, and it should cut off from 700...720 nm to 1100 nm.
DRAFT Introduction 1.5 Environmental Requirements 1.5.1 Temperature and Humidity Housing temperature during operation: 0° C ... + 50° C (+ 32° F ... + 122° F) Humidity during operation: 20% ... 80%, relative, non-condensing 1.5.2 Ventilation Allow sufficient air circulation around the camera to prevent internal heat build-up in your system and to keep the camera housing temperature during operation below 50° C. Provide additional cooling such as fans or heat sinks if necessary. 1.
Introduction DRAFT 1.7 Obtaining an RMA Number Whenever you want to return material to Basler, you must request a Return Material Authorization (RMA) number before sending it back. The RMA number must be stated in your delivery documents when you ship your material to us! Please be aware that if you return material without an RMA number, we reserve the right to reject the material. You can find detailed information about how to obtain an RMA number on the Basler website at: www.baslerweb.
DRAFT Camera Interface 2 Camera Interface 2.1 Connections 2.1.1 General Description The A102f is interfaced to external circuitry via an IEEE 1394 socket and a 10 pin RJ-45 jack located on the back of the housing. Figure 2-1 shows the location of the two connectors.
DRAFT Camera Interface 2.1.2 Pin Assignments The IEEE 1394 socket is used to supply power to the camera and to interface video data and control signals. The pin assignments for the socket are shown in Table 2-1. Pin Signal 1 Power Input (+8.0 to +36.0 VDC) 2 DC Gnd 3 TPB - 4 TPB + 5 TPA - 6 TPA + Table 2-1: Pin Assignments for the IEEE 1394 Socket The RJ-45 jack is used to access the four physical input ports and four physical output ports on the camera.
DRAFT Camera Interface Figure 2-2: A102f Pin Numbering L The camera housing is connected to the cable shields and coupled to signal ground through an RC network (see Figure 2-3 for more details). 2.1.3 Connector Types The 6-pin connector on the camera is a standard IEEE-1394 socket. The 10-pin connector on the camera is an RJ-45 jack. Caution! The plug on the cable that you attach to the camera’s RJ-45 jack must have 10 pins.
DRAFT Camera Interface 2.2 Cables The maximum length of the IEEE 1394 cable used between the camera and the adapter in your PC or between the camera and a 1394 hub is 4.5 meters as specified in the IEEE 1394 standard. Standard, shielded IEEE 1394 cables must be used. The maximum length of the I/O cable is at least 10 meters. The cable must be shielded and must be constructed with twisted pair wire. Close proximity to strong magnetic fields should be avoided. 2.
DRAFT Camera Interface 2.5 Input and Output Ports 2.5.1 Input Ports A102f cameras are equipped with four physical input ports designated as Input Port 0, Input Port 1, Input Port 2, and Input Port 3. The input ports are accessed via the 10 pin RJ-45 jack on the back of the camera. See Table 2-2 and Figure 2-2 for input port pin assignments and pin numbering. As shown in the schematic in Figure 2-3, each input port is opto-isolated. The nominal input voltage for the LED in the opto-coupler is 5.0 V (± 1.
DRAFT Camera Interface 3.3 V 5.1k 390 Ω In_0 + 390 Ω In_1 + 390 Ω In_2 + HCPCL063L Gnd 3.3 V 5.1k HCPCL063L 3.3 V 3.3 V 5.1k HCPCL063L Gnd 3.3 V 5.
DRAFT Camera Interface 2.5.3 Typical Input Circuits Figure 2-4 shows a typical 5 VDC circuit you can use to input a signal into the camera. In Figure 2-4, the signal is applied to input port 1. Figure 2-4: Typical 5 VDC Input Circuit Figure 2-5 shows a typical 24 VDC circuit you can use to input a signal into the camera. Notice that an external 1.2 k resistor has been added to the circuit. This will result in approximately 15 mA being applied to the input.
Camera Interface DRAFT 2.5.4 Typical Output Circuits Figure 2-6 shows a typical circuit you can use to monitor an output port with a voltage signal. The circuit in Figure 2-6 is monitoring camera output port 1. Figure 2-6: Typical Voltage Output Circuit Figure 2-7 shows a typical circuit you can use to monitor an output port with a LED or an optocoupler. In this example, the voltage for the external circuit is 24 VDC. Current in the circuit is limited to approximately 10 mA by an external 2.2k resistor.
DRAFT Basic Operation & Standard Features 3 Basic Operation and Standard Features 3.1 Functional Description 3.1.1 Overview A102f area scan cameras employ a CCD sensor chip which provides features such as a full frame shutter and electronic exposure time control. Normally, exposure time and charge readout are controlled by values transmitted to the camera’s control registers via the IEEE 1394 interface. Control registers are available to set exposure time and frame rate.
Basic Operation & Standard Features DRAFT The image buffer between the sensor and the link layer controller allows data to be read out of the sensor at a rate that is independent of the data transmission rate between the camera and the host computer. This ensures that the data transmission rate has no influence on image quality.
DRAFT Basic Operation & Standard Features Figure 3-2: Block Diagram BASLER A102f 3-3
Basic Operation & Standard Features DRAFT 3.2 Exposure Control 3.2.1 Setting the Exposure Time Exposure time is determined by a combination of two values. The first is the setting in the Value field of the Shutter control register (see page 4-22). The second is the Shutter Time Base. Exposure time is determined by the product of these two values: Exposure Time = (Shutter Value Setting) x (Shutter Time Base) The shutter time base is fixed at 20 µs by default.
DRAFT Basic Operation & Standard Features 3.2.3 Controlling Exposure Start with “Shot” Commands via the 1394 Interface Exposure start can be controlled by sending “shot” commands directly to the camera via the 1394 bus. In this case, a software trigger or an external trigger (ExTrig) signal is not used. When exposure start is controlled with shot commands via the 1394 bus, two modes of operation are available: one-shot and continuous-shot.
Basic Operation & Standard Features DRAFT 3.2.4 Controlling Exposure Start with a Software Trigger Exposure start can be controlled by sending a software trigger command to the camera via the 1394 bus. The Trigger Mode control register (see page 4-24) is used to enable the ability to start image exposure with a software trigger. The Software Trigger control register (see page 4-19) is used to set the software trigger.
DRAFT Basic Operation & Standard Features Software Trigger / Continuous-Shot Operation In Software Trigger/Continuous-shot operation, a “Continuous Shot Command” is used to prepare the camera to capture multiple images. With this method of operation, exposure will begin when the Trigger field of the Software Trigger control register is set to 1. To use this operating method, follow this sequence: 1. Use the shutter settings described in Section 3.2.1 to set your desired exposure time. 2.
Basic Operation & Standard Features DRAFT 3.2.5 Controlling Exposure Start with an ExTrig Signal An external trigger (ExTrig) input signal can be used to control the start of exposure. A rising edge or a falling edge of the signal can be used to trigger exposure start. The Trigger Mode control register (see page 4-24) is used to enable ExTrig exposure start control, to select rising or falling edge triggering, and to assign a physical input port to receive the ExTrig signal.
DRAFT Basic Operation & Standard Features Level Controlled Exposure Mode When level controlled mode is selected, the length of the exposure will be determined by the ExTrig signal alone. If the camera is set for rising edge triggering, exposure begins when the ExTrig signal rises and continues until the ExTrig signal falls. If the camera is set for falling edge triggering, exposure begins when the ExTrig signal falls and continues until the ExTrig signal rises.
Basic Operation & Standard Features DRAFT The ExTrig signal must be used in combination with a one-shot or a continuous-shot command. If more precise control of exposure start time is desired, you must also monitor the Trigger Ready signal and you must base the timing of the ExTrig signal on the state of the Trigger Ready signal. (See Section 3.2.
DRAFT Basic Operation & Standard Features L These explanations of exposure start are included to give the user a basic insight into the interactions of the camera’s registers. Typically, IEEE 1394 cameras are used with a driver which includes an interface that allows the user to parameterize and operate the camera without directly setting registers. The Basler BCAM 1394 Camera Driver, for example, has both a simple Windows® interface and a programmer’s API for parameterizing and operating the camera.
Basic Operation & Standard Features DRAFT 3.2.6 Recommended Method for Controlling Exposure Start L The camera can be programmed to begin exposure on a rising edge or on a falling edge of an ExTrig signal. Also, two modes of exposure control are available: programmable and level controlled (see Section 3.2.5). For this illustration, we are assuming that a rising edge trigger and the programmable exposure mode are used.
DRAFT Basic Operation & Standard Features Figure 3-6: Exposure Start Controlled with an ExTrig Signal You can calculate the frame readout time with this formula: Frame Readout Time = ( AOI Height x 51.2281 µs ) + 9941.0 µs You can calculate the frame transmission time with this formula: Frame Transmission Time = Packets/frame x 125 µs To calculate the transmission start delay, use this information: If the transmission time is greater than the readout time: Transmission Start Delay = 125 µs.
Basic Operation & Standard Features DRAFT 3.3 Trigger Ready Signal L The trigger ready signal is not defined in the 1394 Trade Association Digital Camera Specification. Trigger ready is a patented feature of Basler cameras that allows our cameras to have optimized timings. The maximum frame rate for the camera can be limited by any one of three factors: • The amount of time it takes to read out a captured image from the CCD sensor to the frame buffer.
DRAFT Basic Operation & Standard Features 3.4 Integrate Enabled Signal The Integrate Enabled (IntEn) signal goes high when exposure begins and goes low when exposure ends. This signal can be used as a flash trigger and is also useful when you are operating a system where either the camera or the object being imaged is movable. For example, assume that the camera is mounted on an arm mechanism and that the mechanism can move the camera to view different portions of a product assembly.
Basic Operation & Standard Features DRAFT 3.5 Gain and Brightness The major components in the A102f electronics include: a CCD sensor, one VGC (Variable Gain Control), and one ADC (Analog to Digital Converter). The pixels in the CCD sensor output voltage signals when they are exposed to light. These voltages are amplified by the VGC and transferred to the ADC which converts the voltages to digital output signals. Two parameters, gain and offset are associated with the VGC.
DRAFT Basic Operation & Standard Features 3.5.1 Setting Gain When the gain is set to default, the sensor’s linear output range directly matches the input voltage range of the ADC. Thus, with the default gain of 0 dB, a gray value of 1 is produced when the pixels are exposed to no light and a gray value of 255 (in modes that output 8 bits per pixel) or 4095 (in modes that output 12 effective bits per pixel) is produced when the pixels are exposed to bright light.
DRAFT Basic Operation & Standard Features The gain settings result in the following amplifications: Decimal Number (DN) Hexadecimal dB Factor 192 0x0C0 0 X1 374 0x176 6 X2 499 0x1F3 12 X4 656 0x290 18 X8 825 0x339 24 X16 1023 0x3FF 31 X35.5 Table 3-1: Examples of Gain Settings in dB 3.5.2 Setting Brightness The camera’s brightness is determined by the setting in the Value field of the Brightness control register (see page 4-20).
DRAFT Basic Operation & Standard Features 3.6 Area of Interest (AOI) The area of interest (AOI) feature allows you to specify a portion of the CCD array and during operation, only the pixel information from the specified portion of the array is transmitted out of the camera. The area of interest is referenced to the top left corner of the CCD array. The top left corner is designated as column 0 and row 0 as shown in Figure 3-10.
Basic Operation & Standard Features DRAFT To use the entire CCD array in the A102fc color cameras, set the value for Left to 0, the value for Top to 0, the value for Width to 1388 and the value for Height to 1038. L The sum of the setting for Left plus the setting for Width must not exceed 1392 for A102f monochrome cameras or 1388 for A102fc color cameras. The sum of the setting for Top plus the setting for Height must not exceed 1040 for A102f monochrome cameras or 1038 for A102fc color cameras.
DRAFT Basic Operation & Standard Features 3.6.2 Changes to the Frame Rate with AOI In general, the maximum frame rate for the camera increases as the size of the AOI decreases. However, the maximum frame rate can also be limited by any one of three factors: • The amount of time it takes to read out a captured image from the image sensor to the frame buffer. • The amount of time it takes to transmit an image from the frame buffer to the PC via the IEEE 1394 bus. • The exposure time setting.
Basic Operation & Standard Features DRAFT Example Assume that your camera is set for Format 7, Mode 0, that your AOI is set for 100 columns wide and 110 rows high and that your exposure time is set for 12000 µs. Also assume that after making all camera settings, you check the Packets Per Frame Inquiry register in the control and status registers for Format 7, Mode 0. You find that the packets per frame with the current settings is 3.
DRAFT Basic Operation & Standard Features 3.7 Low Smear In applications where a CCD sensor is under constant illumination, highcontrast images may show an unwanted effect that converts dark pixels into brighter ones. This effect is commonly called “smearing“. With the help of the Low Smear feature on the A102f, smearing is reduced in the upper part of the image. The effect of the Low Smear feature is illustrated in Figure 3-11. The left image was captured without the low smear feature.
Basic Operation & Standard Features DRAFT For example, with a 1392 (H) x 600 (V) area of interest, the calculation looks like this: Frames/s ≤ ( 600 x 51.2281 µs ) + 16879.0 µs Frames/s ≤ 21.0 If the camera’s actual frame rate is higher than the maximum recommended frame rate, the smearing will return. When you exceed the maximum recommended frame rate by a small amount, the upper part of the image will show partial smearing (Figure 3-12). As the frame rate is increased, the smearing will become worse.
DRAFT Basic Operation & Standard Features 3.8 Color Creation in the A102fc The CCD sensor used in the A102fc is equipped with an additive color separation filter known as a Bayer filter. With the Bayer filter, each individual pixel is covered by a micro-lens which allows light of only one color to strike the pixel. The pattern of the Bayer filter used in the A102fc is shown in Figure 3-13.
Basic Operation & Standard Features DRAFT Once the conversion to YUV is complete, pixels are transmitted from the camera in the YUV (4:2:2) format as defined in Sections 5.3 and 5.4. L The values for U and for V normally range from -128 to +127. Because the 1394 Digital Camera specification requires that U values and V values be transmitted with unsigned integers, 128 is added to each U value and to each V value before the values are transmitted from the camera.
DRAFT L Basic Operation & Standard Features The actual range of valid settings for the Blue Value is from 16 (0x10) to 255 (0xFF), however, only the settings from 64 (0x40) to 255 (0xFF) are useful. If you set the Blue Value lower than 64 (0x40), the camera will continue to operate, but you will see unacceptable changes in the color balance. The actual range of valid settings for the Red Value is from 16 (0x10) to 255 (0xFF), however, only the settings from 64 (0x40) to 255 (0xFF) are useful.
Basic Operation & Standard Features DRAFT 3.8.3 Integrated IR Cut Filter on C-Mount Equipped Cameras A102fc color cameras are equipped with an IR cut filter as standard equipment. The filter is mounted in the lens adapter. Cameras without an IR cut filter are available on request. Caution! The location of the filter limits the thread length of the lens that can be used on the camera. The thread length on your lens must be less than 7.5 mm.
DRAFT Basic Operation & Standard Features 3.9 Selectable 8 or 12 Bit Pixel Depth When an A102f camera is operating in Format 7, it can be set to output pixel data at either 8 bit or 12 bit depth. 3.9.1 A102f Monochrome Cameras Set the value in the Format field of the Current Video Format register (see page 4-16) and the value in the Mode Field of the Current Video Mode register (see page 4-15) so that the camera will operate in Format 7, Mode 0.
Basic Operation & Standard Features DRAFT 3.10 Strobe Control Output Signals A102f cameras include a feature designed to help you control strobe lighting. The feature allows a user to enable and parameterize up to four strobe control output signals. The signals are designated as Strobe 0, Strobe 1, Strobe 2, and Strobe 3. The Strobe Signal Function control registers (see page 4-42) are used to enable and parameterize the strobe output signals.
DRAFT Basic Operation & Standard Features Setting the Duration for Strobe 0 The strobe duration is determined by a combination of two values. The first is the setting in the Duration Value field of the Strobe 0 Control register (see page 4-22). The second is the Strobe Duration Time Base. Strobe 0 duration will be determined by the product of these two values: Strobe 0 Duration = (Strobe 0 Duration Value Setting) x (Strobe Duration Time Base) The strobe duration time base is fixed at 1/1024 ms by default.
Basic Operation & Standard Features DRAFT 3.11 Parallel Input/Output Control A parallel I/O control feature is available on A102f cameras. The feature allows a user to set the state of the four physical output ports on the camera and to read the state of the four physical input ports. To set state of the four physical output ports, write values to the fields in the PIO Output register (see page 4-41): • The value in the Port 0 Out field sets the state of physical output port 0.
DRAFT Basic Operation & Standard Features 3.12 Available Video Formats, Modes and Frame Rates on Monochrome Cameras 3.12.1 Standard Formats, Modes and Frame Rates The following standard video formats, modes and frame rates are available on all A102f monochrome cameras: Format 2, Mode 2, FrameRate 3 ( 1280 x 960, Y Mono, 8 bits/pixel, 15 fps ) Format 2, Mode 6, FrameRate 2 ( 1280 x 960, Y Mono, 16 bits/pixel, 7.
Basic Operation & Standard Features DRAFT Keep in mind that when you lower the bytes per packet setting, the number of bytes needed to transmit a frame (the packets per frame) will increase. Due to limitations in the DCAM structure, a maximum of 4095 packets per frame is allowed. If you set the bytes per packet too low, the number of packets per frame will exceed the 4095 packet limit and the camera will not transmit frames properly.
DRAFT Basic Operation & Standard Features 3.13 Available Video Formats, Modes and Frame Rates on Color Cameras 3.13.1 Standard Formats, Modes and Frame Rates The following standard video formats, modes and frame rates are available on A102fc color cameras: Format 2, Mode 0, FrameRate 2 ( 1280 x 960, YUV 4:2:2, 16 bits/pixel ave, 7.
Basic Operation & Standard Features DRAFT Color Codlings In Format 7, Mode 0, the Mono 8, Raw 8, Raw 16, and YUV 4:2:2 color codlings are available. When the Mono 8 ID is set in the Coding ID field of the Color Coding ID register for Format 7, Mode 0, the camera outputs 8 bits per pixel and outputs only the Y component (brightness) of the YUV format.
DRAFT Basic Operation & Standard Features 3.14 Error Flags A102f cameras support the following error flags: • Error flags that indicate whether the current trigger, shutter, gain, brightness, and white balance settings are outside the specified range of allowed values. These error flags are set in the Trigger, Shutter, Gain, Brightness and White Balance fields of the Feature Control Error Status High register (see page 4-25).
Basic Operation & Standard Features DRAFT 3.15 Configuration Sets and Memory Channels A configuration set is a group of values that contains all of the register settings needed to control the camera. There are two basic types of configuration sets: the work configuration set and the factory configuration set. Work Configuration Set The work configuration set contains the camera’s current register settings and thus determines the camera’s performance, that is, what your image currently looks like.
DRAFT Basic Operation & Standard Features 3.15.2 Copying a Saved Configuration Set or the Factory Set into the Work Set If you have saved one or more configuration sets to memory channels in the camera as described in Section 3.15.1, you can copy one of the saved sets from a memory channel into the camera’s work set. When you do this, the copied set overwrites the parameters in the work set.
Basic Operation & Standard Features 3-40 DRAFT BASLER A102f
DRAFT Configuring the Camera 4 Configuring the Camera A102f cameras are configured by setting status and control registers as described in the “1394Based Digital Camera Specification” issued by the 1394 Trade Association. The specification is commonly referred to as the “DCAM standard” or the “IIDC” standard.” It is available at the 1394 Trade Association’s web site: www.1394ta.org. Except where noted, all registers conform to version 1.31 of the DCAM standard.
Configuring the Camera DRAFT 4.1 Block Read and Write Capabilities The camera supports block reads and block writes. If you do a single read or a block read, the camera will return a 0 for all non-existent registers. If you do a single write to a non-existent register or a block write that includes non-existent registers, the writes to non-existent registers will have no effect on camera operation. Block reads or writes are limited to a payload of 32 quadlets. 4.
DRAFT Configuring the Camera 4.4 Implemented Standard Registers This section includes a description of all DCAM standard registers implemented in the A102f. 4.4.1 Inquiry Registers The base address for all inquiry registers is: Bus ID, Node ID, FFFF F0F0 0000 In each inquiry register description, an “Offset from Base Address” is provided. This a byte offset from the above base address. The address of an inquiry register equals the above base address plus the indicated offset.
DRAFT Configuring the Camera 4.4.1.3 Inquiry Registers for Video Modes Each bit in the video mode inquiry register indicates the availability of a specific video format and mode combination (e.g., Format 0, Mode 0).
DRAFT Configuring the Camera 4.4.1.4 Inquiry Registers for Video Frame Rates Each bit in the video frame rates inquiry register indicates the availability of a specific video format, mode, frame rate combination (e.g., Format 0, Mode 0, Frame Rate 0). 0 = format not available 1 = format available Register Name: Video Frame Rate Inquiry for Format 2, Mode 0 Offset from Base Address: 0x240 Field Bit Description A102f Value A102fc Value Frame Rate 0 0 1.
DRAFT Configuring the Camera Register Name: Video Frame Rate Inquiry for Format 2, Mode 6 Offset from Base Address: 0x258 Field Bit Description A102f Value A102fc Value Frame Rate 0 0 1.875 fps standard frame rate 0 0 Frame Rate 1 1 3.75 fps standard frame rate 0 0 Frame Rate 2 2 7.
DRAFT Configuring the Camera 4.4.1.6 Inquiry Register for Basic Functions Each bit in the basic function inquiry register indicates the availability of a specific basic function. 0 = function not available 1 = function available (The memory channel bits are an exception. Refer to the description below.
DRAFT Configuring the Camera 4.4.1.7 Inquiry Register for Feature Presence Each bit in the feature presence inquiry registers indicates the availability of a camera feature or optional function. Note that changing the video format or video mode may change the availability of a feature.
DRAFT Configuring the Camera Register Name: Feature Low Inquiry Offset from Base Address: 0x408 Field Bit Description A102f Value A102fc Value Zoom 0 Zoom control availability 0 0 Pan 1 Pan control availability 0 0 Tilt 2 Tilt control availability 0 0 Optical Filter 3 Optical filter control availability 0 0 --- 4 ... 15 Reserved --- --- Capture Size 16 Format 6 capture size availability 0 0 Capture Quality 17 Format 6 capture quality availability 0 0 --- 18 ...
DRAFT Configuring the Camera Register Name: PIO Control CSR Inquiry Offset from Base Address: 0x484 Field Bit Description PIO Control Quadlet Offset 0 ... 31 Indicates the quadlet offset from the base address of the initial register space for the PIO Control and Status Registers (CSR). The A102f and A102fc support PIO control. Register Name: Strobe Output CSR Inquiry Offset from Base Address: 0x48C Field Bit Description Strobe Output Quadlet Offset 0 ...
DRAFT Configuring the Camera 4.4.1.8 Inquiry Registers for Feature Elements The feature element inquiry registers indicates the availability of elements, modes, maximum and minimum values for features. Note that changing the video format or video mode may change the availability of a feature element.
DRAFT Configuring the Camera Register Name: Shutter Inquiry Offset from Base Address: 0x51C Field Bit Description A102f Value A102fc Value Presence Inq 0 Shutter control feature is present 1 1 Abs Control Inq 1 Shutter can be set with an absolute value 0 0 --- 2 Reserved --- --- One Push Inq 3 One push auto mode is present 0 0 Read Out Inq 4 The shutter value can be read 1 1 On/Off Inq 5 Shutter control can be switched on/off 0 0 Auto Inq 6 A shutter auto control m
DRAFT Configuring the Camera Register Name: Gain Inquiry Offset from Base Address: 0x520 Field Bit Description A102f Value A102fc Value Presence Inq 0 Gain control feature is present 1 1 Abs Control Inq 1 Gain can be set with an absolute value 0 0 --- 2 Reserved --- --- One Push Inq 3 One push auto mode is present 0 0 Read Out Inq 4 The gain value can be read 1 1 On/Off Inq 5 Gain control can be switched on/off 0 0 Auto Inq 6 A gain auto control mode is present 0
DRAFT Configuring the Camera 4-14 Register Name: Trigger Inquiry Offset from Base Address: 0x530 Field Bit Description A102f Value A102fc Value Presence Inq 0 Trigger control feature is present 1 1 Abs Control Inq 1 Trigger can be set with an absolute value 0 0 --- 2 ...
DRAFT Configuring the Camera 4.4.2 Control and Status Registers The base address for all camera control and status registers is: Bus ID, Node ID, FFFF F0F0 0000 In each control and status register description, an “Offset from the Base Address” is provided. This a byte offset from the above base address. The address of a control and status register equals the above base address plus the indicated offset. Values are stated in decimal format except when marked 0x. Values marked as 0x (e.g.
DRAFT Configuring the Camera Register Name: Current Video Format Offset from Base Address: 0x608 Field Bit Description Format 0 ... 2 This field sets the current video format. 0 = format 0 1 = format 1 2 = format 2 6 = format 6 7 = format 7 Default = 7 on the A102f and A102fc Check Sections 3.12 and 3.13 to determine the video formats supported on the A102f and A102fc. --- 3 ... 31 Reserved Register Name: ISO Offset from Base Address: 0x60C Field Bit Description ISO Channel L 0 ...
DRAFT Configuring the Camera Register Name: ISO EN / Continuous Shot Offset from Base Address: 0x614 Field Bit Description Continuous Shot 0 When the camera is set for video Format 2 or Format 7, this field controls the “continuous shot” video transmission mode. 1 = start “continuous shot” transmission 0 = stop “continuous shot” transmission Default = 0 on the A102f and A102fc --- 1 ...
DRAFT Configuring the Camera Register Name: Memory Save Channel Offset from Base Address: 0x620 Field Bit Description Save Channel 0 ... 3 When a 1 is written to the Memory Save register (see page 4-17), the current settings in the work configuration set (see Section 3.15) will be saved to the memory channel specified in this register. The valid values for this register are 1, 2 and 3. --- 4 ...
DRAFT Configuring the Camera Register Name: Software Trigger Offset from Base Address: 0x62C Field Bit Description Trigger 0 When the Trigger Source field of the Trigger Mode register (see page 4-24) is set for a software trigger, this field controls the software trigger. 0 = reset the software trigger 1 = set the software trigger (If the Trigger Mode field of the Trigger Mode register is set to 0, this field will self clear.) --- 1 ...
DRAFT Configuring the Camera 4.4.2.2 Control and Status Registers for Features Register Name: Brightness Offset from Base Address: 0x800 Field Bit Description Presence Inq 0 Indicates the presence of the brightness control feature. The value will be 1 on A102f and A102fc cameras, indicating that brightness control is available. This field is read only.
DRAFT Configuring the Camera Register Name: White Balance Offset from Base Address: 0x80C Field Bit Description Presence Inq 0 Indicates the presence of the white balance control feature. The value will be 0 on A102f cameras, indicating that white balance control is not available. The value will be 1on A102fc cameras, indicating that white balance control is available. This field is read only.
DRAFT Configuring the Camera Register Name: Shutter Offset from Base Address: 0x81C Field Bit Description Presence Inq 0 Indicates the presence of the shutter control feature. The value will be 1on A102f and A102fc cameras, indicating that shutter control is available. This field is read only. Abs Control 1 Determines whether the shutter will be controlled by the Value field of this register or by the Absolute Value CSR for the shutter.
DRAFT Configuring the Camera Register Name: Gain Offset from Base Address: 0x820 Field Bit Description Presence Inq 0 Indicates the presence of the gain control feature. The value will be 1on A102f and A102fc cameras, indicating that gain control is available. This field is read only. Abs Control 1 Determines whether the gain will be controlled by the Value field of this register or by the Absolute Value CSR for gain.
DRAFT Configuring the Camera Register Name: Trigger Mode Offset from Base Address: 0x830 Field Bit Description Presence Inq 0 Indicates the presence of the trigger mode control feature. The value will be 1on A102f and A102fc cameras, indicating that trigger mode control is available. This field is read only. Abs Control 1 Determines whether the trigger mode will be controlled by the Value field of this register or by the Absolute Value CSR for the trigger mode.
DRAFT Configuring the Camera 4.4.2.3 Error Status Registers for Feature Control As defined in the IIDC specification, each field in this register is an error or warning flag for the corresponding feature control register. If a bit = 1, the mode and/or value of the corresponding feature control register has an error or warning. If a bit = 0, no error or warning is present. Each field in this register will be updated whenever the corresponding feature control register is updated.
DRAFT Configuring the Camera Field Bit Description Trigger 12 Indicates a trigger mode control error on the A102f or A102fc. 0 = no error present 1 = A setting in the trigger mode control register (see page 4-24) is outside of the allowed range This field is read only. 4-26 Trigger Delay 13 Not used on the A102f or A102fc. This bit should be ignored. White Shading 14 Not used on the A102f or A102fc. This bit should be ignored. Frame Rate 15 Not used on the A102f or A102fc.
DRAFT Configuring the Camera 4.4.2.4 Control and Status Registers for Format 7, Mode 0 Format 7, Mode 0 is available on A102f and A102fc cameras. The base address for each Format 7, Mode 0 camera control register is: Bus ID, Node ID, FFFF F1F0 0000 In each Format 7, Mode 0 register description, an “Offset from the Base Address” is provided. This is a byte offset from the above base address. The address of a Format 7, Mode 0 register equals the above base address plus the indicated offset.
DRAFT Configuring the Camera Register Name: Image Position Offset from Base Address: 0x008 Field Name: Bit Description Left 0 ... 15 Sets the left (starting) column of pixels for the area of interest (see Section 3.6). Default = 0 on the A102f and A102fc Top 16 ... 31 Sets the top row of pixels for the area of interest (see Section 3.6). Default = 0 on the A102f and A102fc Register Name: Image Size Offset from Base Address: 0x00C Field Bit Description Width 0 ...
DRAFT Configuring the Camera Register Name: Color Coding Inquiry Offset from Base Address: 0x014 Field Name: Bit Description A102f Value * A102fc Value * Mono 8 0 Y only, 8 bits, non-compressed (ID = 0) 1 1 4:1:1 YUV8 1 4:4:1 YUV, 8 bits/component, non-compressed (ID = 1) 0 0 4:2:2 YUV 8 2 4:2:2 YUV, 8 bits/component, non-compressed (ID = 2) 0 1 4:4:4 YUV 8 3 4:4:4 YUV, 8 bits/component , non-compressed (ID = 3) 0 0 RGB 8 4 RGB, 8 bits/component, non-compressed (ID = 4) 0
DRAFT Configuring the Camera Register Name: Pixel Number Inquiry Offset from Base Address: 0x034 Field Bit Description Pixels Per Frame 0 ... 31 Indicates the total number of pixels per frame. The value in this register depends on settings in the Format 7, Mode 0 Image Size register (see page 4-28). Register Name: Total Bytes High Inquiry Offset from Base Address: 0x038 Field Bit Description Bytes Per Frame High 0 ...
DRAFT Configuring the Camera Register Name: Bytes Per Packet Offset from Base Address: 0x044 Field Bit Description Bytes Per Packet 0 ... 15 Sets the number of bytes per packet (the packet size). Note: When you lower the bytes per packet setting, the number of packets needed to transmit a frame (the packets per frame) will increase. Due to limitations in the DCAM structure, a maximum of 4095 packets per frame is allowed.
DRAFT Configuring the Camera Register Name: Frame Interval Inquiry Offset from Base Address: 0x050 Field Bit Description Frame Interval 0 ... 31 Indicates the current frame period in seconds. This value will be updated when you adjust any register that affects the frame period. The value in this register is a standard IEEE-754 single precision (32 bit) floating point number. Register Name: Data Depth Inquiry Offset from Base Address: 0x054 Field Bit Description Data Depth 0 ...
DRAFT Configuring the Camera Register Name: Value Setting Offset from Base Address: 0x07C Field Bit Description Presence Inq 0 Indicates whether the fields in this register are valid. 0 = not valid 1 = valid The fields in this register are valid on the A102f and A102fc. The Presence Inq field is read only. Setting 1 1 On the A102f and A102fc, this field is not relevant and should be ignored. (Updates to the register values monitored by this field are performed automatically.) --- 2 ...
DRAFT Configuring the Camera 4.4.2.5 Control and Status Registers for Format 7, Mode 1 Format 7, Mode 0 is available on A102fc cameras only. The base address for each Format 7, Mode 1 camera control register is: Bus ID, Node ID, FFFF F1F0 0100 In each Format 7, Mode 0 register description, an “Offset from the Base Address” is provided. This is a byte offset from the above base address. The address of a Format 7, Mode 1 register equals the above base address plus the indicated offset.
DRAFT Configuring the Camera Register Name: Image Position Offset from Base Address: 0x008 Field Name: Bit Description Left 0 ... 15 Sets the left (starting) column of pixels for the area of interest (see Section 3.6). Default = 0 Top 16 ... 31 Sets the top row of pixels for the area of interest (see Section 3.6). Default = 0 Register Name: Image Size Offset from Base Address: 0x00C Field Bit Description Width 0 ...
DRAFT Configuring the Camera Register Name: Color Coding Inquiry Offset from Base Address: 0x014 Field Name: Bit Description Mono 8 0 8 bit raw value, non-compressed A102fc Value * (ID = 0) 1 This is a non-standard definition. When set to this color coding ID in Format 7 Mode 1, an A102fc will output the raw value for each pixel. The pixel data is not processed in any way to account for the color filter on the sensor. (This type of output is sometimes called “Bayer 8.
DRAFT Configuring the Camera Register Name: Pixel Number Inquiry Offset from Base Address: 0x034 Field Bit Description Pixels Per Frame 0 ... 31 Indicates the total number of pixels per frame. The value in this register depends on settings in the Format 7, Mode 1 Image Size register (see page 4-35). Register Name: Total Bytes High Inquiry Offset from Base Address: 0x038 Field Bit Description Bytes Per Frame High 0 ...
DRAFT Configuring the Camera Register Name: Bytes Per Packet Offset from Base Address: 0x044 Field Bit Description Bytes Per Packet 0 ... 15 Sets the number of bytes per packet (the packet size). Note: When you lower the bytes per packet setting, the number of packets needed to transmit a frame (the packets per frame) will increase. Due to limitations in the DCAM structure, a maximum of 4095 packets per frame is allowed.
DRAFT Configuring the Camera Register Name: Frame Interval Inquiry Offset from Base Address: 0x050 Field Bit Description Frame Interval 0 ... 31 Indicates the current frame period in seconds. This value will be updated when you adjust any register that affects the frame period. The value in this register is a standard IEEE-754 single precision (32 bit) floating point number. Register Name: Data Depth Inquiry Offset from Base Address: 0x054 Field Bit Description Data Depth 0 ...
DRAFT Configuring the Camera Register Name: Value Setting Offset from Base Address: 0x07C Field Bit Description Presence Inq 0 Indicates whether the fields in this register are valid. 0 = not valid 1 = valid The fields in this register are valid on the A102fc. The Presence Inq field is read only. Setting 1 1 This field is not relevant and should be ignored. (Updates to the register values monitored by this field are performed automatically.) --- 2 ...
DRAFT Configuring the Camera 4.4.2.6 Control and Status Registers for the PIO Control Function The base address for the PIO Control Function control and status registers is: Bus ID, Node ID, FFFF F2F0 00C8 In each PIO register description, an “Offset the from Base Address” is provided. This a byte offset from the above base address. The address of a PIO register equals the above base address plus the indicated offset. Values are stated in decimal format except when marked 0x. Values marked as 0x (e.g.
DRAFT Configuring the Camera 4.4.2.7 Control and Status Registers for the Strobe Signal Function The base address for the Strobe Signal control and status registers is: Bus ID, Node ID, FFFF F2F0 0300 In each Strobe Signal register description, an “Offset from the Base Address” is provided. This a byte offset from the above base address. The address of a strobe signal register equals the above base address plus the indicated offset. Values are stated in decimal format except when marked 0x.
DRAFT Register Name: Strobe 1 Inquiry Offset from Base Address: 0x104 Field Description Bit Configuring the Camera A102f Value A102fc Value A102f Value A102fc Value A102f Value A102fc Value Same definitions and values as Strobe 0 Inq Register Name: Strobe 2 Inquiry Offset from Base Address: 0x108 Field Description Bit Same definitions and values as Strobe 0 Inq Register Name: Strobe 3 Inquiry Offset from Base Address: 0x10C Field Description Bit Same definitions and values as S
DRAFT Configuring the Camera Register Name: Strobe 0 Control Offset from Base Address: 0x200 Field Bit Description Presence Inq 0 Indicates the presence of the Strobe 0 signal control feature. 0 = not available 1 = available The Strobe 0 control feature is available on the A102f and A102fc. This field is read only. --- 1 ... 5 Reserved On / Off 6 Sets whether the Strobe 0 signal is on or off.
DRAFT Register Name: Strobe 2 Control Offset from Base Address: 0x208 Field Description Bit Configuring the Camera Same definitions and values as Strobe 0 Control. Register Name: Strobe 3 Control Offset from Base Address: 0x20C Field Description Bit Same definitions and values as Strobe 0 Control. L If a strobe signal is on, the signal will only be present on the associated output port if the output port is configured for “strobe.
DRAFT Configuring the Camera 4.4.3 Advanced Features Registers The base address for all advanced features registers is: Bus ID, Node ID, FFFF F2F0 0000 The first eight quadlets of the advanced features register space is designated as the advanced features “Access Control Register” as described in the table below. Values are stated in decimal format except when marked 0x. Values marked as 0x (e.g., 0x123) are in hexadecimal format. Bit 0 in each register is the most significant bit.
DRAFT Image Data Formats & Structures 5 Image Data Formats and Structures 5.1 Image Data Basics Image data is transmitted as isochronous data packets according to the “1394 - based Digital Camera Specification” (DCAM) issued by the 1394 Trade Association (see the trade association’s web site: www.1394ta.org). The first packet of each frame is identified by a 1 in the sync bit of the packet header. 5.1.
DRAFT Image Data Formats & Structures 5.2 Packet Payload Charts for Standard Format, Mode and Frame Rate Combinations on A102f Cameras The following charts describe the packet payload for each standard format/mode/framerate combination available on the A102f or the A102fc. This information is especially useful when calculating a camera’s bandwidth usage. 5.2.1 Format 2, Mode 0 ( 1280 x 960, YUV 4:2:2, 16 bits/pixel avg ) Frame Rate 7.
DRAFT Image Data Formats & Structures 5.3 Image Data Formats 5.3.1 Data Format with the Camera Set for YUV 4:2:2 Output The table below describes how the data for a received frame will be ordered in the image buffer in your PC.
Image Data Formats & Structures DRAFT 5.3.2 Data Format with the Camera Set for Y Mono 8 Output The table below describes how the data for a received frame will be ordered in the image buffer in your PC.
DRAFT Image Data Formats & Structures 5.3.3 Data Format with the Camera Set for Y Mono 16 Output The table below describes how the data for a received frame will be ordered in the image buffer in your PC.
Image Data Formats & Structures DRAFT 5.3.4 Data Format with the Camera Set for Raw 8 Output The tables below describe how the data for the odd lines and for the even lines of a received frame will be ordered in the image buffer in your PC.
DRAFT Image Data Formats & Structures For Filter ID = 1 (GB / RG) Even Lines Byte Data Green value for P0 B0 Odd Lines Byte B0 Data Red value for P0 B1 Blue value for P1 B1 Green value for P1 B2 Green value for P2 B2 Red value for P2 B3 Blue value for P3 B3 Green value for P3 B4 Green value for P4 B4 Red value for P4 B5 Blue value for P5 B5 Green value for P5 • • • • • • • • • • • • Bm-5 Green value for Pn-5 Bm-5 Red value for Pn-5 Bm-4 Blue value for Pn-4 Bm-4 Green val
Image Data Formats & Structures DRAFT For Filter ID = 3 (BG / GR) 5-8 Even Lines Byte Data Blue value for P0 B0 Odd Lines Byte B0 Data Green value for P0 B1 Green value for P1 B1 Red value for P1 B2 Blue value for P2 B2 Green value for P2 B3 Green value for P3 B3 Red value for P3 B4 Blue value for P4 B4 Green value for P4 B5 Green value for P5 B5 Red value for P5 • • • • • • • • • • • • Bm-5 Blue value for Pn-5 Bm-5 Green value for Pn-5 Bm-4 Green value for Pn-4 Bm-4 Re
DRAFT Image Data Formats & Structures 5.3.5 Data Format with the Camera Set for Raw 16 Output The tables below describe how the data for the odd lines and for the even lines of a received frame will be ordered in the image buffer in your PC.
Image Data Formats & Structures DRAFT For Filter ID = 1 (GB / RG) 5-10 Even Lines Byte Data Low byte of green value for P0 B0 Odd Lines Byte Data B0 Low byte of red value for P0 B1 High byte of green value for P0 B1 High byte of red value for P0 B2 Low byte of blue value for P1 B2 Low byte of green value for P1 B3 High byte of blue value for P1 B3 High byte of green value for P1 B4 Low byte of green value for P2 B4 Low byte of red value for P2 B5 High byte of green value for P2 B5 H
DRAFT Image Data Formats & Structures For Filter ID = 2 (GR / BG) Even Lines Byte Data Low byte of green value for P0 B0 Odd Lines Byte Data B0 Low byte of blue value for P0 B1 High byte of green value for P0 B1 High byte of blue value for P0 B2 Low byte of red value for P1 B2 Low byte of green value for P1 B3 High byte of red value for P1 B3 High byte of green value for P1 B4 Low byte of green value for P2 B4 Low byte of blue value for P2 B5 High byte of green value for P2 B5 High b
Image Data Formats & Structures DRAFT For Filter ID = 3 (BG / GR) Even Lines Byte Data Low byte of blue value for P0 B0 Odd Lines Byte B0 Data Low byte of green value for P0 B1 High byte of blue value for P0 B1 High byte of green value for P0 B2 Low byte of green value for P1 B2 Low byte of red value for P1 B3 High byte of green value for P1 B3 High byte of red value for P1 B4 Low byte of blue value for P2 B4 Low byte of green value for P2 B5 High byte of blue value for P2 B5 High b
DRAFT Image Data Formats & Structures 5.4 Image Data Structure 5.4.1 Data Structure for a Y (Mono 8) or an R, G or B (Raw 8) Component The data output for a Y (mono 8) component or an R, G or B (raw 8) component is 8 bit data of the “unsigned char” type. The range of data values for a Y mono component and the corresponding indicated signal levels are shown below. This Data Value (Hexadecimal) 0xFF 0xFE Indicates This Signal Level (Decimal) 255 254 • • • • • • 0x01 0x00 1 0 5.4.
DRAFT Image Data Formats & Structures 5.4.3 Data Structure for a Y (Mono 16) or an R, G or B (Raw 16) Component The data output for a Y (mono 16) component or an R, G or B (Raw 16) component is 16 bit data of the “unsigned short (little endian)” type. The range of data values for a Y mono component and the corresponding indicated signal levels are shown below.
DRAFT Smart Features 6 Smart Features and the Smart Features Framework 6.1 What are Smart Features Smart features are features unique to Basler cameras. Test Images, the Cycle Time Stamp, and the CRC Checksum are examples of Basler smart features. In some cases, enabling a smart feature will simply change the behavior of the camera. The Test Image feature is a good example of this type of smart feature. When the Test Image feature is enabled, the camera outputs a test image rather than a captured image.
DRAFT Smart Features part of the added data. The GUIDs are especially useful when you enable several smart features that add data to the image stream. The GUIDs make it possible to identify which portion of the added data is the result of each enabled smart feature. Refer to Sections 6.6 and 6.7 for detailed information about getting smart features results. 6.3 What do I Need to Use Smart Features To use smart features you will need: • A camera that supports smart features.
DRAFT Smart Features 6.5 Enabling and Parameterizing Smart Features The camera provides a control and status register (CSR) for each smart feature (see Sect 6.7 for details of each feature and its CSR). To enable and parameterize a smart feature, the following steps must be performed: 1. Check to see if the camera supports smart features. 2. Ask the camera for the address of the CSR for the desired smart feature. 3. Enable and parameterize the desired smart features.
DRAFT Smart Features 6.5.2 Determining the Address of a Smart Feature’s CSR The control and status register (CSR) for each smart feature is identified by a 128 bit Globally Unique Identifier (GUID). GUIDs are also known as UUIDs (Universal Unique Identifier). A GUID consists of: • One 32 bit number (D1) • Two 16 bit numbers (D2, D3) • A sequence of 8 bytes (D4[0] - D4[7]) GUID example: CA8A916A (D1) - 14A4 - (D2) 4D8E - BBC9 - (D3) (D4[0] - D4[1]) 93DF50495C16 (D4[2] - D4[7]) Section 6.
DRAFT Smart Features Example Determine the address of the “CRC Checksum” smart feature which has a CSR GUID of: 3B34004E - 1B84 - 11D8 - 83B3 - 00105A5BAE55 D1: 0x3B34 004E D2: 0x1B84 D3: 0x11D8 D4[0]: 0x83 D4[1]: 0xB3 D4[2]: 0x00 D4[3]: 0x10 D4[4]: 0x5A D4[5]: 0x5B D4[6]: 0xAE D4[7]: 0x55 Step 1: Write the CSR GUID to the Smart Features Inquiry Register Assuming that the address for the Access Control Register is 0xFFFF F2F0 0000, perform the following quadlet write operations to th
Smart Features DRAFT 6.5.3 Enabling and Parameterizing a Smart Feature Once you have determined the starting address of the control and status register (CSR) for your desired smart feature, you are ready to enable and parameterize the feature by setting bits within the CSR. Section 6.7 describes the standard smart features available on A102f cameras. Each smart features description includes an explanation of what the feature does and an explanation of the parameters associated with the feature.
DRAFT Smart Features 6.6 Getting Smart Features Results In many cases, activating a smart feature results in additional data that must be transmitted by the camera, i.e., the results of the smart feature. The results of a smart feature will be appended to the image data so that each frame contains both image data and smart features results. Before using any of the smart features that add information to the image data, the extended data stream feature must be enabled.
Smart Features DRAFT There are different types of chunks, for example, the chunk that is added when the cycle time stamp smart feature is enabled and the chunk that is added when the frame counter smart feature is enabled. Although most chunks follow the general structure described in Table 6-1, each type of chunk has unique aspects to its layout. To allow you to distinguish between the chunks, each chunk carries a “chunk GUID”.
DRAFT Smart Features 6.7 Smart Features on the A102f 6.7.1 Extended Data Stream The extended data stream feature has two functions: • When it is enabled, information such as image height, image width, and AOI size is added to the basic pixel data for each image. • It must be enabled before you can use any other smart feature that adds information to the image data stream.
DRAFT Smart Features 6-10 K+M Stride [ 4 Bytes ] Signed integer. Indicates the number of bytes needed to advance from the beginning of one row in an image to the beginning of the next row. K+M+4 Reserved [ 3 Bytes ] ----- K+M+7 Data Depth [ 1 Byte ] Effective data depth in bits of the pixels in the image. K+M+8 Top [ 2 Bytes ] Y coordinate of the top left corner of the current area of interest (AOI). K + M + 10 Left [ 2 Bytes ] X coordinate of the top left corner of the current AOI.
DRAFT Smart Features 6.7.2 Frame Counter The frame counter feature numbers images sequentially as they are captured. The counter starts at 0 and wraps at 4294967296. The counter increments by one for each captured frame. Whenever the camera is powered off, the counter will reset to 0. Note that if the camera is in continuous shot mode and continuous capture is stopped, up to two numbers in the counting sequence may be skipped. This happens due to the internal image buffering scheme used in the camera.
DRAFT Smart Features 6.7.3 Cycle Time Stamp The cycle time stamp feature adds a chunk to each image frame containing the value of the counters for the IEEE 1394 bus cycle timer. The counters are sampled at the start of exposure of each image. L The extended data stream feature (see Section 6.7.1) must be enabled in order to use the cycle time stamp feature or any of the other smart feature that adds information to the image data stream.
DRAFT Smart Features 6.7.4 DCAM Values The DCAM values feature adds a chunk to each image frame containing the current settings for some standard DCAM features. The settings are sampled at the start of exposure of each image. L The extended data stream feature (see Section 6.7.1) must be enabled in order to use the DCAM values feature or any of the other smart feature that adds information to the image data stream.
DRAFT Smart Features DCAM Values Chunk Layout Position Name Description 0 Gain CSR [ 4 Bytes ] Content of the DCAM Gain CSR Field Bit Description Presence Inq [0] Presence of this feature If 0, the DCAM feature is not available and all of its values should be ignored Abs Control [1] Absolute control mode If 1, the DCAM feature is in absolute control mode and the current value can be read from the Absolute Value CSR. Otherwise, the Value field holds the current raw value setting. ----- [2 ..
DRAFT 24 White Balance CSR [ 4 Bytes ] Smart Features Content of the DCAM White Balance CSR Field Bit Description Presence Inq [0] Presence of this feature If 0, the DCAM feature is not available and all of its values should be ignored Abs Control [1] Absolute control mode If 1, the DCAM feature is in absolute control mode and the current value can be read from the Absolute Value CSR. Otherwise, the Value field holds the current raw value setting. ----- [2 ...
DRAFT Smart Features 6.7.5 CRC Checksum The CRC Checksum feature adds a chunk to each image frame containing a 16 bit CRC checksum calculated using the Z-modem method. The CRC Checksum chunk is always the last chunk added to the image data stream and the chunk is always 32 bits in size. As shown in Figure 6-2, the checksum is calculated using all of the image data and all of the appended chunks except for the checksum itself.
DRAFT Smart Features CRC Checksum Chunk Layout The CRC checksum is an exception to the normal chunk structure. The CRC chunk is always 32 bits wide and is always the last chunk appended to the image data. The lower 16 bits of the chunk are filled with the checksum and the upper 16 bits of the chunk are filled with zeros. Bit Description [ 0 ... 7 ] CRC Checksum low byte [ 8 ... 15 ] CRC Checksum high byte [ 16 ... 23 ] 0x00 [ 24 ...
DRAFT Smart Features /** \brief Verifies a frame buffer's CRC checksum * \param pData Pointer to the frame * \param nbyLength Size of frame in bytes * \return 1, if the check succeeds, 0 otherwise */ int CheckBuffer(const unsigned char* pData, unsigned long nbyLength ) { unsigned long nCurrentCRC, nDesiredCRC; /* Calculate the CRC checksum of the buffer.
DRAFT Smart Features 6.7.6 Test Images A102f cameras include a test image mode as a smart feature. The test image mode is used to check the camera’s basic functionality and its ability to transmit an image via the video data cable. The test image mode can be used for service purposes and for failure diagnostics. In test mode, the image is generated with a software program and the camera’s digital devices and does not use the optics, the CMOS pixel array, or the ADCs.
DRAFT Smart Features Test Image Two Test image two is designed for use with monochrome, 16 bit output modes. Test image two consists of rows with several gray scale gradients ranging from 0 to 4095. Assuming that the camera is operating at full 1392 x 1040 resolution and is set for a monochrome, 16 bit output mode, when the test images are generated: • Row 0 starts with a gray value of 0 for the first pixel, 1 for the second pixel, 2 for the third pixel, 3 for the fourth pixel, ...
DRAFT Smart Features Control and Status Register for the Test Image Feature Name Test Images Address See “Determining the Address of Smart Features CSRs” on page 6-4. CSR GUID 2A411342 - C0CA - 4368 - B46E - EE5DEEBF0548 Field Bit Description Presence Inq (Read only) [0] Presence of this feature 0: Not Available 1: Available ----- [1 ...
DRAFT Smart Features 6.7.7 Extended Version Information A102f cameras include a register that contains version numbers for the camera’s internal software. For troubleshooting purposes, Basler technical support may ask you to read this register and to supply the results. L The extended version information smart feature does not add information to the image data stream and can be accessed even when the extended data stream feature (see Section 6.7.1) is disabled.
DRAFT Smart Features 6.7.8 Lookup Table The A102f camera has a sensor that reads pixel values at a 12 bit depth, however, the camera can be set to output pixel values at an 8 bit depth. When set for 8 bit output, the camera normally uses an internal process to convert the 12 bit pixel values from the sensor to the 8 bit values transmitted out of the camera.
Smart Features DRAFT The advantage of the lookup table feature is that it allows the user to customize the response curve of the camera. The graphs below represent the contents of two typical lookup tables. The first graph is for a lookup table where the values are arranged so that the output of the camera increases linearly as the sensor output increases.
DRAFT Smart Features Control and Status Register for the Lookup Table Feature Name Lookup Table Address See “Determining the Address of Smart Features CSRs” on page 6-4. CSR GUID B28C667C - DF9D - 11D7 - 8693 - 000C6E0BD1B0 Position Field Bit Description 0 Presence Inq (Read only) [0] Presence of this feature 0: Not Available 1: Available ----- [1 ... 30] Reserved Enable (Read / write) [31] Enable / Disable this feature 0: Disable 1: Enable In Depth Inq (Read only) [0 ...
DRAFT Smart Features 6-26 16328 Quadlet 4080 (Read / write) [1 Quadlet] Defines the 8 bit value that will be transmitted from the camera when the 12 bit pixel value from the sensor is 4080. 16332 ... 16356 Quadlet 4081 ... 4087 (Read / write) [7 Quadlets Not used. The values written here will be ignored. 16360 Quadlet 4088 (Read / write) [1 Quadlet] Defines the 8 bit value that will be transmitted from the camera when the 12 bit pixel value from the sensor is 4088. 16364 ...
DRAFT Smart Features Using the SFF Viewer to Upload a Lookup Table The Configurator window in the Basler SFF Viewer (see Section 6.4) includes a drop down list that can be used to enable the lookup table feature. It also includes an Upload button that can be used to easily load a text file containing a customized lookup table into the camera. The file must be plain text and must be formatted correctly. The file must have 4096 lines with each line containing two comma-separated values.
Smart Features DRAFT 6.7.9 Lossless Compression The A102f includes a feature that allows lossless compression of the 12 bit output from the camera’s sensor to 8 bit output transmitted from the camera. The basis for the lossless compression feature is a mathematical process that compresses the 12 bit output from the sensor to 8 bits by removing information characterized as noise.
DRAFT Smart Features 6.7.10 Trigger Flag and Trigger Counter A102f cameras include a trigger flag and trigger counter feature. The trigger counter increments by one each time an image capture is triggered regardless of whether the trigger is internal (one shot or continuous shot commands) or is external (hardware or software trigger). Triggers that occur when the camera is not ready are discarded and not counted. The trigger counter wraps to zero after 65535 is reached.
Smart Features DRAFT 6.7.11 Output Port Configuration A102f cameras are equipped with four physical output ports designated as Output Port 0, Output Port 1, Output Port 2, and Output Port 3. The output port configuration feature can be used to change the assignment of camera output signals (such as Integrate Enabled and Trigger Ready) to the physical output ports. As shown on pages 6-31 and 6-32, there is a control and status register (CSR) for each physical output port.
DRAFT Smart Features Control and Status Registers for the Output Port Configuration Feature Name Output Port 0 Configuration Address See “Determining the Address of Smart Features CSRs” on page 6-4.
DRAFT Smart Features 6-32 Name Output Port 1 Configuration Address See “Determining the Address of Smart Features CSRs” on page 6-4. CSR GUID 949D820A - 4513 - 11D8 - 9EB1 - 00105A5BAE55 Position Field 0 Same as port 0. 4 Same as port 0. 8 Same as port 0. 12 Same as port 0. 16 Same as port 0. 20 Same as port 0. Name Output Port 2 Configuration Address See “Determining the Address of Smart Features CSRs” on page 6-4.
DRAFT Smart Features 6.7.12 Startup Memory Channel As described in Section 3.15, A102f cameras include four memory channels that can be used to store camera configuration sets. Memory channel 0 contains a factory configuration set. Channels 1, 2 and 3 can be used to store user created configuration sets.
DRAFT Smart Features 6.7.13 Shutter Time Base As described in Section 3.2.1, exposure time is determined by a combination of two values. The first is the setting in the Value field of the Shutter control register (see page 4-22). The second is the Shutter Time Base.
DRAFT Smart Features Control and Status Register for the Shutter Time Base Feature Name Shutter Time Base Address See “Determining the Address of Smart Features CSRs” on page 6-4. CSR GUID 648BE1DA - A416 - 11D8 - 9B47 - 00105A5BAE55 Position Field Bit Description 0 Presence Inq (Read only) [0] Presence of the shutter time base feature 0: Not Available 1: Available ----- [1 ...
Smart Features DRAFT 6.7.14 Strobe Time Base The strobe time base smart feature can be used to change the delay time base and the duration time base for the strobe control feature (see Section 3.10). Changing the Strobe Delay Time Base As described in Section 3.10, the delay for any one of the strobe signals is determined by a combination of two values. The first is the setting in the Delay Value field of the corresponding Strobe Control register (see page 4-22). The second is the Strobe Delay Time Base.
DRAFT Smart Features Example Assume that you have set the Duration Value field of the Strobe 0 control register to 423. Also assume that you have set the Duration Time Base field in the Strobe Time Base CSR to 5. In this case: Strobe 0 Duration = (Strobe 0 Duration Value Setting) x (Strobe Duration Time Base) Strobe 0 Duration = (423) x (5/1024 ms) Strobe 0 Duration = 2.
Smart Features DRAFT 6.8 Customized Smart Features The Basler A102f has significant processing capabilities and Basler can accommodate customer requests for customized smart features. A great advantage of the smart features framework is that it serves as a standardized platform for parameterizing any customized smart feature and for returning the results from the feature. The Basler camera development team is ready and able to handle requests for customized smart features.
DRAFT Mechanical Considerations 7 Mechanical Considerations The A102f camera housing is manufactured with high precision. Planar, parallel, and angular sides guarantee precise mounting with high repeatability. Caution! The camera is shipped with a cap on the lens mount. To avoid collecting dust on the sensor, make sure that at all times either the cap is in place or a lens is mounted on the camera.
Mechanical Considerations DRAFT 7.1 Camera Dimensions and Mounting Facilities The dimensions for A102f cameras are as shown in Figure 7-1. A102f cameras are equipped with four M4 mounting holes on the front and two M4 mounting holes on each side as indicated in the drawings.
DRAFT Mechanical Considerations 7.2 Sensor Positioning Accuracy The sensor positioning accuracy in the horizontal and vertical directions is as shown in Figure 72. Rotational accuracy is also shown in the figure.
Mechanical Considerations DRAFT 7.3 Maximum Lens Thread Length on the A102fc A102fc cameras are normally equipped with a C-mount lens adapter that contains an internal IR cut filter. As shown in Figure 7-3, the thread length of the C-mount lens must used on the camera must be less than 7.5 mm. If a lens with a longer thread length is used, the IR cut filter will be damaged or destroyed and the camera will no longer operate.
DRAFT Mechanical Considerations 7.4 Mechanical Stress Test Results The A102f was submitted to an independent mechanical testing laboratory and subjected to the stress tests listed below. After mechanical testing, the camera exhibited no detectable physical damage and produced normal images during standard operational testing. Test Standard Conditions Vibration (each axis) IEC 60068-2-6 10-58 Hz / 1.
Mechanical Considerations 7-6 DRAFT BASLER A102f
DRAFT Revision History Revision History Doc. ID Number Date Changes DA00063001 24 October 2003 Initial release of this document. DA00063002 25 February 2004 Second draft for revision two of the manual. Added Section 1.1 describing document applicability. Updated Sections 2.5, 3.2.5, 3.3, and 3.4 to reflect the new input and output port configuration options. Added Section 3.2.4 describing the new software trigger feature.
DRAFT Revision History Doc. ID Number Date Changes DA00063005 2 March 2005 Added Sections 2.5.3 and 2.5.4 showing typical input circuit and typical output circuit digrams. Added Section 3.2.7 to clarify the terminology used to describe frame readout, buffering and transmission. Updated the YUV formulas in Section 3.8. Reworded the white balance and color filter ID descriptions in Sections 3.8.1 and 3.8.2 for better clarity. Added information about the new strobe time base feature to Sections 3.
DRAFT Index Index A F advanced features registers . . . . . . . . . . . . . . . 4-46 anti-blooming . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 area of interest . . . . . . . . . . . . . . . . . . . . . . . . . 3-19 factory configuration set . . . . . . . . . . . . . . . . . . . 3-38 firmware ID number . . . . . . . . . . . . . . . . . . . . . . . 1-1 flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37 frame buffering . . . . . . . . . . . . . . . . . . . . . .
Index DRAFT P T packet payloads . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 parallel I/O control . . . . . . . . . . . . . . . . . . . . . . . 3-32 performance specifications . . . . . . . . . . . . . . . . . 1-2 pin assignments . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 pixel depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29 pixel size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 power requirements . . . . . . . . . . . . . . . . . . . .
