データのロギング

全般的な設定でファイルのロギングを有効あるいは無効にできます。ただし、コントローラーの実装ではロギングオプションについて気にする必要はありません。コントローラーでは、単一のインターフェイスからファイルのロギング操作を行えます。各コントローラーは専用のログを使用し、コンロトーラーが切り替わると新しいログが作成されます。シンボリックリンクをサポートするプラットフォームでは、使い勝手の観点から、最後に作成されたログを指すようにlatestログファイルが作成されます。

デフォルトでは、どのコントローラーでも以下の情報がロギングされます。

  • 反復時間（0で始まり、設定されたタイムステップごとに増加）
  • メインロボットのエンコーダー値（ロボットで参照される関節の順に保存）
  • （四元数で表された）フリーフライヤーの向きと（コントローラーで参照される）メインロボットの位置
  • メインロボットの関節コマンド（コントローラーで参照。ロボットで参照される関節の順に保存）
  • 関節のトルク（ロボットで参照される関節の順に保存）
  • 力覚センサーの測定値（トルクと力として保存）
  • フリーフライヤーの位置センサーの値（一部のインターフェイスのみ）
  • 向きセンサーの値（ロール、ピッチ、ヨー）
  • フリーフライヤーの直線速度センサーの値（一部のインターフェイスのみ）
  • 角速度センサーの値
  • 加速度センサーの値

ログエントリを追加する

コードにログエントリを追加するには、以下のようにします。

logger().addLogEntry("entry_name", [this]() { /* 例えばxを計算; */ return x; });

コントローラーでrun()メソッドが実行されると、用意されたコールバック関数が実行されます。

コントローラーがそのままの形で操作できるほとんどの型（sva::PTransformdやsva::ForceVecdなど）と文字列をログに記録できます。また、これらの型のベクトルもログに記録できます。

通常、addLogEntryを呼び出した場合、それと対になるremoveLogEntryも呼び出す必要があります。例:

logger().removeLogEntry("entry_name");

ロギングソースを指定する

以下のようにロギングソースを指定できます。

// この例では "this" がソース
logger().addLogEntry("entry_A", this, [this]() { return a; });
logger().addLogEntry("entry_B", this, [this]() { return b; });
logger().addLogEntry("entry_C", this, [this]() { return c; });

// 同じソースに対する呼び出しをまとめることもできます
logger().addLogEntries(this,
                       "entry_A", [this]() { return a; },
                       "entry_B", [this]() { return b; },
                       "entry_C", [this]() { return c; });

その後、すべてのエントリを一度に削除できます。

logger().removeLogEntries(this);

// こうしても結果は同じですが、addLogEntry と removeLogEntry が対応するように注意する必要があります
logger().removeLogEntry("entry_A");
logger().removeLogEntry("entry_B");
logger().removeLogEntry("entry_C");

ロギングのメンバーとメソッド

上記のように、thisインスタンスに対して呼び出されたメンバーあるいはメソッドを読み込むのが一般的であり、簡単に実現できます。この方法による主なメリットは、以下に示すようなパフォーマンスの問題を回避できることです。

struct MyObject
{
  Eigen::Vector3d data_;
  sva::PTransformd something_;

  Eigen::Vector6d computeVector();

  const sva::PTransformd & referenceBody();
  void referenceBody(const std::string &);

  void addToLogger(mc_rtc::Logger & logger)
  {
    // C++11で求められる実際の文法はこのようになります
    logger.addLogEntry<decltype(&MyObject::data_), &MyObject::data_>("data", this);
    // 記述を簡単化するマクロがあります
    MC_RTC_LOG_HELPER("something", something_);
    // メソッドも利用可能です
    MC_RTC_LOG_HELPER("computeVector", computeVector);
    // ただしオーバーロードされたメソッドの場合、こちらのマクロを使用する必要があります
    MC_RTC_LOG_GETTER("referenceBody", referenceBody);
  }
};

MC_RTC_LOG_HELPERとMC_RTC_LOG_GETTERは、以下の2つを前提としています。

  • ロギングソースはthisとする
  • データの追加先となるロガーインスタンスはloggerとする

Pythonインターフェイス

Pythonインターフェイスも非常によく似ています。

# ログのエントリを追加
self.logger().addLogEntry("my_entry", lambda: self.data)
# データを削除
self.logger().removeLogEntry("my_entry")
# コントローラのメソッドを呼ぶためにpartialを使用
self.logger().addLogEntry("my_entry", partial(self.get_data))

パフォーマンスに関する問題

デフォルトでは、ラムダ式は値渡しで値を返します。可能であれば、保存するオブジェクトへのconst参照渡しで値を返すようにするとよいでしょう。

logger().addLogEntry("entry", [this]() -> const sva::PTransformd & { return trans_; }

ログを取得する

コントローラーでは、以下のように、どのログが最新なのかを示すメッセージが表示されます。

Will log controller outputs to "/tmp/mc-control-MyControllerName-DATE.bin"

シンボリックリンクがサポートされているシステムでは、/tmp/mc-control-MyControllerName-latest.binから最新のログを見ることもできます。

ログを使用する

コントローラーによって生成されるログを使用する方法については、以下のページを参照してください。

次のチュートリアル: 画面への情報の表示