labcom.ArcData (version 22.0.0, 2020-07-31)
index

実験データをチャネル単位に格納する。
 
実験データには、パラメータおよび時間軸情報が付属する。
時間軸情報はDTS情報が参照できる場合のみである。
 

 
Classes
       
ArcData
ArcFrames
ArcSamples
Frame

 
class ArcData( )
    ArcData(start_time=None, sampling_interval=None, samp_data=None, samp_params=None, num_times=None)
 
[ クラス名 ] ArcData
< パブリックメンバー >
  start_time (double|int)         : サンプリング開始時刻(秒|ピコ秒)
  sampling_interval (double|int)  : サンプリング間隔(秒|ピコ秒)
  samp_data (ArcSamples|ArcFrames) : データ・オブジェクト
  samp_params (ディクショナリ)        : パラメータ連想配列
  num_times (int)                  : 時間軸データ数
      
< 参照系メソッド >
  val()          : データを取り出す (numpy) 
  time()         : 時間軸配列データを取り出す (numpy) 
  num()                : データ件数
  num_times()    : 時間軸配列データ件数
 
< 更新系メソッド >
  set_data( obj) : データオブジェクトを設定する。
  set_parameters( dict_obj) 
                 : パラメータ配列を設定する。
  set_time( start_time, sampling_interval, num_times) 
                 : 時間軸情報を設定する。
  set_samples( dtype, data, bsize=None) 
                 : データを設定する。
  add_parameters( dict_obj) 
                 : パラメータ配列を追加する。
  add_parameter( param_name, param_value, param_type) 
                 : パラメータを追加する。
  init_frames( i_type, x_size, y_size) 
                 : データをフレーム構造に初期化する。
  add_frame( binary_str, bsize=None) 
                 : データに1フレームデータを追加する。
 
< 説明 >
  チャネルデータを管理するクラス
 
  Methods defined here:
__init__(self, start_time=None, sampling_interval=None, samp_data=None, samp_params=None, num_times=None)
[ Constructor ]
< 引数 >
  start_time (double|int)         : サンプリング開始時刻(秒|ピコ秒)
  sampling_interval (double|int)  : サンプリング間隔(秒|ピコ秒)
  samp_data (ArcSamples|ArcFrames) : データ・オブジェクト
  samp_params (dict)               : パラメータ連想配列
  num_times (int)                 : 時間軸データ数
add_frame(self, binary_str, bsize=None)
[ 関数名 ] add_frame
< 引数 >
  binary_str (ByteArray) : データ一次元配列
  bsize (int)            : データバイト数
< 返値 >
  なし
< 説明 >
  1フレームのデータを追加する。
< 例外 >
  RuntimeError
add_parameter(self, param_name, param_value, param_type)
[ 関数名 ] add_parameter
< 引数 >
  param_name (string)       : 追加するパラメータ名
  param_value
      (int,double,string,..) : 追加するパラメータ値
  param_type (int)           : 追加するパラメータの型
< 返値 >
  なし
< 説明 >
  パラメータオブジェクトに追加する。
add_parameters(self, dict_obj)
[ 関数名 ] add_parameters
< 引数 >
  dict_obj (dict)    : 追加するパラメータオブジェクト。
< 返値 >
  なし
< 説明 >
  パラメータオブジェクトに追加する。
converted_rgb(self)
[ 関数名] converted_rgb
< 引数 >
  なし
< 返値 >
  データの3次元配列RGBデータ(numpy)
< 説明 >
  データオブジェクトのデータをnumpyクラスのオブジェクトに変換する。
have_parameters(self)
init_frames(self, i_type, x_size, y_size)
[ 関数名 ] init_frames
< 引数 >
  i_type(string) : イメージタイプ(データ型)
  x_size(int)    : X方向サイズ
  y_size(int)    : Y方向サイズ
< 返値 >
  なし
< 説明 >
  データオブジェクトをArcFramesに初期化する。
< 例外 >
  TypeError
is_frame(self)
num(self)
[ 関数名 ] num
< 引数 >
  なし
< 返値 >
  データオブジェクトのデータ件数 (int)
< 説明 >
  フレームの場合、フレーム数
num_times(self)
[ 関数名 ] num_times
< 引数 >
  なし
< 返値 >
  時間軸データ件数 (int)
< 説明 >
  サンプル数と異る場合あり。
set_data(self, obj)
[ 関数名 ] set_data
< 引数 >
  obj (ArcSamples,ArcFrames) : 設定するデータオブジェクト
< 返値 >
  なし
< 説明 >
  データオブジェクトに設定する。
< 例外 >
  TypeError
set_parameters(self, dict_obj)
[ 関数名 ] set_parameters
< 引数 >
  dict_obj (dict)    : 設定するパラメータオブジェクト
< 返値 >
  なし
< 説明 >
  パラメータオブジェクトに設定する。
set_samples(self, dtype, data, bsize=None)
[ 関数名 ] set_samples
< 引数 >
  dtype (string)     : データ型
  data  (string)     : データ配列(binary string)
  bsize (int)        : データバイト数
< 返値 >
  なし
< 説明 >
  データオブジェクトを設定する。
set_time(self, start_time, sampling_interval, num_times=None)
[ 関数名 ] set_time
< 引数 >
  start_time (double|int)         : サンプリング開始時刻(秒|ピコ秒)
  sampling_interval (double|int)   : サンプリング間隔(秒|ピコ秒)
< 返値 >
  なし
< 説明 >
  メンバーに設定する。
time(self)
[ 関数名 ] time
< 引数 >
  なし
< 返値 >
  データオブジェクトの時間軸配列データ(numpy)
< 説明 >
  時間軸情報がない場合は、index配列になる。
val(self)
[ 関数名] val
< 引数 >
  なし
< 返値 >
  データオブジェクトの配列データ (numpy)
< 説明 >
  データオブジェクトのデータをnumpyクラスのオブジェクトに変換する。

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ArcFrames( )
    ArcFrames(i_type, x_size, y_size)
 
[ クラス名 ] ArcFrames
< パブリックメンバー >
  image_type (string)    : データ型 
  np_type (int)          : numpyデータ型
  bytes_per_sample (int) : 1サンプルあたりのバイト数
  x_size (int)           : X方向サイズ
  y_size (int)           : Y方向サイズ
  frames (Frame[])       : フレームデータ配列
 
< 参照系メソッド >
  val()    : データを取り出す(numpy) 
  num()    : フレーム件数
 
< 更新系メソッド >
  add_frame(self, binary_str, bsize=None)
                 : 1フレームのデータを追加する。
 
<説  明>
  同一形式のフレームの集合体
 
  Methods defined here:
__init__(self, i_type, x_size, y_size)
[ コンストラクタ ]
< 引数 >
  i_type (string) : イメージタイプ
  x_size (int)    : X方向サイズ
  y_size (int)    : Y方向サイズ
< 例外 >
  TypeError
add_frame(self, binary_str, bsize=None)
[ 関数名 ] add_frame
< 引数 >
  binary_str (ByteArray) : フレームデータ一次元配列
  bsize (int)            : データバイト数
< 返値 >
   なし
< 説明 >
  1フレームのデータを追加する。
< 例外 >
   RuntimeError : framesが初期化されていない場合
converted_rgb(self)
[ 関数名 ] converted_rgb
< 引数 >
  なし
< 返値 >
  データの3次元配列RGBデータ(numpy)
< 説明 >
< 例外 > 
  RuntimeError : フレームサイズが異なる場合
num(self)
[ 関数名 ] num
< 引数 >
  なし
< 返値 >
  フレーム件数 (int)
< 説明 >
val(self)
[ 関数名 ] val
< 引数 >
  なし
< 返値 >
  データの3次元配列データ (numpy)
< 説明 >
< 例外 > 
  RuntimeError : フレームサイズが異なる場合

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ArcSamples( )
    ArcSamples(dtype=None, binary_str=None, bsize=None)
 
[ クラス名 ] ArcSamples
< パブリックメンバー >
  block_bin_str (ByteArray) : サンプリングデータ
  image_type (string)       : データ型 
  np_type (int)             : numpyデータ型
  bytes_per_sample (int)    : 1サンプルあたりのバイト数
 
< 参照系メソッド >
  val()        : データを取り出す(numpy) 
  time()       : 時間軸配列データを取り出す(numpy) 
  num()             : データ件数
 
< 更新系メソッド >
  set_val(self, dtype, binary_str, bsize=None)
                 : データを設定する。
 
<説  明> 
  サンプリングデータを管理する。
 
  Methods defined here:
__init__(self, dtype=None, binary_str=None, bsize=None)
[ コンストラクタ ] 
< 引数 >
  dtype (string)         : データ型
  binary_str (ByteArray) : サンプリングデータ配列
  bsize (int)            : データバイト数
< 返値 >
  なし
< 説明 >
< 例外 >
  TypeError
num(self)
[ 関数名 ] num
< 引数 >
  なし
< 返値 >
  サンプリングデータのデータ件数(int)
< 説明 >
set_val(self, dtype, binary_str, bsize=None)
[ 関数名 ] set_val
< 引数 >
  dtype (string)        : データ型
  binary_str (ByteArray): サンプリングデータ配列
  bsize (int)           : データバイト数
< 返値 >
  なし
< 説明 >
  メンバー変数に設定する。
val(self)
[ 関数名 ] val
< 引数 >
  なし
< 返値 >
  データの配列データ (numpy)
< 説明 >
  サンプリングデータをnumpyクラスのオブジェクトで取得する。。

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class Frame( )
    Frame(binary_str, bsize=None)
 
[ クラス名 ] Frame
< パブリックメンバー >
   block_bin_str (string)    : フレームデータ(binary string)
 
< 参照系メソッド >
  byte_length()  : データバイト数
 
< 更新系メソッド >
 
< 説  明 > 
  1フレームのデータを管理する。
 
  Methods defined here:
__init__(self, binary_str, bsize=None)
[ コンストラクタ ]
< 引数 >
  binary_str (ByteArray) : フレームデータ配列
  bsize (int)            : データバイト数
byte_length(self)
[ 関数名 ] byte_length
< 引数 >
  なし
< 返値 >
  データバイト数
< 説明 >
  フレームデータのバイト数を取得する。(データ数ではない)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Author
        S.Imazu