FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kBinCSumMsg.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_BINCSUM_MSG_H
9 #define K_FIRESYNC_BINCSUM_MSG_H
10 
11 #include <kFireSync/Data/kAlgMsg.h>
12 
13 kBeginHeader()
14 
15 
37 //typedef kAlgMsg kBinCSumMsg; --forward-declared in kFsDef.x.h
38 
39 
52 kFsFx(kStatus) kBinCSumMsg_Construct(kBinCSumMsg* msg, kSize binWidth, kSize binHeight, kType csumType, kSize csumLength, kSize frameCount, kAlloc allocator);
53 
70 kFsFx(kStatus) kBinCSumMsg_ConstructAttach(kBinCSumMsg* msg, kSize binWidth, kSize binHeight, kType csumType, kSize csumLength, kSize frameCount, kAlloc allocator);
71 
83 kFsFx(kStatus) kBinCSumMsg_Attach(kBinCSumMsg msg, kSize frameIndex, kStamp* stamp, void* bin, void* csum);
84 
92 kFsFx(kSize) kBinCSumMsg_FrameCount(kBinCSumMsg msg);
93 
102 kFsFx(kStamp*) kBinCSumMsg_StampAt(kBinCSumMsg msg, kSize frameIndex);
103 
114 kFsFx(kSize) kBinCSumMsg_BinHeight(kBinCSumMsg msg);
115 
127 kFsFx(kSize) kBinCSumMsg_BinWidth(kBinCSumMsg msg);
128 
138 kFsFx(void*) kBinCSumMsg_BinAt(kBinCSumMsg msg, kSize frameIndex, kSize rowIndex);
139 
147 kFsFx(kSize) kBinCSumMsg_CSumLength(kBinCSumMsg msg);
148 
156 kFsFx(kType) kBinCSumMsg_CSumType(kBinCSumMsg msg);
157 
166 kFsFx(void*) kBinCSumMsg_CSumAt(kBinCSumMsg msg, kSize frameIndex);
167 
168 kEndHeader()
169 
170 #include <kFireSync/Data/kBinCSumMsg.x.h>
171 
172 #endif
kBinCSumMsg::kBinCSumMsg_Attach
kStatus kBinCSumMsg_Attach(kBinCSumMsg msg, kSize frameIndex, kStamp *stamp, void *bin, void *csum)
Attaches memory pointers for the specified frame.
kBinCSumMsg::kBinCSumMsg_FrameCount
kSize kBinCSumMsg_FrameCount(kBinCSumMsg msg)
Reports the number of frames in the message.
kAlgMsg.h
Declares the kAlgMsg type.
kBinCSumMsg
Represents output from a binarize-csum algorithm.
kBinCSumMsg::kBinCSumMsg_StampAt
kStamp * kBinCSumMsg_StampAt(kBinCSumMsg msg, kSize frameIndex)
Gets a pointer to the stamp at the specified frame index.
kBinCSumMsg::kBinCSumMsg_BinAt
void * kBinCSumMsg_BinAt(kBinCSumMsg msg, kSize frameIndex, kSize rowIndex)
Gets a pointer to the binarize data at the specified frame and row index.
kBinCSumMsg::kBinCSumMsg_CSumType
kType kBinCSumMsg_CSumType(kBinCSumMsg msg)
Reports the type of the column sum data.
kBinCSumMsg::kBinCSumMsg_CSumLength
kSize kBinCSumMsg_CSumLength(kBinCSumMsg msg)
Reports the number of csum results in each frame.
kBinCSumMsg::kBinCSumMsg_Construct
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.
kBinCSumMsg::kBinCSumMsg_BinWidth
kSize kBinCSumMsg_BinWidth(kBinCSumMsg msg)
Reports the number of 8-bit elements in one row of binarize data.
kBinCSumMsg::kBinCSumMsg_CSumAt
void * kBinCSumMsg_CSumAt(kBinCSumMsg msg, kSize frameIndex)
Gets a pointer to the csum data at the specified frame index.
kStamp
Represents acquisition metadata associated with a data message.
Definition: kNodeDef.h:2263
kBinCSumMsg::kBinCSumMsg_BinHeight
kSize kBinCSumMsg_BinHeight(kBinCSumMsg msg)
Reports the height (number of rows) of the binarize data in each frame.
kBinCSumMsg::kBinCSumMsg_ConstructAttach
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.