Professional Documents
Culture Documents
The descriptions of each register will tell you what they do, but some processes span multiple registers, this
document covers those processes. This document applies to US based X and A series science cameras with
GenICam support (for instance the X6900sc and A6700sc).
FILE TRANSFERS
Note: Over GigE these register names have Camera prefixed to it, over CXP the registers are named as listed.
To transfer a file from the PC to the camera:
The camera also supports on the fly ZLib compression. This is enabled by setting FileCompression to ZLib. The
camera compresses or decompresses the file on the fly, so the compressed size is not known before the transfer
starts. However, the file is transferred as though it was compressed before the transfer started. This means each
FileAccessBuffer contains length of FileAccessBuffer bytes of compressed data, except for the last transfer. When
uploading transfer all the blocks of compressed data. When downloading transfer full blocks until ZLib indicates
the stream is done decompressing.
DIRECTORY LISTS
• Set DirectorySelector and DirectoryName to the directory you want to list.
o Some directories are directly selectable with just DirectorySelector, some also need
DirectoryName.
o For instance, to select the non-uniformity correction directory:
▪ Set DirectorySelector to Correction
• Set DirectoryOperationSelector to List
• Execute DirectoryOperationExecute and wait for it to finish.
• Check DirectoryOperationStatus, if it is not Success there was an error
• For each index between zero and DirectoryEntryIndexMax inclusive do:
o Set DirectoryEntryIndex to the current index
o Get DirectoryEntryName, DirectoryEntrySize, DirectoryEntryAttrib, DirectoryEntryModifiedTime
NUC PROCESS
The process varies depending on which options you select, but at its core the process is:
LOADING A NUC
• Set PSXCorrectionLoadName to the name of the NUC you want to load (as read from above)
• Execute PSXCorrectionLoad
ENUMERATING CALIBRATIONS
• For each index between zero and CalibrationQueryIndexMax inclusive do:
o Set CalibrationQueryIndex to the current index
o Get detailed information by reading CalibrationQuery* registers
LOADING A CALIBRATION
• Set PSXCalibrationLoadName to the tag of the calibration you want to load (as read from above)
• Execute PSXCalibrationLoad
GENICAM REGISTERS
The following is a list of GenICam registers extracted from the GenICam XML file. The XML file is the definitive
source, but this list can help if you do not have a camera. Not all camera models support all features, so some
registers below may not apply to your camera.
CameraControl
CameraControl/BadPixelPicker
CameraControl/Calibration
CameraControl/Calibration/CalibrationQuery
CameraControl/Correction
CameraControl/Correction/CorrectionAuto
CameraControl/Correction/CorrectionPerform
CameraControl/Correction/CorrectionQuery
CameraControl/FilterWheel
CameraControl/FilterWheel/Config
CameraControl/FilterWheel/FilterInfo
CameraControl/Flag
CameraControl/Focus
CameraControl/FOV
CameraControl/LensState
CameraControl/Lockin
CameraControl/SaveState
CameraControl/SSD
CameraControl/SSD/MovieQuery
CameraControl/Video
CameraControl/Video/Palette
CameraControl/Video/VideoAGC
CameraControl/Video/VideoOverlay
CameraFileAccessControl
CameraInformation
DeviceControl
DirectoryAccessControl
ImageFormatControl
ImageStreamControl
ObjectParameters