aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 90cfee19208e496c76041ea87adca2c1aed5f43d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# pymba

pymba is a Python wrapper for the Allied Vision Technologies (AVT) Vimba C API. It wraps the VimbaC.dll file included in the AVT Vimba installation to provide a simple Python interface for AVT cameras. It currently supports most of the functionality provided by VimbaC.dll.

## Installation

Install the Vimba SDK from AVT to the default directory.

Run the AVTDriverInstaller tool and install the AVT Vimba SDK drivers.

Install pymba.

## Usage

### Testing installation 

If Vimba and pymba are installed correctly, then the following code examples should give the installed Vimba version. No camera is needed.

Checking the version using a context manager:

    from pymba import *
    
    with Vimba() as vimba:
        print(vimba.getVersion())
	
Or without using a context manager:

    from pymba import *
    
    vimba = Vimba()
    vimba.startup()
    print(vimba.getVersion())
    vimba.shutdown()

### Interacting with cameras

Discover, open, manipulate, and capture frames from a camera.
    
    from pymba import *
    import time
    
    # start Vimba
    with Vimba() as vimba:
        # get system object
        system = vimba.getSystem()
        
        # list available cameras (after enabling discovery for GigE cameras)
        if system.GeVTLIsPresent:
            system.runFeatureCommand("GeVDiscoveryAllOnce")
            time.sleep(0.2)
        cameraIds = vimba.getCameraIds()
        for cameraId in cameraIds:
            print(cameraId)
        
        # get and open a camera
        camera0 = vimba.getCamera(cameraIds[0])
        camera0.openCamera()
        
        # list camera features
        cameraFeatureNames = camera0.getFeatureNames()
        for name in cameraFeatureNames:
            print(name)
        
        # get the value of a feature
        print(camera0.AcquisitionMode)
        
        # set the value of a feature
        camera0.AcquisitionMode = 'SingleFrame'
        
        # create new frames for the camera
        frame0 = camera0.getFrame()    # creates a frame
        frame1 = camera0.getFrame()    # creates a second frame
        
        # announce frame
        frame0.announceFrame()
        
        # capture a camera image
        camera0.startCapture()
        frame0.queueFrameCapture()
        camera0.runFeatureCommand('AcquisitionStart')
        camera0.runFeatureCommand('AcquisitionStop')
        frame0.waitFrameCapture()
        
        # get image data...
        imgData = frame0.getBufferByteData()
        
        # ...or use NumPy for fast image display (for use with OpenCV, etc)
        import numpy as np
        moreUsefulImgData = np.ndarray(buffer = frame0.getBufferByteData(),
                                       dtype = np.uint8,
                                       shape = (frame0.height,
                                                frame0.width,
                                                1))
        
        # clean up after capture
        camera0.endCapture()
        camera0.revokeAllFrames()
        
        # close camera
	
### Interacting with the Vimba system
    
Get a reference to the Vimba system object and list available system features.
    
    from pymba import *
    
    with Vimba() as vimba:
        # get system object
        system = vimba.getSystem()
        
        # list system features
        for featureName in system.getFeatureNames():
            print(featureName)

### Interacting with transport layer interfaces
    
Get a reference to an interface object and list available interface features.
    
    from pymba import *
    
    with Vimba() as vimba:
        # get list of available interfaces
        interfaceIds = vimba.getInterfaceIds()
        for interfaceId in interfaceIds:
            print(interfaceId)
        
        # get interface object and open it
        interface0 = vimba.getInterface(interfaceIds[0])
        interface0.openInterface()
        
        # list interface features
        interfaceFeatureNames = interface0.getFeatureNames()
        for name in interfaceFeatureNames:
            print(name)
        
        # close interface
        interface0.closeInterface()



### Handling Vimba exceptions

    from pymba import *

    try:
        with Vimba() as vimba:
    except VimbaException as e:
        print(e.message)
    


## Known issues

* Not all API functions are wrapped (most are). For full list see vimbadll.py.