dataIO(name[, mandparams, optparams]) -> constructor
Parameters : | name : {str}
|
---|---|
Returns : | Returns none or a PyDictionary depending on the value of detailLevel. : |
Notes
This is the constructor for a dataIO-type plugins. It initializes an new instance if the plugin specified by ‘name’. The initialisation parameters are parsed and unnamed parameters are used in their incoming order to fill first mandatory parameters and afterwards optional parameters. Parameters may be passed with name as well but after the first named parameter no more unnamed parameters are allowed. See pluginHelp(name) for detail information about the specific initialisation parameters.
Use this command to start the image acquisition depending on the trigger parameter.
Parameters : | trigger : {Integer}, optional
|
---|
Parameters : | dataObject : {doctodo} |
---|
Notes
The object is not changed / adepted to the grabber and must be allocated properly before copyVal is called
Notes
such that live images only will be updated if a new image is manually grabbed. [Recommended if the measurement routine requires camera images by itself.]
Notes
such that live images will continuously get new data. [Recommended if the measurement routine does not need any camera image at the moment.]
Parameters : | funcName : {str}
paramN : {variant}
|
---|---|
Returns : | Variable return values. :
|
Notes
This function is used to invoke a plugIn-Specific execFunc, declared within the corresponding plugin. The parameters (arguments), output parameters / return values depends on the function (see plugin.getExecFuncsInfo() or plugin.getExecFuncsInfo(funcName)).
Returns : | auto grabbing flag : {bool}
|
---|
See also
Notes
See methods enableAutoGrabbing() or disableAutoGrabbing().
Parameters : | funcName : {str}, optional
detailLevel : {dict}, optional
|
---|---|
Returns : | None or Dict :
|
Notes
Generates an online help with all execFuncs for this plugIn or returns a list of available execFuncs.
Parameters : | name : {str???} |
---|---|
Returns : | Value of the given parameter : |
Notes
doctodo
Returns : | List of possible Parameters : |
---|
Notes
doctodo
Parameters : | detailLevel : {dict}, optional
|
---|---|
Returns : | Returns none or a PyDictionary depending on the value of detailLevel. : |
Notes
Generates an online help for available parameters and additional informations of the plugin.
Returns : | dataIO type : |
---|
Notes
doctodo
Parameters : | doctodo : |
---|---|
Returns : | shallow copy of internal camera image : |
Notes
Cameras, Grabber: - buffer (dataObject), no length value: The image in dataObject is only a shallow copy of the camera internal memory. Therefore this content
may change if a new image has been acquired by the camera. Therefore consider to make a deep copy of this image or use the method copyVal.
further IO-devices: - buffer (allocated byteArray, bytes...) and optional a length with the maximum number of characters which should be requested by the plugin. If length is not provided it is set to the length of the given buffer. Finally the number of effectively set characters is returned.
Returns : | Name of the Plugin : {str} |
---|
Notes
doctodo
Parameters : | on : {bool}
|
---|
Notes
such that live images only will be updated if a new image is manually grabbed (on).
Parameters : | name : {str???} value : {str, int, double, ...} |
---|
Notes
doctodo
Parameters : | dataObject : {dataObject???} |
---|
Notes
doctodo
If you call startDevice multiple times, the device is only started at the first call, the next calls only increment a internal counter. This is necessary, since every connected live image needs to start the device without knownledge about any previous start. A call to stopDevice decrements this counter and closes the hardware device if that counter drops to 0 again. No acquisition is possible, if the device has not been started, hence the counter is 0.
Parameters : | count : {unsigned integer}, optional
|
---|
Notes
if count > 1, startDevice is executed ‘count’ times, in order to increment the grabber internal start counter.
Usually no acquisition is possible, if the device is not started.
Parameters : | count : {Integer > 0}, optional
|
---|---|
Returns : | None or the number of cycles that have been necessary to finally decrement the grabber’s internal start counter to 0 (only if count==-1) : |