SourceForge Forum
norep****@sourc*****
2014年 5月 15日 (木) 16:22:36 JST
このメールはSourceForge.JPのフォーラムからの自動転送です。 注意: このメールに返信しても単に無視されます。 フォーラムメッセージへの返信は以下のURLにアクセスしてください: https://sourceforge.jp/projects/eos/forums/31695/35450/73023/ 投稿者: kinoshita-eos (kinoshita-eos) 【確認事項】 APIの説明として以下の内容を記載することを考えています が、よろしいでしょうか。 【案】 固有の構造体を設定データとして引数にするAPIは構造体と 相互リンクを貼る 【例】lmrcImageSmoothingの場合 ファイル名: /src/Objects/DataManip/mrcImage/inc/mrcImage.h Eospediaページ名: mrcImage(API) 関数名: lmrcImageSmoothing 設定ファイルの構造体: lmrcImageSmoothingInfo (段落は基本通りにしています) 1. 変数 2. 構造体 2.5 API毎の設定 2.5.1 lmrcImageSmoothingInfo ----ここに対応するAPI(3.12.1)へのリンクを貼ります---- mrcImageSmoothingの設定データとして使用します。 typedef struct lmrcImageSmoothingInfo { long mode; mrcImageParaTypeReal sx; /* Filter kernel size */ mrcImageParaTypeReal sy; mrcImageParaTypeReal sz; double sigma; /* for Lee-Sigma filter */ } lmrcImageSmoothingInfo; 3. API 3.12 コマンド毎のAPI 3.12.1 lmrcImageSmoothing ----ここに対応する構造体(2.5.1)へのリンクを貼ります---- 設定データlmrcImageSmoothingInfoを使用します。 extern void lmrcImageSmoothing(mrcImage* dst, mrcImage* src, lmrcImageSmoothingInfo* info, long mode); 【利点】 構造体 -> APIへのリンクの場合: 構造体の使用例が分かり、類似のAPIを作るときの参考にな る API -> 構造体へのリンクの場合: APIの呼び出し方法が分かりやすくなる 例えば、lmrcImageSmoothingを使用するためには modeの他にも設定データlmrcImageSmoothingInfoが必要で、 メンバーにモード、フィルタサイズ、Lee-Sigmaフィルタ用の データを 設定して使うことがすぐに分かるようになる 【考察】 定義している変数の型などにも全てのリンクを貼ることを 考えましたが、 リンクだらけになってしまうと思いましたので、 構造体のみで相互リンクを考えました。 ______________________________________________________________________ Eos-Image Analysis Environment プロジェクトはフォーラムへの投稿をプロジェクトメンバーに メール送信するように設定されています。 設定の詳細に関しては、プロジェクト管理者に確認してください。
Fork