Struct FrameEvent

Inheritance Relationships

Base Type

  • public caer_frame_event

Struct Documentation

struct FrameEvent : public caer_frame_event

Assignment/Move Constructors/Operators cannot be used with Frame Events due to their particular memory layout that is not entirely known to the compiler (dynamic pixel array). As such those constructors and operators are disabled. Please use caerGenericEventCopy() to copy frame events!

Public Types

enum class colorChannels

Values:

enumerator GRAYSCALE

Grayscale, one channel only.

enumerator RGB

Red Green Blue, 3 color channels.

enumerator RGBA

Red Green Blue Alpha, 3 color channels plus transparency.

enum class colorFilter

Values:

enumerator MONO

No color filter present, all light passes.

enumerator RGBG

Standard Bayer color filter, 1 red 2 green 1 blue. Variation 1.

enumerator GRGB

Standard Bayer color filter, 1 red 2 green 1 blue. Variation 2.

enumerator GBGR

Standard Bayer color filter, 1 red 2 green 1 blue. Variation 3.

enumerator BGRG

Standard Bayer color filter, 1 red 2 green 1 blue. Variation 4.

enumerator RGBW

Modified Bayer color filter, with white (pass all light) instead of extra green. Variation 1.

enumerator GRWB

Modified Bayer color filter, with white (pass all light) instead of extra green. Variation 2.

enumerator WBGR

Modified Bayer color filter, with white (pass all light) instead of extra green. Variation 3.

enumerator BWRG

Modified Bayer color filter, with white (pass all light) instead of extra green. Variation 4.

Public Functions

FrameEvent() = default
FrameEvent(const FrameEvent &rhs) = delete
FrameEvent &operator=(const FrameEvent &rhs) = delete
FrameEvent(FrameEvent &&rhs) = delete
FrameEvent &operator=(FrameEvent &&rhs) = delete
inline int32_t getTSStartOfFrame() const noexcept
inline int64_t getTSStartOfFrame64(const EventPacket &packet) const noexcept
inline void setTSStartOfFrame(int32_t ts)
inline int32_t getTSEndOfFrame() const noexcept
inline int64_t getTSEndOfFrame64(const EventPacket &packet) const noexcept
inline void setTSEndOfFrame(int32_t ts)
inline int32_t getTSStartOfExposure() const noexcept
inline int64_t getTSStartOfExposure64(const EventPacket &packet) const noexcept
inline void setTSStartOfExposure(int32_t ts)
inline int32_t getTSEndOfExposure() const noexcept
inline int64_t getTSEndOfExposure64(const EventPacket &packet) const noexcept
inline void setTSEndOfExposure(int32_t ts)
inline int32_t getTimestamp() const noexcept
inline int64_t getTimestamp64(const EventPacket &packet) const noexcept
inline int32_t getExposureLength() const noexcept
inline bool isValid() const noexcept
inline void validate(EventPacket &packet) noexcept
inline void invalidate(EventPacket &packet) noexcept
inline uint8_t getROIIdentifier() const noexcept
inline void setROIIdentifier(uint8_t roiIdent) noexcept
inline colorFilter getColorFilter() const noexcept
inline void setColorFilter(colorFilter cFilter) noexcept
inline int32_t getLengthX() const noexcept
inline int32_t getLengthY() const noexcept
inline colorChannels getChannelNumber() const noexcept
inline void setLengthXLengthYChannelNumber(int32_t lenX, int32_t lenY, colorChannels cNumber, const EventPacket &packet)
inline size_t getPixelsMaxIndex() const noexcept
inline size_t getPixelsSize() const noexcept
inline int32_t getPositionX() const noexcept
inline void setPositionX(int32_t posX) noexcept
inline int32_t getPositionY() const noexcept
inline void setPositionY(int32_t posY) noexcept
inline uint16_t getPixel(int32_t xAddress, int32_t yAddress) const
inline void setPixel(int32_t xAddress, int32_t yAddress, uint16_t pixelValue)
inline uint16_t getPixel(int32_t xAddress, int32_t yAddress, uint8_t channel) const
inline void setPixel(int32_t xAddress, int32_t yAddress, uint8_t channel, uint16_t pixelValue)
inline uint16_t getPixelUnsafe(int32_t xAddress, int32_t yAddress) const noexcept
inline void setPixelUnsafe(int32_t xAddress, int32_t yAddress, uint16_t pixelValue) noexcept
inline uint16_t getPixelUnsafe(int32_t xAddress, int32_t yAddress, uint8_t channel) const noexcept
inline void setPixelUnsafe(int32_t xAddress, int32_t yAddress, uint8_t channel, uint16_t pixelValue) noexcept
inline uint16_t *getPixelArrayUnsafe() noexcept
inline const uint16_t *getPixelArrayUnsafe() const noexcept