 |
PVCAM
3.9.x
Programmable Virtual Camera Access Method library
|
|
PVCAM
3.9.x
Programmable Virtual Camera Access Method library
|
Macros | |
| #define | PARAM_DD_INFO_LENGTH ((CLASS0<<16) + (TYPE_INT16<<24) + 1) |
| Returns the length of an information message for each device driver. More... | |
| #define | PARAM_DD_VERSION ((CLASS0<<16) + (TYPE_UNS16<<24) + 2) |
| Returns a version number for the device driver used to access the camera. More... | |
| #define | PARAM_DD_RETRIES ((CLASS0<<16) + (TYPE_UNS16<<24) + 3) |
| Reads/sets the maximum number of command retransmission attempts that are allowed. More... | |
| #define | PARAM_DD_TIMEOUT ((CLASS0<<16) + (TYPE_UNS16<<24) + 4) |
| Reads/sets the maximum time the driver waits for acknowledgment. More... | |
| #define | PARAM_DD_INFO ((CLASS0<<16) + (TYPE_CHAR_PTR<<24) + 5) |
| Returns an information message for each device. More... | |
| #define | PARAM_CAM_INTERFACE_TYPE ((CLASS0<<16) + (TYPE_ENUM<<24) + 10) |
| Returns a list of camera communication interfaces. More... | |
| #define | PARAM_CAM_INTERFACE_MODE ((CLASS0<<16) + (TYPE_ENUM<<24) + 11) |
| Returns a list of camera communication interface modes. More... | |
| #define | PARAM_ADC_OFFSET ((CLASS2<<16) + (TYPE_INT16<<24) + 195) |
| Bias offset voltage. More... | |
| #define | PARAM_CHIP_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 129) |
| The name of the sensor. More... | |
| #define | PARAM_SYSTEM_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 130) |
| The name of the system. More... | |
| #define | PARAM_VENDOR_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 131) |
| The name of the vendor. More... | |
| #define | PARAM_PRODUCT_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 132) |
| The name of the product. More... | |
| #define | PARAM_CAMERA_PART_NUMBER ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 133) |
| The part number of the camera. More... | |
| #define | PARAM_COOLING_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 214) |
| This is the type of cooling used by the current camera. More... | |
| #define | PARAM_PREAMP_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 502) |
| The number of milliseconds required for the sensor output preamp to stabilize, after it is turned on. More... | |
| #define | PARAM_COLOR_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 504) |
| The color mode of the sensor. More... | |
| #define | PARAM_MPP_CAPABLE ((CLASS2<<16) + (TYPE_ENUM<<24) + 224) |
| Indicates whether this sensor runs in MPP mode. More... | |
| #define | PARAM_PREAMP_OFF_CONTROL ((CLASS2<<16) + (TYPE_UNS32<<24) + 507) |
| The exposure time limit in milliseconds above which the preamp is turned off during exposure. More... | |
| #define | PARAM_PREMASK ((CLASS2<<16) + (TYPE_UNS16<<24) + 53) |
| The number of masked lines at the near end of the parallel register. More... | |
| #define | PARAM_PRESCAN ((CLASS2<<16) + (TYPE_UNS16<<24) + 55) |
| The number of pixels discarded from the serial register before the first real data pixel. More... | |
| #define | PARAM_POSTMASK ((CLASS2<<16) + (TYPE_UNS16<<24) + 54) |
| The number of masked lines at the far end of the parallel register. More... | |
| #define | PARAM_POSTSCAN ((CLASS2<<16) + (TYPE_UNS16<<24) + 56) |
| The number of pixels to discard from the serial register after the last real data pixel. More... | |
| #define | PARAM_PIX_PAR_DIST ((CLASS2<<16) + (TYPE_UNS16<<24) + 500) |
| This is the center-to-center distance between pixels in the parallel direction. More... | |
| #define | PARAM_PIX_PAR_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 63) |
| This is the size of the active area of a pixel, in the parallel direction. More... | |
| #define | PARAM_PIX_SER_DIST ((CLASS2<<16) + (TYPE_UNS16<<24) + 501) |
| This is the center-to-center distance between pixels in the serial direction. More... | |
| #define | PARAM_PIX_SER_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 62) |
| This is the size of the active area of a pixel in the serial direction. More... | |
| #define | PARAM_SUMMING_WELL ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 505) |
| Checks to see if the summing well exists. More... | |
| #define | PARAM_FWELL_CAPACITY ((CLASS2<<16) + (TYPE_UNS32<<24) + 506) |
| Gets the full-well capacity of this sensor, measured in electrons. More... | |
| #define | PARAM_PAR_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 57) |
| The parallel size of the sensor chip, in active rows. More... | |
| #define | PARAM_SER_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 58) |
| The serial size of the sensor chip, in active columns. More... | |
| #define | PARAM_ACCUM_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 538) |
Returns TRUE for ATTR_AVAIL if the camera has accumulation capability. More... | |
| #define | PARAM_FLASH_DWNLD_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 539) |
| Reports if the camera supports firmware download. More... | |
| #define | PARAM_READOUT_TIME ((CLASS2<<16) + (TYPE_FLT64<<24) + 179) |
| Time it will take to read out the image from the sensor with the current camera settings, in microseconds. More... | |
| #define | PARAM_CLEARING_TIME ((CLASS2<<16) + (TYPE_INT64<<24) + 180) |
| This parameter reports the time needed to clear the sensor. More... | |
| #define | PARAM_POST_TRIGGER_DELAY ((CLASS2<<16) + (TYPE_INT64<<24) + 181) |
| Post-trigger delay, in nanoseconds. More... | |
| #define | PARAM_PRE_TRIGGER_DELAY ((CLASS2<<16) + (TYPE_INT64<<24) + 182) |
| Pre-trigger delay, in nanoseconds. More... | |
| #define | PARAM_CLEAR_CYCLES ((CLASS2<<16) + (TYPE_UNS16<<24) + 97) |
| Number of clear cycles. More... | |
| #define | PARAM_CLEAR_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 523) |
| Defines when clearing takes place. More... | |
| #define | PARAM_FRAME_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 509) |
| Reports frame transfer capability. More... | |
| #define | PARAM_PMODE ((CLASS2<<16) + (TYPE_ENUM <<24) + 524) |
| Parallel clocking method. More... | |
| #define | PARAM_TEMP ((CLASS2<<16) + (TYPE_INT16<<24) + 525) |
| Returns the current measured temperature of the sensor in hundredths of degrees Celsius. More... | |
| #define | PARAM_TEMP_SETPOINT ((CLASS2<<16) + (TYPE_INT16<<24) + 526) |
| Sets the desired sensor temperature in hundredths of degrees Celsius. More... | |
| #define | PARAM_CAM_FW_VERSION ((CLASS2<<16) + (TYPE_UNS16<<24) + 532) |
| Returns the firmware version of the camera, as a hexadecimal number. More... | |
| #define | PARAM_HEAD_SER_NUM_ALPHA ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 533) |
| Returns the alphanumeric serial number for the camera head. More... | |
| #define | PARAM_PCI_FW_VERSION ((CLASS2<<16) + (TYPE_UNS16<<24) + 534) |
| Returns the version number of the PCI firmware. More... | |
| #define | PARAM_FAN_SPEED_SETPOINT ((CLASS2<<16) + (TYPE_ENUM<<24) + 710) |
| Sets and gets the desired fan speed. More... | |
| #define | PARAM_CAM_SYSTEMS_INFO ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 536) |
| Returns description of all camera nodes. More... | |
| #define | PARAM_EXPOSURE_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 535) |
| The exposure/triggering mode. More... | |
| #define | PARAM_EXPOSE_OUT_MODE ((CLASS2<<16) + (TYPE_ENUM<<24) + 560) |
| The expose-out mode. More... | |
| #define | PARAM_BIT_DEPTH ((CLASS2<<16) + (TYPE_INT16<<24) + 511) |
| Pixel sample range in number of bits for the currently configured acquisition. More... | |
| #define | PARAM_IMAGE_FORMAT ((CLASS2<<16) + (TYPE_ENUM<<24) + 248) |
| Native image format of the camera pixel stream. More... | |
| #define | PARAM_IMAGE_COMPRESSION ((CLASS2<<16) + (TYPE_ENUM<<24) + 249) |
| Native image compression of the camera pixel stream. More... | |
| #define | PARAM_SCAN_MODE ((CLASS3<<16) + (TYPE_ENUM<<24) + 250) |
| Scan mode of the camera. More... | |
| #define | PARAM_SCAN_DIRECTION ((CLASS3<<16) + (TYPE_ENUM<<24) + 251) |
| Scan direction of the camera. More... | |
| #define | PARAM_SCAN_DIRECTION_RESET ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 252) |
| Scan direction reset state. More... | |
| #define | PARAM_SCAN_LINE_DELAY ((CLASS3<<16) + (TYPE_UNS16<<24) + 253) |
| Scan line delay value of the camera. More... | |
| #define | PARAM_SCAN_LINE_TIME ((CLASS3<<16) + (TYPE_INT64<<24) + 254) |
| Scan line time of the camera. More... | |
| #define | PARAM_SCAN_WIDTH ((CLASS3<<16) + (TYPE_UNS16<<24) + 255) |
| Scan width in number of lines. More... | |
| #define | PARAM_FRAME_ROTATE ((CLASS2<<16) + (TYPE_ENUM<<24) + 256) |
| Virtual frame rotation mode. More... | |
| #define | PARAM_FRAME_FLIP ((CLASS2<<16) + (TYPE_ENUM<<24) + 257) |
| Virtual frame flipping mode. More... | |
| #define | PARAM_GAIN_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 512) |
| Gain setting for the current speed choice. More... | |
| #define | PARAM_SPDTAB_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 513) |
| Selects the sensor readout speed from a table of available choices. More... | |
| #define | PARAM_GAIN_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 514) |
| Name of the currently selected Gain (via PARAM_GAIN_INDEX). More... | |
| #define | PARAM_SPDTAB_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 515) |
| Name of the currently selected Speed (via PARAM_SPDTAB_INDEX). More... | |
| #define | PARAM_READOUT_PORT ((CLASS2<<16) + (TYPE_ENUM<<24) + 247) |
| Sensor readout port being used by the currently selected speed. More... | |
| #define | PARAM_PIX_TIME ((CLASS2<<16) + (TYPE_UNS16<<24) + 516) |
| This is the actual speed for the currently selected speed choice. More... | |
| #define | PARAM_SHTR_CLOSE_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 519) |
| The shutter close delay. More... | |
| #define | PARAM_SHTR_OPEN_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 520) |
| The shutter open delay. More... | |
| #define | PARAM_SHTR_OPEN_MODE ((CLASS2<<16) + (TYPE_ENUM <<24) + 521) |
| The shutter opening condition. More... | |
| #define | PARAM_SHTR_STATUS ((CLASS2<<16) + (TYPE_ENUM <<24) + 522) |
| The state of the camera shutter. More... | |
| #define | PARAM_IO_ADDR ((CLASS2<<16) + (TYPE_UNS16<<24) + 527) |
| Sets and gets the currently active I/O address. More... | |
| #define | PARAM_IO_TYPE ((CLASS2<<16) + (TYPE_ENUM<<24) + 528) |
| Gets the type of I/O available at the current address. More... | |
| #define | PARAM_IO_DIRECTION ((CLASS2<<16) + (TYPE_ENUM<<24) + 529) |
| Gets the direction of the signal at the current address. More... | |
| #define | PARAM_IO_STATE ((CLASS2<<16) + (TYPE_FLT64<<24) + 530) |
| Sets and gets the state of the currently active I/O signal. More... | |
| #define | PARAM_IO_BITDEPTH ((CLASS2<<16) + (TYPE_UNS16<<24) + 531) |
| Gets the bit depth for the signal at the current address. More... | |
| #define | PARAM_GAIN_MULT_FACTOR ((CLASS2<<16) + (TYPE_UNS16<<24) + 537) |
| Gain multiplication factor for cameras with multiplication gain functionality. More... | |
| #define | PARAM_GAIN_MULT_ENABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 541) |
| Gain multiplier on/off indicator for cameras with the multiplication gain functionality. More... | |
| #define | PARAM_PP_FEAT_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 542) |
| This returns the name of the currently-selected post-processing feature. More... | |
| #define | PARAM_PP_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 543) |
| This selects the current post-processing feature from a table of available choices. More... | |
| #define | PARAM_ACTUAL_GAIN ((CLASS2<<16) + (TYPE_UNS16<<24) + 544) |
| Gets the actual e/ADU for the current gain setting. More... | |
| #define | PARAM_PP_PARAM_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 545) |
| This selects the current post-processing parameter from a table of available choices. More... | |
| #define | PARAM_PP_PARAM_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 546) |
| Gets the name of the currently-selected post-processing parameter for the currently-selected post-processing feature. More... | |
| #define | PARAM_PP_PARAM ((CLASS2<<16) + (TYPE_UNS32<<24) + 547) |
| This gets or sets the post-processing parameter for the currently-selected post-processing parameter in the index. More... | |
| #define | PARAM_READ_NOISE ((CLASS2<<16) + (TYPE_UNS16<<24) + 548) |
| Gets the read noise for the current speed. More... | |
| #define | PARAM_PP_FEAT_ID ((CLASS2<<16) + (TYPE_UNS16<<24) + 549) |
| This returns the ID of the currently-selected post-processing feature. More... | |
| #define | PARAM_PP_PARAM_ID ((CLASS2<<16) + (TYPE_UNS16<<24) + 550) |
| This returns the ID of the currently-selected post-processing parameter. More... | |
| #define | PARAM_SMART_STREAM_MODE_ENABLED ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 700) |
| This parameter allows the user to retrieve or set the state of the S.M.A.R.T. streaming mode. More... | |
| #define | PARAM_SMART_STREAM_MODE ((CLASS2<<16) + (TYPE_UNS16<<24) + 701) |
| This parameter allows the user to select between available S.M.A.R.T. streaming modes. More... | |
| #define | PARAM_SMART_STREAM_EXP_PARAMS ((CLASS2<<16) + (TYPE_VOID_PTR<<24) + 702) |
| This parameter allows to set or read the current exposure parameters for S.M.A.R.T. streaming. More... | |
| #define | PARAM_SMART_STREAM_DLY_PARAMS ((CLASS2<<16) + (TYPE_VOID_PTR<<24) + 703) |
| This parameter allows to set or read the current delays between exposures in S.M.A.R.T. streaming. More... | |
| #define | PARAM_EXP_TIME ((CLASS3<<16) + (TYPE_UNS16<<24) + 1) |
| Used to examine and change the exposure time in VTM only. More... | |
| #define | PARAM_EXP_RES ((CLASS3<<16) + (TYPE_ENUM<<24) + 2) |
| Gets the exposure resolution for the current resolution index. More... | |
| #define | PARAM_EXP_RES_INDEX ((CLASS3<<16) + (TYPE_UNS16<<24) + 4) |
| Gets and sets the index into the exposure resolution table. More... | |
| #define | PARAM_EXPOSURE_TIME ((CLASS3<<16) + (TYPE_UNS64<<24) + 8) |
| Used to examine current exposure time and range of valid values. More... | |
| #define | PARAM_BOF_EOF_ENABLE ((CLASS3<<16) + (TYPE_ENUM<<24) + 5) |
| Enables and configures the BOF/EOF interrupts. More... | |
| #define | PARAM_BOF_EOF_COUNT ((CLASS3<<16) + (TYPE_UNS32<<24) + 6) |
| Returns the Begin-Of-Frame and/or End-Of-Frame count. More... | |
| #define | PARAM_BOF_EOF_CLR ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 7) |
| Clears the BOF/EOF count when a pl_set_param is performed. More... | |
| #define | PARAM_CIRC_BUFFER ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 299) |
| Tests to see if the hardware/software can perform circular buffer. More... | |
| #define | PARAM_FRAME_BUFFER_SIZE ((CLASS3<<16) + (TYPE_UNS64<<24) + 300) |
| Retrieves the min, max, current and recommended (default) buffer size in bytes. More... | |
| #define | PARAM_BINNING_SER ((CLASS3<<16) + (TYPE_ENUM<<24) + 165) |
| Used to obtain serial part of serial x parallel binning factors permutations. More... | |
| #define | PARAM_BINNING_PAR ((CLASS3<<16) + (TYPE_ENUM<<24) + 166) |
| Used to obtain parallel part of serial x parallel binning factors permutations. More... | |
| #define | PARAM_METADATA_ENABLED ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 168) |
| Parameter used to enable or disable the embedded frame metadata feature. More... | |
| #define | PARAM_METADATA_RESET_TIMESTAMP ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 176) |
| Resets the camera-generated metadata timestamp. More... | |
| #define | PARAM_ROI_COUNT ((CLASS3<<16) + (TYPE_UNS16 <<24) + 169) |
| The number of currently configured ROIs. More... | |
| #define | PARAM_CENTROIDS_ENABLED ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 170) |
| This parameter is used to enable or disable the Centroids/Object detection feature. More... | |
| #define | PARAM_CENTROIDS_RADIUS ((CLASS3<<16) + (TYPE_UNS16 <<24) + 171) |
| This parameter is used to set the Centroid radius. More... | |
| #define | PARAM_CENTROIDS_COUNT ((CLASS3<<16) + (TYPE_UNS16 <<24) + 172) |
| Deals with number of Centroids. More... | |
| #define | PARAM_CENTROIDS_MODE ((CLASS3<<16) + (TYPE_ENUM <<24) + 173) |
| This parameter is used to retrieve and control the camera Centroid/Object detection modes. More... | |
| #define | PARAM_CENTROIDS_BG_COUNT ((CLASS3<<16) + (TYPE_ENUM <<24) + 174) |
| Supported Centroids background frame processing count. More... | |
| #define | PARAM_CENTROIDS_THRESHOLD ((CLASS3<<16) + (TYPE_UNS32 <<24) + 175) |
| Used to configure threshold multiplier for specific object detection modes. More... | |
| #define | PARAM_TRIGTAB_SIGNAL ((CLASS3<<16) + (TYPE_ENUM<<24) + 180) |
| Used to select the output signal to be configured. More... | |
| #define | PARAM_LAST_MUXED_SIGNAL ((CLASS3<<16) + (TYPE_UNS8<<24) + 181) |
| Used to set the number of active output signals. More... | |
| #define | PARAM_FRAME_DELIVERY_MODE ((CLASS3<<16) + (TYPE_ENUM <<24) + 400) |
| Deals with frame delivery modes. More... | |
| #define PARAM_ACCUM_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 538) |
Returns TRUE for ATTR_AVAIL if the camera has accumulation capability.
Accumulation functionality is provided with the FF plug-in.
Data type: rs_bool
| #define PARAM_ACTUAL_GAIN ((CLASS2<<16) + (TYPE_UNS16<<24) + 544) |
Gets the actual e/ADU for the current gain setting.
Data type: uns16
| #define PARAM_ADC_OFFSET ((CLASS2<<16) + (TYPE_INT16<<24) + 195) |
Bias offset voltage.
The units do not correspond to the output pixel values in any simple fashion (the conversion rate should be linear, but may differ from system to system) but a lower offset voltage will yield a lower value for all output pixels. Pixels brought below zero by this method will be clipped at zero. Pixels raised above saturation will be clipped at saturation. Before you can change the offset level, you must read the current offset level. The default offset level will also vary from system to system and may change with each speed and gain setting.
Data type: int16
Used to obtain parallel part of serial x parallel binning factors permutations.
It has to be always used in pair with PARAM_BINNING_SER parameter.
Data type: enum (int32)
Used to obtain serial part of serial x parallel binning factors permutations.
It has to be always used in pair with PARAM_BINNING_PAR parameter.
Data type: enum (int32)
| #define PARAM_BIT_DEPTH ((CLASS2<<16) + (TYPE_INT16<<24) + 511) |
Pixel sample range in number of bits for the currently configured acquisition.
The image bit depth may depend on currently selected PARAM_READOUT_PORT, PARAM_SPDTAB_INDEX, PARAM_GAIN_INDEX and other acquisition parameters. Please make sure to check this parameter before starting the acquisition, ideally after calling pl_exp_setup_seq or pl_exp_setup_cont.
Most Photometrics cameras transfer pixels in 16-bit words (uns16 type). However, some cameras are capable of transferring 8-bit data (uns8 type). Make sure to also check the PARAM_IMAGE_FORMAT parameter to discover what is the current camera pixel format.
This parameter indicate the number of valid bits within the transferred word or byte.
Data type: int16
| #define PARAM_BOF_EOF_CLR ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 7) |
Clears the BOF/EOF count when a pl_set_param is performed.
This is a write-only parameter.
Data type: rs_bool
| #define PARAM_BOF_EOF_COUNT ((CLASS3<<16) + (TYPE_UNS32<<24) + 6) |
Returns the Begin-Of-Frame and/or End-Of-Frame count.
BOF/EOF counting is enabled and configured with PARAM_BOF_EOF_ENABLE.
Data type: uns32
Enables and configures the BOF/EOF interrupts.
See PL_IRQ_MODES enum for all possible values.
Data type: enum (int32)
| #define PARAM_CAM_FW_VERSION ((CLASS2<<16) + (TYPE_UNS16<<24) + 532) |
Returns the firmware version of the camera, as a hexadecimal number.
The form is MMmm, where MM is the major version and mm is the minor version. For example, 0x0814 corresponds to version 8.20.
Data type: uns16
Returns a list of camera communication interface modes.
This for example returns whether the interface is fully capable of imaging or if it has limitations. Use the ATTR_CURRENT to retrieve the mode of the currently selected interface. Use the pl_get_enum_param function to retrieve the list of modes for all the camera supported interfaces.
The number of items reported by this parameter corresponds to the number of items reported by the PARAM_CAM_INTERFACE_TYPE. Using the pl_get_enum_param call one can build a table of camera interfaces and their modes, simply iterate through both parameters and build the table, for example:
| Enum index | Type id | Type string | Mode id | Mode string |
|---|---|---|---|---|
| 0 | 514 | "USB 2.0" | 1 | "Control" |
| 1 | 515 | "USB 3.0" | 2 | "Imaging" |
| 2 | 2051 | "PCIe x4" | 2 | "Imaging" |
Data type: enum (int32)
Returns a list of camera communication interfaces.
For example it can be USB 3.0, PCIe, etc. Use the ATTR_CURRENT to retrieve the currently selected interface. Use the pl_get_enum_param function to retrieve all camera supported interfaces.
Data type: enum (int32)
| #define PARAM_CAM_SYSTEMS_INFO ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 536) |
Returns description of all camera nodes.
The text is a multi-line and null-terminated string. The user must pass in a character array that is at least MAX_CAM_SYSTEMS_INFO_LEN elements long or dynamically allocated array to size returned for ATTR_COUNT attribute.
The format is the same as can be seen in output of VersionInformation tool.
Data type: char*
| #define PARAM_CAMERA_PART_NUMBER ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 133) |
The part number of the camera.
The part number is a null-terminated text string. The user must pass in a character array that is at least MAX_CAM_PART_NUM_LEN elements long.
Data type: char*
Supported Centroids background frame processing count.
This allows the camera to report supported selections for number of frames for dynamic background removal. The processing is optimized only for selected set of frames. Thus there is no related enumeration type with supported values for this parameter.
Data type: enum (int32)
| #define PARAM_CENTROIDS_COUNT ((CLASS3<<16) + (TYPE_UNS16 <<24) + 172) |
Deals with number of Centroids.
This read-write parameter is used to obtain the maximum supported number of Centroids and set the desired number of Centroids to the camera.
The camera usually supports a limited number of Centroids/objects to be detected. Use this parameter to limit the number of objects to be detected. For example in particle tracking mode the parameter will limit number of particles to be tracked
Data type: uns16
| #define PARAM_CENTROIDS_ENABLED ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 170) |
This parameter is used to enable or disable the Centroids/Object detection feature.
Use the PARAM_CENTROIDS_MODE to retrieve a list of camera supported object detection modes.
Data type: rs_bool
This parameter is used to retrieve and control the camera Centroid/Object detection modes.
In case the camera supports centroids but reports this parameter as not available, it supports only the PL_CENTROIDS_MODE_LOCATE feature. See PL_CENTROIDS_MODES enum for all possible values.
Data type: enum (int32)
| #define PARAM_CENTROIDS_RADIUS ((CLASS3<<16) + (TYPE_UNS16 <<24) + 171) |
This parameter is used to set the Centroid radius.
This read-write parameter is used to obtain the range of Centroids radii the camera supports. Use the ATTR_MIN and ATTR_MAX to retrieve the range.
The radius defines the distance from the center pixel. For example if the camera reports the radius range between 1 and 5 it means that the resulting ROIs can be configured to the following sizes: 1=3x3, 2=5x5, 3=7x7, 4=9x9, 5=11x11.
The parameter interpretation also depends on the selected Centroid/Object detection mode. In some modes the radius is used to set the size of the 'object' to be detected.
Use pl_set_param to set the desired Centroids radius. Once set, make sure to reconfigure the acquisition with pl_exp_setup_seq or pl_exp_setup_cont functions.
Data type: uns16
| #define PARAM_CENTROIDS_THRESHOLD ((CLASS3<<16) + (TYPE_UNS32 <<24) + 175) |
| #define PARAM_CHIP_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 129) |
The name of the sensor.
The name is a null-terminated text string. The user must pass in a character array that is at least CCD_NAME_LEN elements long.
Data type: char*
| #define PARAM_CIRC_BUFFER ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 299) |
Tests to see if the hardware/software can perform circular buffer.
When a TRUE is returned for ATTR_AVAIL attribute, the circular buffer function can be used.
Data type: rs_bool
| #define PARAM_CLEAR_CYCLES ((CLASS2<<16) + (TYPE_UNS16<<24) + 97) |
Number of clear cycles.
This is the number of times the sensor must be cleared to completely remove charge from the parallel register. The value is ignored in case the clearing mode is set to CLEAR_NEVER via PARAM_CLEAR_MODE parameter.
Data type: uns16
Defines when clearing takes place.
All the possible clearing modes are defined in PL_CLEAR_MODES enum. But keep in mind that some cameras might not support all the modes. Use pl_get_enum_param function to enumerate all the supported modes.
Data type: enum (int32)
| #define PARAM_CLEARING_TIME ((CLASS2<<16) + (TYPE_INT64<<24) + 180) |
This parameter reports the time needed to clear the sensor.
The time is reported in nanoseconds. This delay is incurred once prior to the acquisition when pre-sequence clearing mode is chosen by the application. The delay is incurred prior to every frame when the imaging application chooses pre-exposure clearing mode.
The value is valid only after pl_exp_setup_seq or pl_exp_setup_cont call.
Data type: long64
The color mode of the sensor.
This enum parameter provides a list of all possible color masks defined in PL_COLOR_MODES type. The real mask applied on sensor is reported as current value (ATTR_CURRENT). Take into account that for mono cameras this parameter is usually not available (for ATTR_AVAIL it returns FALSE) instead of reporting COLOR_NONE value.
Data type: enum (int32)
This is the type of cooling used by the current camera.
See PL_COOL_MODES enum for all possible values.
Data type: enum (int32)
| #define PARAM_DD_INFO ((CLASS0<<16) + (TYPE_CHAR_PTR<<24) + 5) |
Returns an information message for each device.
Some devices have no message. The user is responsible for allocating enough memory to hold the message string. Required number of bytes can be obtained via parameter PARAM_DD_INFO_LENGTH.
Data type: char*
| #define PARAM_DD_INFO_LENGTH ((CLASS0<<16) + (TYPE_INT16<<24) + 1) |
Returns the length of an information message for each device driver.
Some devices have no message. In other words, they return a value of 0 for bytes.
Data type: int16
| #define PARAM_DD_RETRIES ((CLASS0<<16) + (TYPE_UNS16<<24) + 3) |
Reads/sets the maximum number of command retransmission attempts that are allowed.
When a command or status transmission is garbled, the system signals for a re-transmission. After a certain number of failed transmissions (an initial attempt + max_retries), the system abandons the attempt and concludes that the communication link has failed. The camera will not close, but the command or status read returns with an error. The maximum number of retries is initially set by the device driver, and is matched to the communication link, hardware platform, and operating system. It may also be reset by the user.
Data type: uns16
| #define PARAM_DD_TIMEOUT ((CLASS0<<16) + (TYPE_UNS16<<24) + 4) |
Reads/sets the maximum time the driver waits for acknowledgment.
I.e., the slowest allowable response speed from the camera. This is a crucial factor used in the device driver for communication control. If the driver sends a command to the camera and does not receive acknowledgment within the timeout period, the driver times out and returns an error. Unless reset by the user, this timeout is a default setting that is contained in the device driver and is matched to the communication link, hardware platform, and operating system.
Data type: uns16
| #define PARAM_DD_VERSION ((CLASS0<<16) + (TYPE_UNS16<<24) + 2) |
Returns a version number for the device driver used to access the camera.
The version number is for information only. Application does not need to check the version or make decisions based on its value. Every PVCAM release is bundled with a specific set of device driver versions. PVCAM binaries and device driver binaries are usually tightly coupled and cannot be interchanged.
The version is a formatted hexadecimal number of the style:
| High byte | Low | byte |
|---|---|---|
| High nibble | Low nibble | |
| Major version | Minor version | Trivial version |
For example, the number 0xB1C0 indicates major release 177, minor release 12, and trivial change 0.
Open the camera before calling this parameter. Note that different cameras on the same system may use different drivers. Thus, each camera can have its own driver, and its own driver version.
Data type: uns16
Gets the exposure resolution for the current resolution index.
This parameter does exactly the same as PARAM_EXP_RES_INDEX but additionally provides human-readable string for each exposure resolution.
For some older cameras this parameter might not be available (ATTR_AVAIL returns FALSE). In this case camera uses EXP_RES_ONE_MILLISEC resolution.
Data type: enum (int32)
| #define PARAM_EXP_RES_INDEX ((CLASS3<<16) + (TYPE_UNS16<<24) + 4) |
Gets and sets the index into the exposure resolution table.
The table contains the resolutions supported by the camera. The value at this index is an enumerated type, representing different resolutions. The number of supported resolutions can be obtained by using the ATTR_COUNT attribute. See PL_EXP_RES_MODES enum for all possible values.
Data type: uns16
| #define PARAM_EXP_TIME ((CLASS3<<16) + (TYPE_UNS16<<24) + 1) |
Used to examine and change the exposure time in VTM only.
VTM is active if exposure mode is set to VARIABLE_TIMED_MODE. This value is limited to 16-bit. For higher exposure times separate single frame acquisitions, or SMART streaming (if available), have to be used.
Data type: uns16
The expose-out mode.
This parameter cannot be set but its value can be retrieved. The mode is set as a value combined with extended exposure mode via pl_exp_setup_seq or pl_exp_setup_cont function. See PL_EXPOSE_OUT_MODES enum for all possible values.
Data type: enum (int32)
The exposure/triggering mode.
This parameter cannot be set but its value can be retrieved. The mode is set as a value combined with expose-out mode via pl_exp_setup_seq or pl_exp_setup_cont function. See PL_EXPOSURE_MODES enum for all possible values.
Data type: enum (int32)
| #define PARAM_EXPOSURE_TIME ((CLASS3<<16) + (TYPE_UNS64<<24) + 8) |
Used to examine current exposure time and range of valid values.
The minimum and maximum value could be limited by camera HW. Use ATTR_MIN and ATTR_MAX to retrieve it. This parameter is always available but for older cameras not reporting their limits, the min. value is set to 0 and max. value is set to max. 32-bit range for backward compatibility. It means the range is not known (it does not mean there are no limits). In such case e.g. camera manual could specify some limits. Please note the reported value unit depends on currently selected exposure resolution (PARAM_EXP_RES).
Data type: ulong64
Sets and gets the desired fan speed.
Note that the camera can automatically adjust the fan speed to higher level due to sensor overheating or completely shut down power to the sensor board to protect camera from damage. The default fan speed is supposed to be changed only temporarily during experiments to reduce sound noise or vibrations.
Data type: enum (int32)
| #define PARAM_FLASH_DWNLD_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 539) |
Reports if the camera supports firmware download.
This parameter is for Photometrics internal use only. It is largely unused because we simply do it on all cameras now, thus it can become deprecated in future.
Data type: rs_bool
| #define PARAM_FRAME_BUFFER_SIZE ((CLASS3<<16) + (TYPE_UNS64<<24) + 300) |
Retrieves the min, max, current and recommended (default) buffer size in bytes.
It applies to currently configured acquisition. This parameter becomes available only after calling the pl_exp_setup_seq or pl_exp_setup_cont. For sequence acquisition the attribute always reports the full sequence size in bytes. For circular buffer acquisition use the ATTR_DEFAULT to retrieve the recommended buffer size.
Data type: ulong64
| #define PARAM_FRAME_CAPABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 509) |
Reports frame transfer capability.
Returns TRUE for ATTR_AVAIL if this camera can run in frame transfer mode (set through PARAM_PMODE).
Data type: rs_bool
Deals with frame delivery modes.
This parameter allows to switch among various frame delivery modes. If not available, camera runs in PL_FRAME_DELIVERY_MODE_MAX_FPS mode. See PL_FRAME_DELIVERY_MODES enum for all possible values.
Data type: enum (int32)
Virtual frame flipping mode.
This parameter controls PVCAM-internal frame flipping module. When enabled, PVCAM will automatically flip incoming frames based on the parameter setting. Please note that the frame flip setting affects the sensor reported color mask (PARAM_COLOR_MODE). For example, if flip-X is requested the sensor mask is also reported flipped: an RGGB sensor mask would be reported as GRBG mask.
If PARAM_METADATA_ENABLED is enabled the frame-embedded metadata is also adjusted automatically if needed. This applies for the metadata reported color mask value.
Legacy applications can set a system environment variable "PVCAM_FRAME_FLIP_MODE" to one of the following values: X, Y, XY or NONE. If set, sensors of all PVCAM cameras in the system will become virtually flipped and all sensor-related parameters will be reported appropriately flipped as well.
A multi-threaded algorithm is used for image flipping. The delay introduced by the algorithm depends on CPU performance. An Intel Xeon W-2123 processor can flip a 2048x2048 16-bit image in approximately 1ms.
This parameter can be used together with PARAM_FRAME_ROTATE. When both parameters are enabled, PVCAM uses an algorithm that processes the rotation/flipping combination using only one pass, keeping the performance withing 1-2ms on the same CPU.
Data type: enum (int32)
Virtual frame rotation mode.
This parameter controls PVCAM-internal frame rotation module. When enabled, PVCAM will automatically rotate incoming frames based on the parameter setting. Please note that the frame rotation setting affects other parameters: PARAM_SER_SIZE, PARAM_PAR_SIZE, PARAM_BINNING_SER, PARAM_BINNING_PAR and PARAM_COLOR_MODE. For example, if a 90 degree rotation is requested the affected parameters will return appropriately swapped or rotated values, application should re-read the affected parameters after every change in PARAM_FRAME_ROTATE.
If PARAM_METADATA_ENABLED is enabled the frame-embedded metadata is also adjusted automatically if needed. This applies for the metadata reported ROI and color mask.
Legacy applications can set a system environment variable "PVCAM_FRAME_ROTATE_MODE" to one of the following values: 90, 180, 270 or 0. If set, sensors of all PVCAM cameras in the system will become virtually rotated and all sensor-related parameters will be reported appropriately rotated as well.
A multi-threaded block-rotate algorithm is used for image rotation. The delay introduced by the algorithm depends on CPU performance. An Intel Xeon W-2123 processor can rotate a 2048x2048 16-bit image in approximately 1.5ms.
This parameter can be used together with PARAM_FRAME_FLIP. When both parameters are enabled, PVCAM uses an algorithm that processes the rotation/flipping combination using only one pass, keeping the performance withing 1-2ms on the same CPU.
Data type: enum (int32)
| #define PARAM_FWELL_CAPACITY ((CLASS2<<16) + (TYPE_UNS32<<24) + 506) |
Gets the full-well capacity of this sensor, measured in electrons.
Data type: uns32
| #define PARAM_GAIN_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 512) |
Gain setting for the current speed choice.
The valid range for a gain setting is reported via ATTR_MIN and ATTR_MAX, where the min. gain is usually 1 and the max. gain may be as high as 16. Values outside this range will be ignored. Note that gain setting may not be linear! Values 1-16 may not correspond to 1x-16x, and there are gaps between the values. However, when the camera is initialized, and every time a new speed is selected, the system will always reset to run at a gain of 1x.
After setting the parameter the PARAM_GAIN_NAME can be used to retrieve user friendly description of the selected gain (if supported by camera).
Data type: int16
| #define PARAM_GAIN_MULT_ENABLE ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 541) |
Gain multiplier on/off indicator for cameras with the multiplication gain functionality.
This parameter is read-only and its value is always TRUE if it is available on the camera.
Data type: rs_bool
| #define PARAM_GAIN_MULT_FACTOR ((CLASS2<<16) + (TYPE_UNS16<<24) + 537) |
| #define PARAM_GAIN_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 514) |
Name of the currently selected Gain (via PARAM_GAIN_INDEX).
Use ATTR_AVAIL to check for the availability. The gain name has a maximum length of MAX_GAIN_NAME_LEN and can be retrieved with the ATTR_CURRENT attribute.
Data type: char*
| #define PARAM_HEAD_SER_NUM_ALPHA ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 533) |
Returns the alphanumeric serial number for the camera head.
The serial number for Photometrics-branded cameras has a maximum length of MAX_ALPHA_SER_NUM_LEN.
Data type: char*
Native image compression of the camera pixel stream.
This parameter is used to retrieve the list of camera supported image compression modes. The compression mode may depend on currently selected port and speed combination. It is advised to check the compression mode before starting the acquisition. Some cameras allow the native compression to be selected. Use the ATTR_ACCESS to check the write permissions.
Data type: enum (int32)
Native image format of the camera pixel stream.
This parameter is used to retrieve the list of camera supported image formats. The image format may depend on current camera configuration. It is advised to check the image format before starting the acquisition. Some cameras allow the native format to be selected. Use the ATTR_ACCESS to check the write permissions.
Data type: enum (int32)
| #define PARAM_IO_ADDR ((CLASS2<<16) + (TYPE_UNS16<<24) + 527) |
Sets and gets the currently active I/O address.
The number of available I/O addresses can be obtained using the ATTR_COUNT.
Data type: uns16
| #define PARAM_IO_BITDEPTH ((CLASS2<<16) + (TYPE_UNS16<<24) + 531) |
Gets the bit depth for the signal at the current address.
The bit depth has different meanings, depending on the I/O Type:
Data type: uns16
Gets the direction of the signal at the current address.
See PL_IO_DIRECTION enum for all possible values.
Data type: enum (int32)
| #define PARAM_IO_STATE ((CLASS2<<16) + (TYPE_FLT64<<24) + 530) |
Sets and gets the state of the currently active I/O signal.
The new (when setting) or return (when getting) value has different meanings, depending on the I/O type:
The minimum and maximum range for the signal can be obtained using the ATTR_MIN and ATTR_MAX attributes, respectively.
When outputting signals, the state is the desired output. For example, when setting the output of a 12-bit DAC with a range of 0-5V to half-scale, the state should be 2.5 (volts), not 1024 (bits).
Data type: flt64
Gets the type of I/O available at the current address.
See PL_IO_TYPE enum for all possible values.
Data type: enum (int32)
Used to set the number of active output signals.
The chosen number of signals is then used by multiplexer for the signal selected by PARAM_TRIGTAB_SIGNAL parameter.
Data type: uns8
| #define PARAM_METADATA_ENABLED ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 168) |
Parameter used to enable or disable the embedded frame metadata feature.
Once enabled, the acquired frames will contain additional information describing the frame.
Data type: rs_bool
| #define PARAM_METADATA_RESET_TIMESTAMP ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 176) |
Resets the camera-generated metadata timestamp.
In normal operation, the timestamp is reset upon camera power up. Use this parameter to reset the timestamp when needed. This is a write-only paremeter, use pl_set_param with TRUE value to rest the timestamp.
Data type: rs_bool
Indicates whether this sensor runs in MPP mode.
See PL_MPP_MODES enum for all possible values.
Data type: enum (int32)
| #define PARAM_PAR_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 57) |
The parallel size of the sensor chip, in active rows.
In most cases this parameter reports the height of the sensor imaging area or the number of rows in CMOS type sensor.
The full size of the parallel register is actually (par_size + premask + postmask).
Data type: uns16
| #define PARAM_PCI_FW_VERSION ((CLASS2<<16) + (TYPE_UNS16<<24) + 534) |
Returns the version number of the PCI firmware.
This number is a single 16-bit unsigned value.
Data type: uns16
| #define PARAM_PIX_PAR_DIST ((CLASS2<<16) + (TYPE_UNS16<<24) + 500) |
This is the center-to-center distance between pixels in the parallel direction.
It is measured in nanometers. This is identical to PARAM_PIX_PAR_SIZE if there are no inter-pixel dead areas.
Data type: uns16
| #define PARAM_PIX_PAR_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 63) |
This is the size of the active area of a pixel, in the parallel direction.
Reported in nanometers.
Data type: uns16
| #define PARAM_PIX_SER_DIST ((CLASS2<<16) + (TYPE_UNS16<<24) + 501) |
This is the center-to-center distance between pixels in the serial direction.
Reported in nanometers. This is identical to PARAM_PIX_SER_SIZE, if there are no dead areas.
Data type: uns16
| #define PARAM_PIX_SER_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 62) |
This is the size of the active area of a pixel in the serial direction.
Reported in nanometers.
Data type: uns16
| #define PARAM_PIX_TIME ((CLASS2<<16) + (TYPE_UNS16<<24) + 516) |
This is the actual speed for the currently selected speed choice.
It returns the time for each pixel, in nanoseconds. This value may change as new speed choices are selected.
Data type: uns16
| #define PARAM_POST_TRIGGER_DELAY ((CLASS2<<16) + (TYPE_INT64<<24) + 181) |
Post-trigger delay, in nanoseconds.
In addition to the PARAM_CLEARING_TIME, there might be a delay between an internal or external trigger and the transition event (low to high) for the Expose Out signal. This happens, for example, in global all rows expose out mode in which case the value is equal to readout time.
The value is valid only after pl_exp_setup_seq or pl_exp_setup_cont call.
Data type: long64
| #define PARAM_POSTMASK ((CLASS2<<16) + (TYPE_UNS16<<24) + 54) |
The number of masked lines at the far end of the parallel register.
It's away from the serial register. This is the number of additional parallel shifts that need to be done after readout to clear the parallel register.
Data type: uns16
| #define PARAM_POSTSCAN ((CLASS2<<16) + (TYPE_UNS16<<24) + 56) |
The number of pixels to discard from the serial register after the last real data pixel.
These must be read or discarded to clear the serial register.
Data type: uns16
| #define PARAM_PP_FEAT_ID ((CLASS2<<16) + (TYPE_UNS16<<24) + 549) |
This returns the ID of the currently-selected post-processing feature.
This maps a specific post-processing module across cameras to help applications filter for camera features they need to expose and those that they don't. It helps to identify similarities between camera post-processing features.
Data type: uns32
| #define PARAM_PP_FEAT_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 542) |
This returns the name of the currently-selected post-processing feature.
The name is a null-terminated text string. User is responsible for buffer allocation with at least MAX_PP_NAME_LEN bytes.
Data type: char*
| #define PARAM_PP_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 543) |
This selects the current post-processing feature from a table of available choices.
The entries are 0-based and the range of possible values is 0 to max_entries. max_entries can be determined with the ATTR_MAX attribute. This setting relates to other post-processing table values, including PARAM_PP_FEAT_NAME, PARAM_PP_FEAT_ID and PARAM_PP_PARAM_INDEX.
Data type: int16
| #define PARAM_PP_PARAM ((CLASS2<<16) + (TYPE_UNS32<<24) + 547) |
This gets or sets the post-processing parameter for the currently-selected post-processing parameter in the index.
Data type: uns32
| #define PARAM_PP_PARAM_ID ((CLASS2<<16) + (TYPE_UNS16<<24) + 550) |
This returns the ID of the currently-selected post-processing parameter.
This maps a specific post-processing parameter across cameras to help applications filter for camera features they need to expose and those that they don't. It helps to identify similarities between camera post-processing features.
Data type: uns32
| #define PARAM_PP_PARAM_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 545) |
This selects the current post-processing parameter from a table of available choices.
The entries are 0-based and the range of possible values is 0 to max_entries. max_entries can be determined with the ATTR_MAX attribute. This setting relates to other post-processing table values, including PARAM_PP_PARAM_NAME, PARAM_PP_PARAM_ID and PARAM_PP_PARAM.
Data type: int16
| #define PARAM_PP_PARAM_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 546) |
Gets the name of the currently-selected post-processing parameter for the currently-selected post-processing feature.
The name is a null-terminated text string. User is responsible for buffer allocation with at least MAX_PP_NAME_LEN bytes.
Data type: char*
| #define PARAM_PRE_TRIGGER_DELAY ((CLASS2<<16) + (TYPE_INT64<<24) + 182) |
Pre-trigger delay, in nanoseconds.
For pre-exposure clearing mode and the first frame in pre-sequence clearing mode the frame cycle time is the sum of PARAM_EXPOSURE_TIME, PARAM_PRE_TRIGGER_DELAY, PARAM_POST_TRIGGER_DELAY and PARAM_CLEARING_TIME.
For second and subsequent frames in pre-sequence clearing mode (most typical scenario) the frame cycle time is the sum of PARAM_EXPOSURE_TIME, PARAM_PRE_TRIGGER_DELAY and PARAM_POST_TRIGGER_DELAY.
Frame cycle time is defined as the interval between start of exposure for one frame and the start of exposure for the next frame when the camera is in internal triggered (timed) mode and set up for continuous (circular buffer) acquisition.
The value is valid only after pl_exp_setup_seq or pl_exp_setup_cont call.
Data type: long64
| #define PARAM_PREAMP_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 502) |
The number of milliseconds required for the sensor output preamp to stabilize, after it is turned on.
Data type: uns16
| #define PARAM_PREAMP_OFF_CONTROL ((CLASS2<<16) + (TYPE_UNS32<<24) + 507) |
The exposure time limit in milliseconds above which the preamp is turned off during exposure.
Data type: uns32
| #define PARAM_PREMASK ((CLASS2<<16) + (TYPE_UNS16<<24) + 53) |
The number of masked lines at the near end of the parallel register.
It is next to the serial register. 0 means no mask (no normal mask). If the pre-mask is equal to par_size, this probably indicates a frame transfer device with an ordinary mask. Accordingly, the sensor should probably be run in frame transfer mode.
Data type: uns16
| #define PARAM_PRESCAN ((CLASS2<<16) + (TYPE_UNS16<<24) + 55) |
The number of pixels discarded from the serial register before the first real data pixel.
Data type: uns16
| #define PARAM_PRODUCT_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 132) |
The name of the product.
The name is a null-terminated text string. The user must pass in a character array that is at least MAX_PRODUCT_NAME_LEN elements long. This is meant to report camera name such as "Prime 95B" or "Retiga R6". OEMs should also consider using this for branding their cameras.
Data type: char*
| #define PARAM_READ_NOISE ((CLASS2<<16) + (TYPE_UNS16<<24) + 548) |
Gets the read noise for the current speed.
Data type: uns16
Sensor readout port being used by the currently selected speed.
Different readout ports (used for alternate speeds) flip the image in serial, parallel, or both.
Data type: enum (int32)
| #define PARAM_READOUT_TIME ((CLASS2<<16) + (TYPE_FLT64<<24) + 179) |
Time it will take to read out the image from the sensor with the current camera settings, in microseconds.
Settings have to be applied with pl_exp_setup_seq or pl_exp_setup_cont before the camera will calculate the readout time for the new settings.
Data type: uns32
| #define PARAM_ROI_COUNT ((CLASS3<<16) + (TYPE_UNS16 <<24) + 169) |
The number of currently configured ROIs.
The ATTR_CURRENT returns the currently configured number of ROIs set via pl_exp_setup_seq or pl_exp_setup_cont functions. The ATTR_MAX can be used to retrieve the maximum number of ROIs the camera supports.
Data type: uns16
Scan direction of the camera.
This parameter is used to retrieve list of camera supported scan directions.
Data type: enum (int32)
| #define PARAM_SCAN_DIRECTION_RESET ((CLASS3<<16) + (TYPE_BOOLEAN<<24) + 252) |
Scan direction reset state.
This parameter is used to retrieve scan direction reset state of camera. The parameter is used with alternate scan directions (down-up) to reset the direction with every acquisition.
Data type: boolean (rs_bool)
| #define PARAM_SCAN_LINE_DELAY ((CLASS3<<16) + (TYPE_UNS16<<24) + 253) |
Scan line delay value of the camera.
This parameter is used to retrieve or set the scan line delay. The parameter access mode depends on the PARAM_SCAN_MODE selection.
Data type: uns16 (uns16)
| #define PARAM_SCAN_LINE_TIME ((CLASS3<<16) + (TYPE_INT64<<24) + 254) |
Scan line time of the camera.
This parameter is used to retrieve scan line time of camera. The time is reported in nanoseconds.
Please note the parameter value should be retrieved after the call to pl_exp_setup_seq or pl_exp_setup_cont because the camera needs to know the actual acquisition configuration in order to calculate the value.
Data type: long64 (long64)
Scan mode of the camera.
This parameter is used to retrieve and control the camera supported scan modes. Please note that the PARAM_SCAN_LINE_DELAY and PARAM_SCAN_WIDTH access mode depends on the scan mode selection.
If the mode is set to PL_SCAN_MODE_PROGRAMMABLE_SCAN_WIDTH then the PARAM_SCAN_WIDTH can be controlled and the PARAM_SCAN_LINE_DELAY becomes read-only. If the mode is set to PL_SCAN_MODE_PROGRAMMABLE_LINE_DELAY then the PARAM_SCAN_LINE_DELAY can be controlled and the PARAM_SCAN_WIDTH becomes read-only. In both cases the PARAM_SCAN_LINE_TIME reports the total time it takes to read one sensor line (row), including any delay added with the parameters above.
Data type: enum (int32)
| #define PARAM_SCAN_WIDTH ((CLASS3<<16) + (TYPE_UNS16<<24) + 255) |
Scan width in number of lines.
This parameter is used to retrieve scan width of camera.
Data type: uns16 (uns16)
| #define PARAM_SER_SIZE ((CLASS2<<16) + (TYPE_UNS16<<24) + 58) |
The serial size of the sensor chip, in active columns.
In most cases this parameter reports the width of the sensor imaging area or the number of columns in CMOS type sensor.
Data type: uns16
| #define PARAM_SHTR_CLOSE_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 519) |
The shutter close delay.
This is the number of milliseconds required for the shutter to close. The software default values compensate for the standard shutter that is shipped with all cameras. You only need to set this value if you are using a shutter with characteristics that differ from the standard shutter.
Data type: uns16
| #define PARAM_SHTR_OPEN_DELAY ((CLASS2<<16) + (TYPE_UNS16<<24) + 520) |
The shutter open delay.
This is the number of milliseconds required for the shutter to open. The software default values compensate for the standard shutter that is shipped with all cameras. You only need to set this value if you are using a shutter with characteristics that differ from the standard shutter.
Data type: uns16
The shutter opening condition.
See PL_SHTR_OPEN_MODES enum for all possible values.
Data type: enum (int32)
The state of the camera shutter.
If the shutter is run too fast, it will overheat and trigger SHTR_FAULT. The shutter electronics will disconnect until the temperature returns to a suitable range. Note that although the electronics have reset the voltages to open or close the shutter, there is a lag time for the physical mechanism to respond. See also PARAM_SHTR_OPEN_DELAY and PARAM_SHTR_CLOSE_DELAY. See PL_SHTR_MODES enum for all possible values.
Data type: enum (int32)
| #define PARAM_SMART_STREAM_DLY_PARAMS ((CLASS2<<16) + (TYPE_VOID_PTR<<24) + 703) |
This parameter allows to set or read the current delays between exposures in S.M.A.R.T. streaming.
Data type: smart_stream_type*
FALSE. | #define PARAM_SMART_STREAM_EXP_PARAMS ((CLASS2<<16) + (TYPE_VOID_PTR<<24) + 702) |
This parameter allows to set or read the current exposure parameters for S.M.A.R.T. streaming.
Data type: smart_stream_type*
| #define PARAM_SMART_STREAM_MODE ((CLASS2<<16) + (TYPE_UNS16<<24) + 701) |
This parameter allows the user to select between available S.M.A.R.T. streaming modes.
See PL_SMT_MODES enum for all possible values. Currently the only available mode is SMTMODE_ARBITRARY_ALL.
Data type: uns16
| #define PARAM_SMART_STREAM_MODE_ENABLED ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 700) |
This parameter allows the user to retrieve or set the state of the S.M.A.R.T. streaming mode.
When a TRUE is returned by the camera, S.M.A.R.T. streaming is enabled.
Data type: rs_bool
| #define PARAM_SPDTAB_INDEX ((CLASS2<<16) + (TYPE_INT16<<24) + 513) |
Selects the sensor readout speed from a table of available choices.
Entries are 0-based and the range of possible values is 0 to max_entries, where max_entries can be determined using ATTR_MAX attribute. This setting relates to other speed table values, including PARAM_BIT_DEPTH, PARAM_PIX_TIME, PARAM_READOUT_PORT, PARAM_GAIN_INDEX and PARAM_GAIN_NAME. After setting PARAM_SPDTAB_INDEX, the gain setting is always reset to a value corresponding to 1x gain. To use a different gain setting, call pl_set_param with PARAM_GAIN_INDEX after setting the speed table index.
After setting the parameter the PARAM_SPDTAB_NAME can be used to retrieve user friendly description of the selected speed (if supported by camera).
Data type: int16
| #define PARAM_SPDTAB_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 515) |
Name of the currently selected Speed (via PARAM_SPDTAB_INDEX).
Use ATTR_AVAIL to check for the availability. The speed name has a maximum length of MAX_SPDTAB_NAME_LEN and can be retrieved with the ATTR_CURRENT attribute.
Data type: char*
| #define PARAM_SUMMING_WELL ((CLASS2<<16) + (TYPE_BOOLEAN<<24) + 505) |
Checks to see if the summing well exists.
When a TRUE is returned for ATTR_AVAIL, the summing well exists.
Data type: rs_bool
| #define PARAM_SYSTEM_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 130) |
The name of the system.
The name is a null-terminated text string. The user must pass in a character array that is at least MAX_SYSTEM_NAME_LEN elements long. It is meant to replace PARAM_CHIP_NAME behavior on some cameras which were reporting their friendly product name with this parameter, and in turn help future cameras go back to reporting the name of the sensor with PARAM_CHIP_NAME.
Data type: char*
| #define PARAM_TEMP ((CLASS2<<16) + (TYPE_INT16<<24) + 525) |
Returns the current measured temperature of the sensor in hundredths of degrees Celsius.
For example, a temperature of minus 35°C would be read as -3500.
Data type: int16
| #define PARAM_TEMP_SETPOINT ((CLASS2<<16) + (TYPE_INT16<<24) + 526) |
Sets the desired sensor temperature in hundredths of degrees Celsius.
E.g. -35°C is represented as -3500. The hardware attempts to heat or cool the sensor to this temperature. The min/max allowable temperatures are given ATTR_MIN and ATTR_MAX. Settings outside this range are ignored. Note that this function only sets the desired temperature. Even if the desired temperature is within a legal range, it still may be impossible to achieve. If the ambient temperature is too high, it is difficult to get sufficient cooling on an air-cooled camera.
Data type: int16
Used to select the output signal to be configured.
The configuration of number of active outputs is done via PARAM_LAST_MUXED_SIGNAL parameter. See PL_TRIGTAB_SIGNALS enum for all possible values.
Data type: enum (int32)
| #define PARAM_VENDOR_NAME ((CLASS2<<16) + (TYPE_CHAR_PTR<<24) + 131) |
The name of the vendor.
The name is a null-terminated text string. The user must pass in a character array that is at least MAX_VENDOR_NAME_LEN elements long. This is meant to differentiate between "QImaging" and "Photometrics" products moving forward.
Data type: char*
