Public Member Functions |
| | Frame (_Frame *f=NULL) |
| | Frames are normally acquired by sensor::getFrame().
|
|
virtual | ~Frame () |
| | Virtual destructor to allow derived frames to delete themselves properly when accessed as base frames.
|
|
bool | valid () const |
| | Does this Frame refer to a valid frame?
|
|
bool | operator== (const Frame &other) const |
| | Equality operator, to see if two frames point to the same underlying data.
|
| Image | image () const |
| | The actual image data.
|
| Time | exposureStartTime () const |
| | The time the earliest pixel in the image started exposing.
|
| Time | exposureEndTime () const |
| | The time the latest pixel in the rolling shutter finished exposing.
|
| Time | processingDoneTime () const |
| | The time the image appeared out of the imaging pipe.
|
| int | exposure () const |
| | The actual exposure time for this frame in microseconds.
|
| int | frameTime () const |
| | The actual number of microseconds between the start of this frame and the start of the next one.
|
| float | gain () const |
| | The actual gain used to produce this frame.
|
| int | whiteBalance () const |
| | The actual white balance setting used to produce this frame.
|
| const Histogram & | histogram () const |
| | A histogram produced by the imaging pipe.
|
| const SharpnessMap & | sharpness () const |
| | A sharpness map produced by the imaging pipe.
|
| const Shot & | shot () const |
| | A const reference to the shot that generated this frame.
|
| const TagMap & | tags () const |
| | A const reference to the tags that have been placed on this frame by any devices.
|
| TagValue & | operator[] (const std::string &name) const |
| | Retrieve a reference to a tag placed on this frame by name.
|
| virtual const Platform & | platform () const |
| | Access to the static platform data about the sensor that produced this frame.
|
| | operator EventGenerator * () |
| | Treat a frame as an EventGenerator pointer.
|
| void | debug (const char *name="") const |
| | A Frame debugging dump function.
|
| | Frame (_Frame *f=NULL) |
| | Frames are normally acquired by sensor::getFrame().
|
|
virtual | ~Frame () |
| | Virtual destructor to allow derived frames to delete themselves properly when accessed as base frames.
|
|
bool | valid () const |
| | Does this Frame refer to a valid frame?
|
|
bool | operator== (const Frame &other) const |
| | Equality operator, to see if two frames point to the same underlying data.
|
| Image | image () const |
| | The actual image data.
|
| Time | exposureStartTime () const |
| | The time the earliest pixel in the image started exposing.
|
| Time | exposureEndTime () const |
| | The time the latest pixel in the rolling shutter finished exposing.
|
| Time | processingDoneTime () const |
| | The time the image appeared out of the imaging pipe.
|
| int | exposure () const |
| | The actual exposure time for this frame in microseconds.
|
| int | frameTime () const |
| | The actual number of microseconds between the start of this frame and the start of the next one.
|
| float | gain () const |
| | The actual gain used to produce this frame.
|
| int | whiteBalance () const |
| | The actual white balance setting used to produce this frame.
|
| const Histogram & | histogram () const |
| | A histogram produced by the imaging pipe.
|
| const SharpnessMap & | sharpness () const |
| | A sharpness map produced by the imaging pipe.
|
| const Shot & | shot () const |
| | A const reference to the shot that generated this frame.
|
| const TagMap & | tags () const |
| | A const reference to the tags that have been placed on this frame by any devices.
|
| TagValue & | operator[] (const std::string &name) const |
| | Retrieve a reference to a tag placed on this frame by name.
|
| virtual const Platform & | platform () const |
| | Access to the static platform data about the sensor that produced this frame.
|
| | operator EventGenerator * () |
| | Treat a frame as an EventGenerator pointer.
|
| void | debug (const char *name="") const |
| | A Frame debugging dump function.
|
Data returned by the sensor as a result of a shot.
May contain image data, a histogram, sharpness map, and assorted tags placed there by devices attached to the sensor from whence this frame came. It may also contain none of these, so check each component is valid before using it. This class is a reference counted pointer type to the real data, so pass it by copy.
| const Shot& FCam::Frame::shot |
( |
|
) |
const [inline] |
A const reference to the shot that generated this frame.
If you have a fancy sensor that takes more parameters, and a corresponding fancy shot that inherits from the base shot, this method should be overridden to return a const reference to your derived shot type instead. It is not a virtual method, so if your fancy frame is cast to a base frame, this method will return a base shot.
Reimplemented in FCam::F2::Frame, and FCam::F2::Frame.
Definition at line 145 of file Frame.h.
| const TagMap& FCam::Frame::tags |
( |
|
) |
const [inline] |
A const reference to the tags that have been placed on this frame by any devices.
In general you use frame["tagName"] to get and set tags, rather than directory accessing this map. If you wish to iterate over tags, however, you can use this TagMap, which is an std::unordered_map
Definition at line 155 of file Frame.h.
| const Shot& FCam::Frame::shot |
( |
|
) |
const [inline] |
A const reference to the shot that generated this frame.
If you have a fancy sensor that takes more parameters, and a corresponding fancy shot that inherits from the base shot, this method should be overridden to return a const reference to your derived shot type instead. It is not a virtual method, so if your fancy frame is cast to a base frame, this method will return a base shot.
Reimplemented in FCam::F2::Frame, and FCam::F2::Frame.
Definition at line 145 of file Frame.h.
| const TagMap& FCam::Frame::tags |
( |
|
) |
const [inline] |
A const reference to the tags that have been placed on this frame by any devices.
In general you use frame["tagName"] to get and set tags, rather than directory accessing this map. If you wish to iterate over tags, however, you can use this TagMap, which is an std::unordered_map
Definition at line 155 of file Frame.h.
