Eos-Image Analysis Environment

Fork

• others2
• data
• tutorial
• optional
• others
• hostdependX86LINUX64
• hostdependX86MAC64
• hostdependX86LINUX64ICC
• hostdependOTHERS
• base
• zephyr
• hostdependARM64MAC64

【確認事項】
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フィルタ用のデータを
設定して使うことがすぐに分かるようになる

【考察】
定義している変数の型などにも全てのリンクを貼ることを考えましたが、
リンクだらけになってしまうと思いましたので、
構造体のみで相互リンクを考えました。