Start » Filter Reference » GenICam » GenICam_SetRealParameter
Basic| Module: | GenICam |
|---|
Sets parameter of type Real into GenICam device.
| Name | Type | Description | |
|---|---|---|---|
 |
inAddress | GenAddress | GenTL Provider module and device identifying address |
|
inScope | GenICamParameterScope | Specifies which parameters set in GenICam stack should be accessed |
|
inParameterName | GenParameterName | Name of GenICam parameter node to access |
|
inValue | Real | New value to be set into device parameter |
|
inVerify | Bool | True to verify GenICam parameter access state and value correctness before every write |
Description
This filter is intended for cooperation with general camera device trough GenTL compliant interface. Its purpose is to set a value into internal device parameter using GenICam interface.
This filter does not require other GenICam filters in program (especially GenICam_GrabImage is not obligatory), but can be used in any combination with them, including sharing access to single device with other filters.
Device address (inAddress port) is a structure defining a unique device and its GenTL provider module in the system. It is recommended to use the GenTL Device Manager (click the "..." button in Filter Properties) to select the appropriate device, connected to the local system, whose identification information will be used.
Device address consists of the following fields:
- VendorName - Vendor name of the GenTL provider module, which will be used to communicate with the device.
- TLType - Identification code of interface transport technology type (for example "GEV", "IIDC", "UVC", "USB3", "PCI", "Custom"). The exact code depends on the GenTL provider module.
- DeviceID - Unique ID of the device in the selected interface technology of the used provider module. The format of this field must be always an exact ID string and depends on the used GenTL provider module.
This filter will interpret the value of inAddress port only during the first iteration of its parent Task, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.
Parameter name (inParameterName) must be an ID of GenICam parameter exported by device. Each device model can have different parameter names and its meanings. Refer to device documentation and use GenICam settings browser (click "..." button in filter properties) to select appropriate name of parameter (see: Device settings editor section in user manual).
The name of the parameter must point to a GenICam parameter providing "IFloat" interface or error will be raised upon filter execution.
When inVerify is set to False this filter will not validate new values for the parameter (like range or access).
Value from the inValue port will be sent to the device only upon its change.
For general information about working with Gen TL devices, please refer to the following article.
Hints
- Interactively select a camera available in your network by defining the inAddress input.
- Choose inParameterName from those supported by your camera.
- Set or connect inValue to specify a new value for the selected camera parameter.
Complexity Level
This filter is available on Basic Complexity Level.
Disabled in Lite Edition
Filter Group
This filter is member of GenICam_SetParameter filter group.
See Also
- GenICam_GrabImage – Captures an image stream from a camera using a GenICam GenTL provider library.
- GenICam_SetDoubleParameter – Sets parameter of type Double into GenICam device.
- GenICam_SetIntegerParameter – Sets parameter of type Integer into GenICam device.
- GenICam_SetEnumParameter – Sets parameter of type Enumeration into GenICam device.
- GenICam_SetBoolParameter – Sets parameter of type Bool into GenICam device.
- GenICam_GetRealParameter – Gets parameter of type Real from GenICam device.
Application Notes - set of documents about connecting devices or establishing communication with Aurora Vision Studio.