OpenCVテンプレート

1行の概略

戻り値の型 関数名( 引数のリスト); †

関数の概要．引数の型は適宜覚え易く変えてよい(例:const CvArr*→CvMat*)

引数 †

• 引数名:型の○○(例 size:CvSize型の画像のサイズ)
• 箇条書きで記述
• 長い説明は解説の項に記述

返り値 †

• △△型の○○の値
• void型なのでなし
• 1個でも箇条書きに

戻り値の型 関数名( 引数のリスト); †

• C++インタフェースで等価な関数がある場合はその下に書く
• 単純なラッパーな場合はどちらがどちらのラッパーかを書く

引数 †

返り値 †

戻り値の型 関数名( 引数のリスト); †

関数複数から成り立つ場合は各関数ごとに引数と返り値の項を用意

引数 †

返り値 †

解説 †

• 入力のデータ，内部計算などについて説明
• 箇条書きで記述
• 行列サイズも画像サイズも高さx幅(行数x列数)で記述する

サンプルコード †

実体ファイル †

• OpenCVがインストールされた場所からの相対パスで記述
• (例: cxcore/include/cxcore.h)
• ヘッダファイルと実体ファイル(通常cpp)の2つを記述
• :OpenCV 1.1以前，:OpenCV 2.0と:OpenCV 2.1，:OpenCV 2.2以降でヘッダファイルを分ける
• :OpenCV 1.1以前
  • cv/include/hoge.h
  • cv/src/test.cpp
• :OpenCV 2.0,:OpenCV 2.1
  • opencv/cv.h
  • src/cv/test.cpp
• :OpenCV 2.2以降
  • modules/hoge/opnecv2/hoge/hoge.hpp
  • modules/hoge/src/hoge.cpp

注意 †

• 陥りやすいミスなどを記述
• 解説の項に統合しても構わない

最後にOpenCVのタグを記述→ジャンル:OpenCV:OpenCV 1.0:OpenCV 1.1:OpenCV 2.0:OpenCV 2.1:OpenCV 2.2:OpenCV 2.3:OpenCV 2.4準拠