|
FireSync API
|
Represents output from a binarize-csum algorithm.
Binarize output consists of 1-bit pixels packed into k8u values. For the sake of convenient data representation, this message format requires that the source image width is a multiple of 8 columns, so that each row can be represented with a whole number of bytes.
If results are generated by the binarize-csum camera algorithm (v4), the binarize height will be one less than the source image height (results are not provided for the last row of the source image).
kBinCSumMsg supports allocating data memory internally, or attaching to external memory (as required by the FireSync camera driver). Separate constructors are provided for these cases.
kBinCSumMsg supports the kObject_Clone and kObject_Size methods. kObject_Dispose has the same effect as kObject_Destroy.
kBinCSumMsg supports the kdat6 serialization protocol.
Public Member Functions | |
| kStatus | kBinCSumMsg_Attach (kBinCSumMsg msg, kSize frameIndex, kStamp *stamp, void *bin, void *csum) |
| Attaches memory pointers for the specified frame. More... | |
| void * | kBinCSumMsg_BinAt (kBinCSumMsg msg, kSize frameIndex, kSize rowIndex) |
| Gets a pointer to the binarize data at the specified frame and row index. More... | |
| kSize | kBinCSumMsg_BinHeight (kBinCSumMsg msg) |
| Reports the height (number of rows) of the binarize data in each frame. More... | |
| kType | kBinCSumMsg_BinType (kBinCSumMsg msg) |
| Reports the type of the binarize data. More... | |
| kSize | kBinCSumMsg_BinWidth (kBinCSumMsg msg) |
| Reports the number of 8-bit elements in one row of binarize data. More... | |
| kStatus | kBinCSumMsg_Construct (kBinCSumMsg *msg, kSize binWidth, kSize binHeight, kType csumType, kSize csumLength, kSize frameCount, kAlloc allocator) |
| Constructs a kBinCSumMsg object that allocates its own memory for data content. More... | |
| kStatus | kBinCSumMsg_ConstructAttach (kBinCSumMsg *msg, kSize binWidth, kSize binHeight, kType csumType, kSize csumLength, kSize frameCount, kAlloc allocator) |
| Constructs a kBinCSumMsg object that will be attached to external data content. More... | |
| void * | kBinCSumMsg_CSumAt (kBinCSumMsg msg, kSize frameIndex) |
| Gets a pointer to the csum data at the specified frame index. More... | |
| kSize | kBinCSumMsg_CSumLength (kBinCSumMsg msg) |
| Reports the number of csum results in each frame. More... | |
| kType | kBinCSumMsg_CSumType (kBinCSumMsg msg) |
| Reports the type of the column sum data. More... | |
| kSize | kBinCSumMsg_FrameCount (kBinCSumMsg msg) |
| Reports the number of frames in the message. More... | |
| kStamp * | kBinCSumMsg_StampAt (kBinCSumMsg msg, kSize frameIndex) |
| Gets a pointer to the stamp at the specified frame index. More... | |
 Public Member Functions inherited from kAlgMsg | |
| kSize | kAlgMsg_FrameCount (kAlgMsg msg) |
| Reports the number of frames in the message. More... | |
| void * | kAlgMsg_Part (kAlgMsg msg, kSize frameIndex, kSize partIndex) |
| Gets a pointer to the specified frame content part. More... | |
| kSize | kAlgMsg_PartCount (kAlgMsg msg) |
| Reports the number of content parts for each frame. More... | |
| kSize | kAlgMsg_PartDimensionCount (kAlgMsg msg, kSize partIndex) |
| Reports the dimensionality of the specified content part. More... | |
| kSize | kAlgMsg_PartLength (kAlgMsg msg, kSize partIndex, kSize dimensionIndex) |
| Reports the length of the specified part dimension. More... | |
| kType | kAlgMsg_PartType (kAlgMsg msg, kSize partIndex) |
| Reports the data type of the specified content part. More... | |
| Public Member Functions inherited from kMsgSet | |
| kSize | kMsgSet_Count (kMsgSet set) |
| Gets the count of stamped items in this message set. More... | |
| kStatus | kMsgSet_DataAt (kMsgSet set, kSize index, kArrayList *list) |
| Gets a list of data items at the specified stamp index. More... | |
| kStatus | kMsgSet_SetStampAt (kMsgSet set, kSize index, const kStamp *stamp) |
| Sets the stamp at the specified index. More... | |
| const kStamp * | kMsgSet_StampAt (kMsgSet set, kSize index) |
| Gets the stamp at the specified index. More... | |
Related | |
| #define | kBinCSumMsg_AttachT(kBinCSumMsg_msg, kSize_frameIndex, kStampPtr_stamp, BPtr_bin, CPtr_csum) |
| Attaches memory pointers for the specified frame. More... | |
| #define | kBinCSumMsg_BinAtT(kBinCSumMsg_msg, kSize_frameIndex, kSize_rowIndex, T) |
| Gets a strongly-typed pointer to the binarize data at the specified frame and row index. More... | |
| #define | kBinCSumMsg_CSumAtT(kBinCSumMsg_msg, kSize_frameIndex, T) |
| Gets a strongly-typed pointer to the csum data at the specified frame index. More... | |
| Related inherited from kAlgMsg | |
| #define | kAlgMsg_PartT(kAlgMsg_msg, kSize_frameIndex, kSize_partIndex, T) |
| Gets a strongly-typed pointer to the specified frame content part. More... | |
| #define | kALG_MSG_MAX_PARTS |
| Maximum number of content parts supported by kAlgMsg. | |
