Preface

    What Is the Image Acquisition Toolbox?
    Related Products
    Configuration Notes
    About the Documentation
        Structure of the Documentation

    Typographical Conventions

Getting Started

    Example: Basic Image Acquisition Procedure
        Overview
        Step 1: Install Your Image Acquisition Device
        Step 2: Retrieve Hardware Information
        Step 3: Create a Video Input Object
        Step 4: Preview the Video Stream (Optional)
        Step 5: Configure Object Properties (Optional)
        Step 6: Acquire Image Data
        Step 7: Clean Up

Examples

Introduction

    Overview
        Toolbox Components
        System Requirements

    Setting Up Image Acquisition Hardware
        Resetting Your Image Acquisition Hardware
        A Note About Frame Rates and Processing Speed

    Previewing Data
        Opening a Preview Window
        Closing a Preview Window

    Troubleshooting
        Troubleshooting Matrox Hardware
        Troubleshooting Data Translation Hardware
        Troubleshooting Windows Video Hardware
        Troubleshooting a Preview Window

Connecting to Hardware

    Getting Hardware Information
        Determining the Device Adaptor Name
        Determining the Device ID
        Determining Supported Video Formats

    Creating Image Acquisition Objects
        Creating a Video Input Object
        Specifying the Video Format
        Specifying the Selected Video Source Object

    Configuring Image Acquisition Object Properties
        Viewing the Values of Object Properties
        Viewing the Value of a Particular Property
        Getting Information About Object Properties
        Setting the Value of an Object Property

    Starting and Stopping a Video Input Object
    Deleting Image Acquisition Objects
    Saving and Loading Image Acquisition Objects

Acquiring Image Data

    Overview
        Trigger Properties

    Setting the Values of Trigger Properties
        Specifying Trigger Type, Source, and Condition

    Specifying the Trigger Type
        Example: Using an Immediate Trigger
        Example: Using a Manual Trigger
        Example: Using a Hardware Trigger

    Controlling Logging Parameters
        Specifying Logging Mode
        Specifying the Number of Frames to Log
        Determining How Much Data Has Been Logged
        Determining How Many Frames Are Available
        Delaying Data Logging After a Trigger
        Specifying Multiple Triggers

    Waiting for an Acquisition to Finish
    Managing Memory Usage
        Monitoring Memory Usage
        Modifying the Frame Memory Limit
        Freeing Memory

    Logging Image Data to Disk
        Creating an AVI File Object for Logging
        Example: Logging Data to Disk

Working with Acquired Image Data

    Overview
    Bringing Image Data into the MATLAB Workspace
        Moving Multiple Frames into the Workspace
        Viewing Frames in the Memory Buffer
        Bringing a Single Frame into the Workspace

    Working with Image Data in the MATLAB Workspace
        Determining the Dimensions of Image Data
        Determining the Data Type of Image Frames
        Determining the Color Space
        Viewing Acquired Data

    Retrieving Timing Information
        Determining When a Trigger Executed
        Determining When a Frame Was Acquired
        Example: Determining the Frame Delay Duration

Using Events and Callbacks

    Example: Using the Default Callback Function
    Event Types
    Retrieving Event Information
        Event Structures
        Example: Accessing Data in the Event Log

    Creating and Executing Callback Functions
        Creating Callback Functions
        Specifying Callback Functions
        Example: Viewing a Sample Frame
        Example: Monitoring Memory Usage

Function Reference

    Functions -- By Category
    Alphabetical List of Functions
        clear
        closepreview
        delete
        disp
        flushdata
        get
        getdata
        getselectedsource
        getsnapshot
        imaqfind
        imaqhelp
        imaqhwinfo
        imaqmem
        imaqmontage
        imaqreset
        isvalid
        load
        peekdata
        preview
        propinfo
        save
        set
        start
        stop
        trigger
        triggerconfig
        triggerinfo
        videoinput
        wait

Property Reference

    Properties - By Category
        Video Input Object Properties
        Video Source Object Properties

    Properties - Alphabetical List
        DeviceID
        DiskLogger
        DiskLoggerFrameCount
        ErrorFcn
        EventLog
        FrameGrabInterval
        FramesAcquired
        FramesAcquiredFcn
        FramesAcquiredFcnCount
        FramesAvailable
        FramesPerTrigger
        InitialTriggerTime
        Logging
        LoggingMode
        Name
        NumberOfBands
        Parent
        Previewing
        ReturnedColorSpace
        ROIPosition
        Running
        Selected
        SelectedSourceName
        Source
        SourceName
        StartFcn
        StopFcn
        Tag
        Timeout
        TimerFcn
        TimerPeriod
        TriggerCondition
        TriggerFcn
        TriggerFrameDelay
        TriggerRepeat
        TriggersExecuted
        TriggerSource
        TriggerType
        Type
        UserData
        VideoFormat
        VideoResolution

Printable Documentation (PDF)