add some comments
Stefan Schuermans commited on 2017-05-25 16:11:54
Showing 3 changed files, with 26 additions and 0 deletions.
- config_gen/src/chain.h 463e333..cb412ef
- config_gen/src/distri.h e85ecfa..85984f0
- config_gen/src/pixel.h ac0dfb0..c919353
| ... | ... |
@@ -30,6 +30,16 @@ class Chain {
|
| 30 | 30 |
public: |
| 31 | 31 |
Chain(unsigned int pixelCnt); |
| 32 | 32 |
void addPixel(Pixel const &pixel); |
| 33 |
+ /** |
|
| 34 |
+ * @brief compute coordinates of pixels and check them |
|
| 35 |
+ * @param[in] pix0 position of logical pixel origin |
|
| 36 |
+ * (top left corner of 0,0 of video frame) |
|
| 37 |
+ * @param[in] pixSz size of one logcal pixel (in video frame) |
|
| 38 |
+ * @param[in] width of video frame in pixels |
|
| 39 |
+ * @param[in] height of video frame in pixels |
|
| 40 |
+ * @param[in] distriNo distributor number (for error messages) |
|
| 41 |
+ * @param[in] chainNo chain number (for error messages) |
|
| 42 |
+ */ |
|
| 33 | 43 |
int pixCoord(const Point &pix0, const Point &pixSz, |
| 34 | 44 |
unsigned int width, unsigned int height, |
| 35 | 45 |
unsigned int distriNo, unsigned int chainNo); |
| ... | ... |
@@ -32,6 +32,14 @@ public: |
| 32 | 32 |
unsigned int getNo() const; |
| 33 | 33 |
void addChain(Chain const &chain); |
| 34 | 34 |
Chain & accessLastChain(); |
| 35 |
+ /** |
|
| 36 |
+ * @brief compute coordinates of pixels and check them |
|
| 37 |
+ * @param[in] pix0 position of logical pixel origin |
|
| 38 |
+ * (top left corner of 0,0 of video frame) |
|
| 39 |
+ * @param[in] pixSz size of one logcal pixel (in video frame) |
|
| 40 |
+ * @param[in] width of video frame in pixels |
|
| 41 |
+ * @param[in] height of video frame in pixels |
|
| 42 |
+ */ |
|
| 35 | 43 |
int pixCoord(const Point &pix0, const Point &pixSz, |
| 36 | 44 |
unsigned int width, unsigned int height); |
| 37 | 45 |
void writeDistri(std::ostream & strm) const; |
| ... | ... |
@@ -28,6 +28,14 @@ |
| 28 | 28 |
class Pixel {
|
| 29 | 29 |
public: |
| 30 | 30 |
Pixel(const Object *pObjPixel); |
| 31 |
+ /** |
|
| 32 |
+ * @brief compute coordinate of pixel and check it |
|
| 33 |
+ * @param[in] pix0 position of logical pixel origin |
|
| 34 |
+ * (top left corner of 0,0 of video frame) |
|
| 35 |
+ * @param[in] pixSz size of one logcal pixel (in video frame) |
|
| 36 |
+ * @param[in] width of video frame in pixels |
|
| 37 |
+ * @param[in] height of video frame in pixels |
|
| 38 |
+ */ |
|
| 31 | 39 |
int pixCoord(const Point &pix0, const Point &pixSz, |
| 32 | 40 |
unsigned int width, unsigned int height); |
| 33 | 41 |
void writePixel(std::ostream & strm) const; |
| 34 | 42 |