File frame.h

↰ Parent directory (include/libcaer/events)

Definition (include/libcaer/events/frame.h)

• Program Listing for File frame.h

Detailed Description

Frame Events format definition and handling functions. This event type encodes intensity frames, like you would get from a normal APS camera. It supports multiple channels for color, color filter information, as well as multiple Regions of Interest (ROI). The (0, 0) pixel is in the upper left corner of the screen, like in OpenCV/computer graphics. The pixel array is laid out row by row (increasing X axis), going from top to bottom (increasing Y axis). To copy a frame event, the usual assignment operator = cannot be used. Please use caerGenericEventCopy() to copy frame events!

Includes

• common.h (File common.h)

Included By

• File davis.h

• File frame_utils.h

• File frame.hpp

Enums

• Enum caer_frame_event_color_channels

• Enum caer_frame_event_color_filter

Functions

• Function caerFrameEventGetChannelNumber

• Function caerFrameEventGetColorFilter

• Function caerFrameEventGetExposureLength

• Function caerFrameEventGetLengthX

• Function caerFrameEventGetLengthY

• Function caerFrameEventGetPixel

• Function caerFrameEventGetPixelArrayUnsafe

• Function caerFrameEventGetPixelArrayUnsafeConst

• Function caerFrameEventGetPixelForChannel

• Function caerFrameEventGetPixelForChannelUnsafe

• Function caerFrameEventGetPixelsMaxIndex

• Function caerFrameEventGetPixelsSize

• Function caerFrameEventGetPixelUnsafe

• Function caerFrameEventGetPositionX

• Function caerFrameEventGetPositionY

• Function caerFrameEventGetROIIdentifier

• Function caerFrameEventGetTimestamp

• Function caerFrameEventGetTimestamp64

• Function caerFrameEventGetTSEndOfExposure

• Function caerFrameEventGetTSEndOfExposure64

• Function caerFrameEventGetTSEndOfFrame

• Function caerFrameEventGetTSEndOfFrame64

• Function caerFrameEventGetTSStartOfExposure

• Function caerFrameEventGetTSStartOfExposure64

• Function caerFrameEventGetTSStartOfFrame

• Function caerFrameEventGetTSStartOfFrame64

• Function caerFrameEventInvalidate

• Function caerFrameEventIsValid

• Function caerFrameEventPacketAllocate

• Function caerFrameEventPacketAllocateNumPixels

• Function caerFrameEventPacketFromPacketHeader

• Function caerFrameEventPacketFromPacketHeaderConst

• Function caerFrameEventPacketGetEvent

• Function caerFrameEventPacketGetEventConst

• Function caerFrameEventPacketGetPixelsMaxIndex

• Function caerFrameEventPacketGetPixelsSize

• Function caerFrameEventSetColorFilter

• Function caerFrameEventSetLengthXLengthYChannelNumber

• Function caerFrameEventSetPixel

• Function caerFrameEventSetPixelForChannel

• Function caerFrameEventSetPixelForChannelUnsafe

• Function caerFrameEventSetPixelUnsafe

• Function caerFrameEventSetPositionX

• Function caerFrameEventSetPositionY

• Function caerFrameEventSetROIIdentifier

• Function caerFrameEventSetTSEndOfExposure

• Function caerFrameEventSetTSEndOfFrame

• Function caerFrameEventSetTSStartOfExposure

• Function caerFrameEventSetTSStartOfFrame

• Function caerFrameEventValidate

• Function PACKED_STRUCT(struct caer_frame_event { uint32_t info;int32_t ts_startframe;int32_t ts_endframe;int32_t ts_startexposure;int32_t ts_endexposure;int32_t lengthX;int32_t lengthY;int32_t positionX;int32_t positionY;uint16_t pixels[1];})

• Function PACKED_STRUCT(struct caer_frame_event_packet { struct caer_event_packet_header packetHeader;})

Defines

• Define CAER_FRAME_CONST_ITERATOR_ALL_START

• Define CAER_FRAME_CONST_ITERATOR_VALID_START

• Define CAER_FRAME_CONST_REVERSE_ITERATOR_ALL_START

• Define CAER_FRAME_CONST_REVERSE_ITERATOR_VALID_START

• Define CAER_FRAME_ITERATOR_ALL_END

• Define CAER_FRAME_ITERATOR_ALL_START

• Define CAER_FRAME_ITERATOR_VALID_END

• Define CAER_FRAME_ITERATOR_VALID_START

• Define CAER_FRAME_REVERSE_ITERATOR_ALL_END

• Define CAER_FRAME_REVERSE_ITERATOR_ALL_START

• Define CAER_FRAME_REVERSE_ITERATOR_VALID_END

• Define CAER_FRAME_REVERSE_ITERATOR_VALID_START

• Define FRAME_COLOR_CHANNELS_MASK

• Define FRAME_COLOR_CHANNELS_SHIFT

• Define FRAME_COLOR_FILTER_MASK

• Define FRAME_COLOR_FILTER_SHIFT

• Define FRAME_ROI_IDENTIFIER_MASK

• Define FRAME_ROI_IDENTIFIER_SHIFT

Typedefs

• Typedef caerFrameEvent

• Typedef caerFrameEventConst

• Typedef caerFrameEventPacket

• Typedef caerFrameEventPacketConst