Definition Type: Element
Name: mode_roi
Containing Schema: BFML-CL.xsd
MinOccurs 0
MaxOccurs (1)
Abstract
Documentation:
If this mode acquires a smaller resolution image than the camera puts out, this section can be used to specify the ROI.
Collapse XSD Schema Diagram:
Drilldown into cam_frame_height Drilldown into cam_line_width Drilldown into manual_taps Drilldown into bitdepth Drilldown into yoffset Drilldown into xoffset Drilldown into ysize Drilldown into xsize Drilldown into formatXSD Diagram of mode_roi
Collapse XSD Schema Code:
<xs:element name="mode_roi" minOccurs="0">
    <xs:annotation>
        <xs:documentation>If this mode acquires a smaller resolution image than the camera puts out, this section can be used to specify the ROI.</xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:all>
            <xs:element name="format" type="xs:string" minOccurs="0" maxOccurs="1">
                <xs:annotation>
                    <xs:documentation>This node describes the Camera Link output tap format for this mode. This node should be in the standard CL tap format syntax:

[ZoneX]X[TapX][ExtX]-[ZoneY]Y[TapY][ExtY]

Optionally this node can be set to "Custom", in which case the node "manual_taps" must be filled out.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="xsize" type="xs:unsignedInt" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>Width of the ROI in pixels.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="ysize" type="xs:unsignedInt" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>Height of this ROI in lines.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="xoffset" type="xs:unsignedInt" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>X-Offset from the first pixel in the frame. Units are pixels.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="yoffset" type="xs:unsignedInt" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>Y-Offset from the first line in the image. Units are lines.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="bitdepth" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>This can be used to specify the pixel bit depth if this mode uses a different depth than the default.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:simpleContent>
                        <xs:extension base="xs:unsignedByte">
                            <xs:attribute name="packed" use="optional">
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:enumeration value="no" />
                                        <xs:enumeration value="yes" />
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:attribute>
                            <xs:attribute name="bitdepth_option" use="optional">
                                <xs:annotation>
                                    <xs:documentation>Normal - Normal
RGBSwap - for RGB color cameras, pixels are DMAed BGR
FormatIgnore - Use when the tap format refers to bytes and not pixels
FormatIgnoreRGBSwap - combindation of the the two above</xs:documentation>
                                </xs:annotation>
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:enumeration value="Normal" />
                                        <xs:enumeration value="RGBSwap" />
                                        <xs:enumeration value="FormatIgnore" />
                                        <xs:enumeration value="FormatIgnoreRGBSwap" />
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:attribute>
                        </xs:extension>
                    </xs:simpleContent>
                </xs:complexType>
            </xs:element>
            <xs:element name="manual_taps" minOccurs="0" maxOccurs="1">
                <xs:annotation>
                    <xs:documentation>This can be use to manually program the CL front end for unusual tap formats.</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="tap" minOccurs="1" maxOccurs="10">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="start" type="xs:string" minOccurs="1" maxOccurs="1">
                                        <xs:annotation>
                                            <xs:documentation>Tap number (0 - 10) to acquire.</xs:documentation>
                                        </xs:annotation>
                                    </xs:element>
                                    <xs:element name="step" type="xs:string" minOccurs="1" maxOccurs="1">
                                        <xs:annotation>
                                            <xs:documentation>Step to next sequence.</xs:documentation>
                                        </xs:annotation>
                                    </xs:element>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
            <xs:element name="cam_line_width" minOccurs="0" maxOccurs="1">
                <xs:annotation>
                    <xs:documentation>Used when: 1. camera line width is not a multiple of 16-bytes, 2. subwindowing segmented camera, 3. modes where there are vertical taps (e.g. 2XE-2YE)</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:simpleContent>
                        <xs:extension base="xs:unsignedInt">
                            <xs:attribute name="use" use="optional">
                                <xs:annotation>
                                    <xs:documentation>Set to PixelRouterAndAcquisitionEngine if the board should program the Acquisition Engine with cam_line_width (instead of x_size). This is mainly used with tap formats that have more than one vertical tap.</xs:documentation>
                                </xs:annotation>
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:enumeration value="PixelRouter" />
                                        <xs:enumeration value="PixelRouterAndAcquisitionEngine" />
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:attribute>
                        </xs:extension>
                    </xs:simpleContent>
                </xs:complexType>
            </xs:element>
            <xs:element name="cam_frame_height" minOccurs="0" maxOccurs="1">
                <xs:annotation>
                    <xs:documentation>Used when where there are vertical taps (e.g. 2XE-2YE)</xs:documentation>
                </xs:annotation>
                <xs:complexType>
                    <xs:simpleContent>
                        <xs:extension base="xs:unsignedInt">
                            <xs:attribute name="use" use="optional">
                                <xs:annotation>
                                    <xs:documentation>Set to PixelRouterAndAcquisitionEngine if the board should program the Acquisition Engine with cam_line_width (instead of x_size). This is mainly used with tap formats that have more than one vertical tap.</xs:documentation>
                                </xs:annotation>
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:enumeration value="PixelRouter" />
                                        <xs:enumeration value="PixelRouterAndAcquisitionEngine" />
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:attribute>
                        </xs:extension>
                    </xs:simpleContent>
                </xs:complexType>
            </xs:element>
        </xs:all>
    </xs:complexType>
</xs:element>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
format format 0 1
xsize xsize 0 (1)
ysize ysize 0 (1)
xoffset xoffset 0 (1)
yoffset yoffset 0 (1)
bitdepth bitdepth 0 (1)
manual_taps manual_taps 0 1
cam_line_width cam_line_width 0 1
cam_frame_height cam_frame_height 0 1