[No.46]フレームレートを指定して、内部処理に使えるようにする

[emuemuJP]

一連のpipelineで動画のフレームレート（Fs, fps）は共通しているはずなのでNWBファイルの設定の一部として追加・各関数のパラメータの一部として読み込めるようにする

• 関連

  • 516

• PR

  • https://github.com/arayabrain/barebone-studio/pull/55

[ReiHashimoto]

開発要望管理表No.46

• Fs(fps)をNWB全般の設定に変える

• Fsの単位をフレームレートと時間のどちらかで指定できるようにしたい

• 以下は要望内容要確認

  • 内部的な処理としてbehaviorのデータは異なる場合がある。時間として合わせる。画像のサンプリングレートが処理をモジュールの方でアクセスできるか。
  • NWBのほうでもサンプリングレートの項目はある（imaging_rate）。デフォルトで30ではいっているがユーザがカスタマイズできるように

[ReiHashimoto]

仕様検討

• 現在のFsの単位はHz
• tiffファイルからフレーム数は取れる

ヒアリング事項

• Fsは手動で割り当てるしかないか？(ファイルのメタデータなどから自動的に取得できないか)
• 現状使用されている、Fsに関するパラメータの認識に相違がないか
  • NWB
  • imaging_plane.imaging_rate: 30
  • suite2p_roi
  • fs: 10.0

[ReiHashimoto]

• 使用されているパラメータのデフォルト値はどちらかに寄せる(30の予定)
• Fsは実験単位で異なるもののため、ユーザーで割り当てする必要がある
  • [x] caimanでもFsに相当するパラメータがあるかは引き続き確認
  • https://caiman.readthedocs.io/en/master/core_functions.html#caiman.source_extraction.cnmf.params.CNMFParams.__init__
  • cnmfでfr=30がデフォルトで使用されている
  • 現状のwrappersのcnmfではこのパラメータを使用していないため、共通パラメータを参照して割り当てる
  • このようなパラメータに対して、#550 のような機能を検討

[ReiHashimoto]

まとめ

ToDo

• [ ] (1) nwbのパラメータをwrapper関数から参照可能にする
  • Fs値（imaging_rate）を参照する目的
• [ ] (2) <BE, FE> 実行済ワークフローのnwb, snakemakeのパラメータをfrontendから参照可能にする
  • nwb, snakemakeのパラメータを/experiments APIで取得可能にする
  • experiment.yamlにnwb, snakemakeのパラメータのconfigを追加する
  • frontendで/experiments apiレスポンスのtype annotationなどの調整
    • imaging_plane.imaging_rate を #516 で利用する
• [ ] (3) fs関連のパラメータの統合
  • [ ] suite2p_roi
  • paramsのymlからfsを削除
  • fsをnwbのimaging_plane.imaging_rateから参照するように関数を修正
  • [ ] caiman_cnmf
  • frをnwbのimaging_plane.imaging_rateから参照するように関数を修正

詳細

(1)

• wrapper関数はstudio/app/common/core/rules/runner.py, cls.execute_functionから呼び出される
  • execute_function, およびfuncに対してnwbfileを渡すことでnwbfileをwrapper関数から参照可能となる
  • 各wrapper関数の引数にnwbfileを追加する
  • 懸念点
  • nwbfileは直前のinputファイルから取得したものに追記していく形式のため、フローが進むほどnwbfileオブジェクト自体が大きくなる。wrapper関数に渡してしまうのが設計として健全かどうか。

(2)

• experiment.yamlに書き込むフィールドとして、nwb, snakemakeを追加
  • workflow実行時パラメータを保存するため、という位置付け
  • それぞれ、以下のデフォルトパラメータのyamlファイルと同等の構成を記録する
  • studio/app/optinist/core/nwb/nwb.yaml
  • studio/app/common/core/snakemake/snakemake.yaml
  • ExptConfigクラスを上記処理を実現させるために適応させる
  • nwb, snakemakeの書き込みはrun api call直後の1回で、後から更新されない
  • studio/app/common/core/workflow/workflow_runner.pyのExptConfigWriter
• frontendではexperiments apiのデータ型変更に合わせて、type annotationの修正を行う

[hunghongnam]

Tổng hợp : Todo: (1) Cho phép tham chiếu param nwb từ hàm wrapper Mục đích là tham chiếu giá trị Fs (imaging_rate) (2) <BE, FE>Cho phép tham chiếu param nwb, snakemake của workflow đã chạy từ frontend Cho phép get param nwb, ​​​snakemake có thể được lấy bằng API /experiments

• Add config tham số nwb và snakemake vào Experiment.yaml
• Điều chỉnh type annotation.v.v trong response api /experiments trên frontend Sử dụng imaging_plane.imaging_rate trong task #516 (3) Tích hợp các tham số liên quan đến fs suite2p_roi
  • xóa fs khỏi params yml
  • sửa hàm số để cho nó có thể tham chiếu fs từ imaging_plane.imaging_rate của nwb caiman_cnmf
  • sửa hàm số để cho nó có thể tham chiếu fr từ imaging_plane.imaging_rate của nwb

[hunghongnam]

Detail (1)hàm wrapper được gọi từ studio/app/common/core/rules/runner.py, cls.execute_function

• Bằng cách truyền nwbfile tới exec_function và func thì có thể tham chiếu nwbfile từ hàm wrapper
• Thêm nwbfile vào param của các hàm wrapper
• Khách quan ngại điều sau : Vì nwbfile là một định dạng nối thêm vào những gì thu được từ file input trước đó, nên bản thân object nwbfile sẽ to lên khi flow tiến triển. Liệu đó có phải là một thiết kế hợp lý khi truyền đến hàm wrapper hay không?

(2) Thêm nwb và snakemake làm field để ghi vào Experiment.yaml

• lưu các tham số khi chạy workflow
• Ghi lại cấu hình tương đương với file yaml các thông số mặc định sau studio/app/optinist/core/nwb/nwb.yaml studio/app/common/core/snakemake/snakemake.yaml
• Điều chỉnh class ExptConfig để thực hiện được quá trình xử lý trên
• nwb và snakemake được ghi một lần ngay sau khi run api call và không được cập nhật sau đó ExptConfigWriter của studio/app/common/core/workflow/workflow_runner.py Ở Frontend, sửa type annotation theo sự thay đổi kiểu dữ liệu của experiments api