dbStore利用方法 for MATLAB

ver.16.0.1　'12.8.27現在

計測データを保存するには、データを作成後、dbStoreで保存します。

• 事前準備
• ショットデータ・パラメータデータを準備する
• データを保存する

※本機能はMATLAB R2010bで検証しています。

事前準備

• 参照サイトを変更する
• テンポラリファイルの作成場所を変更する

Retrieve+dbStoreをインストールすると、参照サイトが自動的に「LHD」に設定されます。デフォルトの参照サイトを変更したい場合はこちらをご覧ください。

dbStoreはテンポラリファイルを作成します。デフォルトではカレントディレクトリに作成します。
テンポラリファイルを作成するディレクトリを変更したい場合は、次の手順に沿って環境変数「DBSTORE_TMP」を作成してください。（インストール時には環境変数「DBSTORE_TMP」は作成されません）

1. コントロールパネルで「システム」を選択します。
2. 「システムのプロパティ」ダイアログが表示されますので、「詳細設定」タブの中にある「環境変数」をクリックします。
3. 「環境変数」ダイアログが表示されますので、システム環境変数で「新規」をクリックします。
4. 変数名に「DBSTORE_TMP」、変数値にテンポラリファイルを作成するディレクトリを指定し「OK」をクリックします。
5. 「環境変数」ダイアログでもう一度「OK」、「システムのプロパティ」ダイアログでも「OK」をクリックします。

ショットデータ・パラメータデータを準備する

ショットデータとパラメータデータの2種類、またはショットデータ、パラメータデータのいづれかを準備します。

バイナリ配列データ、またはフレームに対応したカメラ画像データを保存します。

例）
data = zeros(1000, 1, 'single');

initParamListでパラメータを格納する領域を作成します。
その後、setParamでパラメータを１つずつ格納します。

例）
pl = initParamList();
pl = setParam(pl, 'offset', 10.0);
pl = setParam(pl, 'gain', int32(2));

1. initParamList :パラメータを格納する領域を初期化します

   param_list = initParamList();

2. setParam :パラメータをパラメータリストに設定します

   [param_list, tf_code] = setParam(param_list, pname, pvalue);

   param_list(struct) :	パラメータリスト initParamList()で初期化する必要がある
   pname(text) :	パラメータ名
   pvalue(numeric,text) :	パラメータ値 行列は設定できない 整数として設定したい場合は、明示的にcastする必要がある 符号なしは符号付きになる
   param_list(struct) :	パラメータリスト
   tf_code(logical) :	trueは成功 falseはエラー

データを保存する

ショットデータ（バイナリ配列データ、またはフレームに対応したカメラ画像データ）とパラメータデータをdbStoreで保存します。
ショットデータの登録処理を途中でキャンセルすることもできます。

dbsOpenでショットデータの登録を開始し、チャネルデータ数分dbsWriteを繰り返します。dbsCloseでショットデータの登録を終了します。

例）
data = zeros(1000, 1, 'single');
pl = initParamList();
pl = setParam(pl, 'offset', 10.0);
pl = setParam(pl, 'gain', int32(2));
des = dbsOpen('', 'LABCOM', 50500, 1, 'RAW');
code = dbsWrite(des, 1, pl, data, 'verbose');
dbsClose(des);

• dbsOpen :ショットデータの登録を開始します

  des = dbsOpen(mail_address, data_name, shot_number, sub_shot, data_type, ...)

  mail_address(text) :	登録者のメールアドレス このメールアドレスが削除するために必要です
  data_name(text) :	データ名 データ取得するためのデータ名です データ名はこちらから申請してください
  shot_number(numeric) :	ショット番号
  sub_shot(numeric) :	サブショット番号
  data_type(text) :	'RAW' or 'ANA' 生データの場合は'RAW', それ以外は'ANA'にします
  des :	戻り値 0 < : dbStore識別子 他の関数に使用します 0 => : エラーコード
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する
  'cndb_timeout',t :	データベース接続時のタイムアウト時間（t秒）を設定する
  'cndb_retry',n :	データベース接続時のタイムアウト繰り返し回数（n回）を設定する

• dbsWrite :各チャネルデータを内部的に一時格納します

  code = dbsWrite(dbs_des, channel_number, param_struct, data_array, ...)

  dbs_des(numeric) :	dbStore識別子
  channel_number(numeric) :	チャネル番号
  param_struct(struct) :	パラメータリスト initParamList関数で初期化し、setParam関数で設定する パラメータがない場合は, 'struct([])' とする
  data_array(numeric, libpointer) :	データ配列（libpointerクラスでも可） データがない場合は、'int16([])' とする
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'imagetype',image_type :	チャネルデータのデータ型　※補足参照 'INT8', 'INT16', 'INT32', 'INT64', 'FLT32', 'FLT64', 'GRAYn', 'RGB', 'ARGB' 記述しない場合は、data_array変数の型で判断されます
  'frames',frames :	フレーム構成の場合のフレーム数
  'verbose' :	必要に応じてメッセージ出力する

  • param_structは、dbsWriteのコール後、変更されません。
  • チャネル数分、dbsWriteを呼び出してください。

  ※【補足】image_typeパラメータ

  データファイルのデータの型を指定します。

  "INT8" :	8ビット整数
  "INT16" :	16ビット整数
  "INT32" :	32ビット整数
  "INT64" :	64ビット整数
  "FLT32" :	32ビット浮動少数点
  "FLT64" :	64ビット浮動少数点
  "GRAYn" :	nビットグレースケール画像（n:8～16）　例）'GRAY8'
  "RGB" :	24ビットカラー画像（RGBの順が変更可) 例）'BGR'
  "ARGB" :	32ビットカラー画像（ARGBの順が変更可) 例）'BGRA'

• dbsClose :実験・解析データ格納処理(dbStore)のための正常終了処理を行います。データサーバにデータの転送を開始し、インデックスを登録します

  code = dbsClose(dbs_des, ...)
  

  dbs_des(numeric) :	dbStore識別子
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する

まず、dbsOpenでショットデータの登録開始を宣言します。
次にdbsOpenFrameでフレームデータの登録を開始し、dbsWriteFrameで1フレームづつ登録します。複数フレーム登録する場合はdbsWriteFramesを使用します。dbsCloseFrameでフレームデータを終了します。
最後にdbsCloseでショットデータの登録を終了します。

例）
des = dbsOpen('', 'LABCOM', 49002, 1, 'RAW');
code = dbsOpenFrame(des, ch, 640, 480, 'RGBA');
frame_array = zeros(640, 480, 'uint32');
code = dbsWriteFrame(des, ch, 1,frame_array);
code = dbsCloseFrame(des, ch, param);
dbsClsoe(des);

• dbsOpenFrame :チャネルをフレーム構成にするための開始処理します

  code = dbsOpenFrame(dbs_des, channel_number, frame_x, frame_y, image_type, ...)

  dbs_des(numeric) :	dbStore識別子
  channel_number(numeric) :	チャネル番号
  frame_x(numeric) :	フレームのＸサイズ
  frame_y(numeric) :	フレームのＹサイズ
  image_type(text) :	フレームデータのデータ型 ※補足参照 'INT8', 'INT16', 'INT32', 'INT64', 'FLT32', 'FLT64', 'GRAYn', 'RGB', 'ARGB'
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する
  'accept_sizes' :	フレームデータのサイズがX*Yサイズでない場合も保存する

• dbsWriteFrame :チャネル内に１フレームデータを書き込みます

  code = dbsWriteFrame(dbs_des, channel_number, frame_number, frame_array, ...)
  

  dbs_des(numeric) :	dbStore識別子
  channel_number(numeric) :	チャネル番号
  frame_number(numeric) :	フレーム番号
  frame_array(numeric, libpointer) :	フレームデータ
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する

  フレーム数分、dbsWriteFrameを呼び出してください。

• dbsWriteFrames :チャネル内に複数のフレームデータを書き込みます

  code = dbsWriteFrames(dbs_des, channel_number, start_frame_number, frames, frames_array, ...)

  dbs_des(numeric) :	dbStore識別子
  channel_number(numeric) :	チャネル番号
  start_frame_number(numeric) :	開始フレーム番号
  frames(numeric) :	フレーム数
  frame_array(numeric, libpointer) :	フレームデータ
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する

• dbsCloseFrame :チャネル内のフレーム書き込む処理の終了処理を行います

  code = dbsClsoeFrame(dbs_des, channel_number,param_struct, ...)

  dbs_des(numeric) :	dbStore識別子
  channel_number(numeric) :	チャネル番号
  param_struct(struct) :	チャネルのパラメータリスト initParamList関数で初期化し、setParam関数で設定する パラメータがない場合は, 'struct([])' とする
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する

  • パラメータリストの作成方法は、こちらと同じです。
  • param_structは、dbsCloseFrameのコール後、変更されません。
    

途中でショットデータの登録をキャンセルするには、dbsAbortでキャンセルします。

例）
des = dbsOpen('', 'LABCOM', 49002, 1, 'RAW');
code = dbsWrite(des, 1, pl, data, 'verbose');
dbsAbort(des);

• dbsAbort :実験・解析データ格納処理(dbStore)のための異常終了処理を行います。テンポラリファイル等リソースを解放します

  code = dbsAbort(dbs_des, ...)

  dbs_des(numeric) :	dbStore識別子
  code(numeric) :	終了値（0は成功、0以外はエラー発生)
  OPTIONS :
  'verbose' :	必要に応じてメッセージ出力する

この Web に関する問題または質問等については，LABCOM までご連絡下さい．