Page History

Class _pdsdata.camera.FrameFexConfigV1

Python wrapper for pdsdata/camera/FrameFexConfigV1 class.

Enum Forwarding

This enum is an embedded type of FrameFexConfigV1 class. Following enum members are defined currently:

• FrameFexConfigV1.Forwarding.NoFrame
• FrameFexConfigV1.Forwarding.FullFrame
• FrameFexConfigV1.Forwarding.RegionOfInterest

Enum Processing

This enum is an embedded type of FrameFexConfigV1 class. Following enum members are defined currently:

• FrameFexConfigV1.Processing.NoProcessing
• FrameFexConfigV1.Forwarding.GssFullFrame
• {{FrameFexConfigV1.Forwarding.GssRegionOfInterest
• FrameFexConfigV1.Forwarding.GssThreshold

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method forwarding()

Usage: val = config.forwarding()

Returns forwarding policy for frame data as enum FrameFexConfigV1.Forwarding.

Method forward_prescale()

Usage: val = config.forward_prescale()

Returns prescale of events with forwarded frames as integer number.

Method processing()

Usage: val = config.processing()

Returns algorithm to apply to frames to produce processed output as enum FrameFexConfigV1.Processing.

Method roiBegin()

Usage: coord = config.roiBegin()

Returns coordinates of start of rectangular region of interest (inclusive) as camera.FrameCoord.

Method roiEnd()

Usage: coord = config.roiEnd()

Returns coordinates of finish of rectangular region of interest (exclusive) as camera.FrameCoord.

Method threshold()

Usage: val = config.threshold()

Returns pixel data threshold value to apply in processing as integer number.

Method number_of_masked_pixels()

Usage: val = config.number_of_masked_pixels()

Returns count of masked pixels to exclude from processing as integer number.

Method masked_pixel_coordinates()

Usage: list = config.masked_pixel_coordinates()

Returns Python list of masked pixel coordinates, items in the list have type camera.FrameCoord.

Method size()

Usage: size = config.size()

Returns size of this structure (including appended masked pixel coordinates).