Eospedia - 利用者の投稿記録 [ja]

MaiML

2025-08-08T08:45:17Z

Tacyas:

MaiML(Measurement analysis intrument Markup Language)は、計測分析及びその関連の工程を包括的に記述するためのデータフォーマットである。JIS K0200として、JIS規格としてまとめられている。
　また、ガイドラインなどは、[[https://www.maiml.org/ www.maiml.org]]上から取り寄せることができる。

以下のような特徴をもつ
#独立可用性
##データファイルだけで，サーバー空間などに機器から独立しても，計測分析に関わる全てのデータを利用できること
##ＡＩ・データサイエンスの様なビッグデータ解析に利用できること
#可視化
##スキーマによる構造の定義と半構造化データ：XML準拠
#再現性
##ペトリネットによる計測分析の工程の表現：PNML準拠
#汎用的データ表現
##データ型，値，データ意味の記載：半構造化データの活用
##外部データ，多様なデータの挿入表現
#トレーサビリティ
##ログの記載：XES準拠
#一意性の保証
##UUIDの利用
#データのオープン／クローズ戦略
##秘匿化

MaiML

2025-08-08T08:43:47Z

Tacyas:

MaiML(Measurement analysis intrument Markup Language)は、計測分析及びその関連の工程を包括的に記述するためのデータフォーマットである。JIS K0200として、JIS規格としてまとめられている。
　また、ガイドラインなどは、[[maiml.org, https://www.maiml.org/]]上から取り寄せることができる。

以下のような特徴をもつ
#独立可用性
##データファイルだけで，サーバー空間などに機器から独立しても，計測分析に関わる全てのデータを利用できること
##ＡＩ・データサイエンスの様なビッグデータ解析に利用できること
#可視化
##スキーマによる構造の定義と半構造化データ：XML準拠
#再現性
##ペトリネットによる計測分析の工程の表現：PNML準拠
#汎用的データ表現
##データ型，値，データ意味の記載：半構造化データの活用
##外部データ，多様なデータの挿入表現
#トレーサビリティ
##ログの記載：XES準拠
#一意性の保証
##UUIDの利用
#データのオープン／クローズ戦略
##秘匿化

MaiML

2025-08-08T08:43:27Z

Tacyas:

MaiML(Measurement analysis intrument Markup Language)は、計測分析及びその関連の工程を包括的に記述するためのデータフォーマットである。JIS K0200として、JIS規格としてまとめられている。
　また、ガイドラインなどは、[[maiml.org https://www.maiml.org/]]上から取り寄せることができる。

以下のような特徴をもつ
#独立可用性
##データファイルだけで，サーバー空間などに機器から独立しても，計測分析に関わる全てのデータを利用できること
##ＡＩ・データサイエンスの様なビッグデータ解析に利用できること
#可視化
##スキーマによる構造の定義と半構造化データ：XML準拠
#再現性
##ペトリネットによる計測分析の工程の表現：PNML準拠
#汎用的データ表現
##データ型，値，データ意味の記載：半構造化データの活用
##外部データ，多様なデータの挿入表現
#トレーサビリティ
##ログの記載：XES準拠
#一意性の保証
##UUIDの利用
#データのオープン／クローズ戦略
##秘匿化

MaiML

2025-08-08T08:42:59Z

Tacyas:

MaiML(Measurement analysis intrument Markup Language)は、計測分析及びその関連の工程を包括的に記述するためのデータフォーマットである。JIS K0200として、JIS規格としてまとめられている。
　また、ガイドラインなどは、[[https://www.maiml.org/]]上から取り寄せることができる。

以下のような特徴をもつ
#独立可用性
##データファイルだけで，サーバー空間などに機器から独立しても，計測分析に関わる全てのデータを利用できること
##ＡＩ・データサイエンスの様なビッグデータ解析に利用できること
#可視化
##スキーマによる構造の定義と半構造化データ：XML準拠
#再現性
##ペトリネットによる計測分析の工程の表現：PNML準拠
#汎用的データ表現
##データ型，値，データ意味の記載：半構造化データの活用
##外部データ，多様なデータの挿入表現
#トレーサビリティ
##ログの記載：XES準拠
#一意性の保証
##UUIDの利用
#データのオープン／クローズ戦略
##秘匿化

MaiML

2025-08-08T08:42:31Z

Tacyas:

MaiML(Measurement analysis intrument Markup Language)は、計測分析及びその関連の工程を包括的に記述するためのデータフォーマットである。JIS K0200として、JIS規格としてまとめられている。
　また、ガイドラインなどは、https://www.maiml.org/上から取り寄せることができる。

以下のような特徴をもつ
#独立可用性
##データファイルだけで，サーバー空間などに機器から独立しても，計測分析に関わる全てのデータを利用できること
##ＡＩ・データサイエンスの様なビッグデータ解析に利用できること
#可視化
##スキーマによる構造の定義と半構造化データ：XML準拠
#再現性
##ペトリネットによる計測分析の工程の表現：PNML準拠
#汎用的データ表現
##データ型，値，データ意味の記載：半構造化データの活用
##外部データ，多様なデータの挿入表現
#トレーサビリティ
##ログの記載：XES準拠
#一意性の保証
##UUIDの利用
#データのオープン／クローズ戦略
##秘匿化

MaiML

2025-07-08T23:47:10Z

Tacyas: /* MaiML(Measurement, analysis and intrument markup language) */

MaiML(Measurement analysis intrument Markup Language)は、計測分析及びその関連の工程を包括的に記述するためのデータフォーマットである。JIS K0200として、JIS規格としてまとめられている。

以下のような特徴をもつ
#独立可用性
##データファイルだけで，サーバー空間などに機器から独立しても，計測分析に関わる全てのデータを利用できること
##ＡＩ・データサイエンスの様なビッグデータ解析に利用できること
#可視化
##スキーマによる構造の定義と半構造化データ：XML準拠
#再現性
##ペトリネットによる計測分析の工程の表現：PNML準拠
#汎用的データ表現
##データ型，値，データ意味の記載：半構造化データの活用
##外部データ，多様なデータの挿入表現
#トレーサビリティ
##ログの記載：XES準拠
#一意性の保証
##UUIDの利用
#データのオープン／クローズ戦略
##秘匿化

MaiML

2025-07-08T23:43:05Z

Tacyas: ページの作成:「= MaiML(Measurement, analysis and intrument markup language) =」

= MaiML(Measurement, analysis and intrument markup language) =

メインページ

2025-07-08T23:42:06Z

Tacyas:

== '''Eospediaにようこそ''' ==

2010年11月05日に、研究室内にEospediaクローズドβ版の運営を開始しました。 
2012年８月に、こちらが電子顕微鏡画像処理システムEosのホームページの本家となるように、オープンにしました。 
 
[[Eos]]のコマンド説明やその中のアルゴリズムについてなど、幅広い知識を集約できればと思います。また、2012年より開発を開始した[[PIONE]]、2013年度より開発を開始した[[VEM/WITs]]についても同様にこちらでまとめていきます。 
それに加えて、電子顕微鏡画像処理を含む、各種画像処理の基本を学ぶことができるサイトとして運営したいと考えています。 
 
[[Eos]]は、[https://sourceforge.jp/projects/eos/ Eos@sourceforge]上で、[[PIONE]]は、[https://github.com/pione PIONE@github]で開発を進めています。それらをまとめた情報はこちらで展開したいと思います。将来は、大学から離れた方が良いかと考えています。それぞれ開発や利用に興味があるかたはそれぞれのサイトも覗いてみて下さい。 
 
wikiは「間違いをいかに防ぐか」ではなく、「いかに修正するか」が哲学ですので、
間違いを恐れず(もちろんデタラメは論外)皆さんの知識とノウハウを自由に書いて頂ければ幸いです。 
 
只今ホームページに公開していたEosマニュアル(日本語版も含む)の転載作業を進めています。 
 
ちなみに、[http://www.yasunaga-lab.bio.kyutech.ac.jp/Eos/ 英語版]もあります。現在は、日本語版のほうが充実しています。 
 
また、Eosに関しては、[http://sourceforge.jp/projects/eos/lists/ メーリングリスト]及び[http://sourceforge.jp/projects/eos/forums/ フォーラム]があります。 
Eosの使い方を知りたい方は：eos-users@ 
Eosでの開発にご興味のある方は：eos-developers@ 
Eosのドキュメント作成のお手伝いを頂ける方は：eos-document@ 
にて、是非ともご協力下さい。 
 
また、facebook上で、Eos User Group[https://www.facebook.com/EosUserGroup]を開設しました。こちらからも発信していくことにします。 
 
詳細は,安永[mailto:yasunaga@bio.kyutech.ac.jp]までご連絡下さい。 
 

== 開発しているシステムの全体像（Eos/PIONE/Zephyr & WITs/VEM) ==
　現在、電子顕微鏡画像取得・処理・分析のための一連のワークフロー全体を総括するソリューションとして、Eos/PIONE/Zephyr & WITs/VEMとよぶシステムを作っています。システム全体の名前もつけたほうがよい位、Systems of System といった様相になってきています。個々に、当該システムの概要とその目指す姿をまとめておきたいと思います。

　下記のページにまとめておきます。
[[Eos/PIONE/Zephyr/WITs/VEM システム]]

== '''Eosビギナーズガイド''' ==

=== [[Eos|Eosとは？]] ===
　Eosとはなにかについて述べます。
=== [[コマンド|Eosのコマンドとは？]] ===
　Eosにおけるコマンドについて述べます。
=== [[Makefile|Eosはどうやって使うの？]] ===
　Eosにおける[[make]]を用いたコマンドの統合方法について述べます。
=== [[コマンド一覧|Eosのコマンド一覧表]] ===
　Eosが提供するコマンドの一覧を示します。
=== [[機能別コマンド一覧|Eosの機能別コマンド一覧表]] ===
　Eosが提供するコマンドの機能別一覧を示します。

== Eos/PIONEのインストール方法 ==
===[[必要な環境|Eosの必要な環境]]===

=== [[ダウンロード|Eosのダウンロード(インストール方法)]] ===
　Eosのダウンロード方法について述べます。利用するだけであれば、ダウンロードだけで利用することができます。共同開発を進めたい方、機能の要望がある方は、現在、EosはOSDN(旧：SourceForge)にて開発を進めています。是非、ご一緒して下さい。

=== [[インストール方法|Eosのインストール方法（開発・再構築）]] ===
　Eosのインストール方法について述べます。ここでは、ダウンロードしたファイルから再構築する方法や自分自身が開発したソースコードを運用する方法を述べています。

=== [[PIONEのインストール方法]]===
　makeに替わる分散プロセス処理プラットフォーム(PIONE)のインストール方法を示します。現在、PIONEはgithubにて開発を進めています。

== '''Eosリファレンス''' ==

=== [[統合コマンド|Eosの提供する統合コマンド]] ===
　Eosが提供する統合コマンドについて述べます。

=== 統合コマンド：[[PIONE]]===
　Eosが分散環境、クラウド環境に対応した統合環境として提供するPIONEについて述べます。インストールに関しては[[PIONEのインストール]]を、ブラウザ操作に関しては[[PIONEの起動方法]]や[[PIONE Webclientチュートリアル]]を、[[PIONE定義書]]の作り方や実行方法については[[PIONEチュートリアル]]や[[PIONEチュートリアル-PNML]]を、ログの確認方法は[[PIONEチュートリアル-XES]]を、パッケージの作り方は[[PIONEチュートリアル-package]]を、コマンドの一覧は[[PIONEコマンド一覧]]または[[機能別PIONEコマンド一覧]]を、メソッドの一覧などは[[PIONEの式]]を、その他TIPSなどは[[PIONEのTIPS]]をご覧下さい。 
 

=== 電子顕微鏡制御統合環境(WITs/VEM) ===

==== 相関顕微鏡のためのシステム ====
　同一視野の撮影のためのシステムの提供を進めています．[[SerialEM]]に対応する環境として，電子顕微鏡を仮想化するための[[VEM]]，および，[[VEM]]と通信して，電子顕微鏡を制御するための[[WITs]]というシステムに大きく分けて開発を進めています．

下記に[[WITs]]としてのアプリケーションのリストを示します．

[[WITs-CLEM]]: 相関顕微鏡向けのシステムになります．

== '''Eos チュートリアル'''　==
=== 環境の設定　===
最初にEosのインストール方法を簡単に説明します。詳細は、[[インストール方法|Eosのインストール方法の詳細]]をご覧下さい。

* [[Eosのインストール|Eosのインストール方法]]

=== Eosでのコマンドの取り扱い　===
Eosのコマンドの簡単な使い方を説明します。詳細は、[[コマンド|コマンドの詳細]]をご覧下さい。Eosでは、基本はCUIを使ったコマンドの実行により画像処理を進めます。その結果は、ファイルとして保存され、その内容を確認することが出来ます。

* [[Eosのコマンド|Eosのコマンド]]

=== Eosでの画像の取り扱い　===
Eosで取り扱うことのできる[[画像フォーマット]]と一般的な画像フォーマットからの変換方法を示します。
* [[画像フォーマット|画像フォーマット]]
* [[画像フォーマット変換|画像フォーマットの変換]]

=== Eosを使った簡単な画像処理　===
Eosを使った簡単な画像処理を実行してもらいます。
* [[簡単な画像処理|簡単な２次元画像処理]]

=== [[チュートリアル一覧]] ===
ここには、[[Small Tools]]や様々な[[画像処理]]で使用する[[Makefile]]や[[PIONE]]の一覧があります。

=== CTF画像補正　===
電子顕微鏡画像では、その撮影方法に由来して、コントラストが大きく変調を受けています。ここでは、その画像のコントラストの変調を補正する方法を示します。
* [[CTF補正|CTFの補正]]

=== 単粒子解析の基礎　===
　ここでは、単粒子解析の基礎を行います。実際の単粒子解析は、粒子の形やその対称性などを使って探索方法や3次元再構成法を切り替えることができます。

==== [[単粒子解析]]の概要 ====
　単粒子解析の概要を示します。

==== [[粒子抽出|粒子の抽出]] ====
　まず、単粒子を抽出します。ここでは、手動で切り出す方法を示します。自動で切り出す方法も各種提案されています。

==== [[２次元画像の分類|２次元画像の分類]] ====
　２次元画像を分類して、ＳＮ比を上げます。

==== [[参照付投影角度決定|参照像があるときの投影角の決定方法]] ====
　参照像があるときの投影角の決定方法を説明します。参照像としては、単なる球や楕円体などとすることもあり得ます。参照像がない場合の構造解析法も別途存在しています。

==== [[参照無投影角度決定|参照像がないときの投影角の決定方法]] ====
　参照画像がないときの投影角の決定方法を示しています。[[コモンライン]]をもちいた[[コモンライン探索]]という方法が一般的です。ただノイズに弱く問題が生じる場合があります。

==== [[３次元再構成・逆投影|３次元再構成・逆投影法]] ====
　3次元再構成自身を解説します。

==== [[らせん対称をもつ粒子の３次元再構成法]]====
　アクチンフィラメントなどのらせん対称性をもつ場合のEosでの解析法を紹介します。

==== [[可視化ツール|可視化ツール]] ====
　できあがった三次元像を可視化するためのツールを紹介します。

====参考資料 ====

===== [[RELION]] =====
　単粒子解析法のデファクトスタンダードになりつつある[[RELION]]について、解説を準備することにしました。
少しずつ整理していきます。

===== [[Gautomatch]] =====
　粒子抽出のためのプログラムのひとつです。

===== [[cryoDRGN]] =====
　深層ニューラルネットワークを用いた単粒子3D再構成プログラム[[cryoDRGN]]に関するページです。

===== [[Topaz]] =====
　深層ニューラルネットワークを用いた単粒子ピッキングプログラム[[Topaz]]に関するページです。

===== [[cryoSPARC]] =====
　優れたUIを持った単粒子解析パッケージ[[cryoSPARC]]に関するページです。

==== 備考 ====
　上記のチュートリアル・ページは、2012/09/10-11 単粒子解析Workshopでの資料を元に作成したものです。
今後もこのサイトを充実させ、ワークショップ等で利用していきたいと考えています。

=== [[電子線トモグラフィー]] ===
　電子線トモグラフィーとは、同一視野の連続傾斜像から、その視野の３次元画像を再構成する方法です。細胞内の構造や構造多型性をもつタンパク質の構造解析に有効な方法です。

==== [[電子線トモグラフィー]]の概要 ====
　電子線トモグラフィー法は、同一視野の傾斜シリーズ画像のセットから３次元像を再構成する方法です。ここではその概要を述べます。

==== [[画像の補正]] ====
　傾斜画像では、視野全体がアンダーフォーカスとなるように、通常の電子顕微鏡撮影よりも大きなデフォカース値をとる場合が多いです。その場合、LaB6などの電子銃では第一トーンリングより外側の情報がほとんど無いために、CTF補正等は必要ありませんが、電界放出銃を利用した場合には、場合によっては間違った情報を与える場合があるので注意が必要です。

==== [[ラフ・アラインメント]] ====
　傾斜画像の中心付近の画像の相関から、それぞれの傾斜画像の大まかな位置を合わせます。

==== [[ファイン・アラインメント]] ====
　傾斜画像の軸の位置、角度を出来る限り一致させます。

==== [[３次元再構成]] ====
　２次元画像のセットから３次元画像を再構成します。

==== [[電子線トモグラフィー画像のもつ問題点]] ====
　全方位からの投影像を得られないために、ミッシングエリアとよばれる情報がない領域があります。そのため、方向依存でのボケを生じます。

==== [[トモグラム画像の解釈]] ====
　多様な構造を含むため、３次元画像から興味あるセグメントを切り出すなどの作業が必要です。そのための支援ソフトウェアが必要です。

==== [[サブトモグラム画像の平均化]] ====
　クライオ電子顕微鏡画像からトモグラム画像はノイズが多いため、同等の構造をしたものを平均化する必要があります。

==== 参考資料 ====
===== [[IMOD/ETomo]]の使い方=====
　[[IMOD/ETomo]]は、電子線トモグラフィー法やシリアルセクションなどで使われる、デファクトスタンダードともいえる3次元再構成プログラムです。

====== [[eTomoチュートリアル]] ======
　eTomoのチュートリアルを示しています。

=== 連続２次元画像からの３次元再構成 ===
　連続切片(Serial Section）や、連続ブロック表面(Serial Block Face)からの３次元再構成のための手順を示したものです。

==== [[SBF-SEMからの３次元再構成]] ====

== Eosにおける開発（開発者向け） ==

　Eosのもうひとつのウリは迅速なプログラムの開発です。その手法について下記に述べます。

=== [[Eosの構造|Eosの構造]] ===
　Eosの構造(Architecture）について述べます。

=== [[Eosの開発|Eosの開発]]===
　SourceForgeからクローンを作成し、localで新規ツールなどを開発した後、SourceForgeに登録するまでの流れを示します。

=== [[Eosの開発におけるTIPS]] ===
　Eos上で開発する際のTIPSをまとめています。

=== [[ツールの開発]] ===
==== [[ツールの作り方]] ====
　Eosの上での[[Small Tools]]([[コマンド群]])の作り方について述べます。

==== [[簡単なプログラム例]] ====
　Eosの上での[[Small Tools]]([[コマンド群]])の簡単なプログラム例について述べます。

=== [[ライブラリ（API）の作り方]]===
　Eosの上での[[オブジェクト指向型ライブラリ]]（[[API]]）の作り方について述べます。

=== [[ライブラリ(API)一覧]]===
　Eosの上での[[オブジェクト指向型ライブラリ]]（[[API]]）の一覧です。

=== [[機能別ライブラリ(API)一覧]]===
　Eosの上での機能別に分類された[[オブジェクト指向型ライブラリ]]（[[API]]）の一覧です。

並列処理のためのライブラリ
*[[eosCuda]]: CUDA を使うためのライブラリ
*[[eosPThread]]: pthread を使うためのライブラリ

=== [[統合コマンドの作り方]]===
　統合コマンドの作り方を示します。

==== [[Makefileによる統合]] ====
　[[Makefile]]を用いた統合方法について示します。[[Visualmake]]は自動的に簡易型のGUIを提供します。

==== [[PIONEによる統合]] ====
　分散環境（クラウド環境）に対応したプロセス定義書[[PIONE]]を用いた統合方法について示します。

==== [[PIONEチュートリアル]] ====
　[[PIONE]]の使い方を示したチュートリアルです。

==== [[PIONEチュートリアル-PNML]]====
　[[PNML]]を用いたPIONE定義書の設計方法を示しています．

==== [[PIONEチュートリアル-XES]]====
　ログファイルを[[XES]]形式に変換し、[[ProM]]を利用して処理結果を確認する方法を示しています。

==== [[PIONEチュートリアル-package]]====
　[[PIONE定義書]]などをひとつにまとめたパッケージを作成する方法を示しています。

==== [[bashによる統合]] ====
　bashなどのスクリプト言語による統合方法について示します。

==== [[統合コマンドによる統合]] ====
　[[Display2]], [[smolet]], [[Eos]]などのTcl/Tk型の統合コマンドによる統合, [[ctfDisplay]]等のRuby型の統合コマンドによる統合，[[molvie]]などのＣ言語型の統合コマンドによる統合、などの各種方法について示します。

=== [[並列処理による高速化]] ===
　Eosでは、makeを使った単一ホストでのプロセスレベルでの並列処理、PIONEを使った分散環境におけるプロセスレベルの並列処理に加えて、pthread/GPGPUを用いたthreadレベルでの高速化も試行しています。すべてのコードが対応している訳ではありませんが、随時、対応を進めています。

===== [[eosPThread]] =====

===== [[eosCuda]] =====

=== [[よく使うシェルコマンド]] ===
　ここでは[[コマンド]]、[[Makefile]]、[[PIONE]]などの作成や実行においてよく使うシェルコマンドを簡易的にリストアップしています。

== [[画像処理]] ==
=== [[画像処理一般]] ===
　ここでは画像処理一般に関する話をまとめています。

==== [[簡単な画像処理]]====
　Eosを使った簡単な画像処理に関するチュートリアルが掲載されています。

==== [[画像の入力]]と[[レンズ]] ====
　コンピュータを使って画像処理を行う前に、画像がデジタル化される入力装置のことを気にしておく必要があります。

==== [[CTF]],[[PSF]]と[[MTF]]====
　真に得たい画像をf(x,y)で表現した場合に、[[画像の入力]]方法や[[レンズ]]の性能などによりどうしても画像が劣化します。

==== [[標本化]] ====
　アナログ画像をデジタル画像にするためには、空間を刻み、離散化することが重要です。このステップを標本化といいます。

==== [[量子化]] ====
　デジタル画像処理では、アナログである濃度値（光学密度）をあるビット数内で表現する量子化（ＡＤ変換）という操作が最初に必要です。

==== [[ノイズ除去]] ====
　ノイズが非常に多い画像を取り扱うためには、ノイズの性質をよく知ることが重要です。

===== [[平滑化]] =====
　画像のもつノイズを取り除くことを主たる目的として実施する画像処理方法です。ノイズの性質をよく理解することで、適切なノイズ除去が可能になります。

==== [[エッジ検出]] ====
　対象物の形を理解するために重要なステップですが、とても難しいステップでもあります。

==== [[２値画像処理]] ====
　シグナルと背景の切り分けや、代表点や骨格の抽出など、画像処理や解析のスタートとなる処理方法です。

==== [[フーリエ空間]]を利用した画像処理 ====

==== 実空間の[[カーネル]]を用いた画像処理 ====

==== [[マスマティカル・モルフォロジー]]を使った画像処理 ====

=== [[電子顕微鏡画像処理]] ===
　電子顕微鏡画像処理に関する話をまとめています。

==== [[モンタージュ]]、[[パノラマ]]画像 ====
　異なる領域を撮影した複数の画像（ただし、その一部は重なっている画像のセット）を組み合わせて、広領域の画像をつくる方法です。

==== [[CTF補正]] ====
　電子顕微鏡の画像は、原理的に、画像変調を受けています。その画像変調を補正する為の画像処理です。

==== [[３次元画像の位置合わせ]] ====
　３次元画像同士を平均し、雑音をとるための手法です。

==== [[シリアル画像の位置合わせ]] ====
　連続切片の画像同士の位置を合わせることで、三次元像を再構成する手法です。

=== [[３次元再構成法]] ===
　３次元再構成法とは、２次元の画像から３次元の画像を再構成する技術です

==== [[中央断面定理]]====
　投影像からなぜ、内部の構造がわかるのか、それを支えているのがこの中央断面定理です．

==== [[フーリエ法]]====
==== [[逆投影法]]====
==== [[SIRT]]====

== [[3Dモデル関連]] ==
=== [[chimera]] ===
　ボリュームデータやＰＤＢデータなどを可視化表示するためのソフトウェアです。
=== [[chimerax]] ===
=== [[vmd]] ===
=== [[NAMD]] ===

== [[電子顕微鏡制御]] ==
　電子顕微鏡制御のためのソフトウェアを開発しています。[[VEM]]は、仮想電子顕微鏡として各種の電子顕微鏡のコマンドを統一するためのシステムです。[[WITs]]は、VEMを通して電子顕微鏡を操作するためのUI(User Interface)です。

=== [[FEIの制御]]===

== [[電子顕微鏡]] ==
　ここでは電子顕微鏡に関する基礎、FAQ、TIPSをまとめておきます。

=== [[電子銃]]===
　電子顕微鏡の電子線源である電子銃についての解説です。

=== [[電子レンズ]]===
　透過電子顕微鏡の光学系、及び、レンズの仕組みに関する解説です。

=== [[透過型電子顕微鏡のコントラスト]]===
　透過型電子顕微鏡(TEM)がつくるコントラストに関する解説です。

=== [[走査型透過電子顕微鏡のコントラスト]]===
　走査型透過電子顕微鏡(STEM)がつくるコントラストに関する解説です。

=== [[走査型電子顕微鏡のコントラスト]] ===
　走査型電子顕微鏡(SEM)がつくるコントラストに関する解説です。

=== [[クライオ電子顕微鏡法]] ===
　クライオ電子顕微鏡法に関する解説です。

=== [[電子顕微鏡のFAQ]] ===
　電子顕微鏡に関するよくある質問に対する回答です。

=== [[電子顕微鏡のTIPS]] ===
　電子顕微鏡を利用する際などのTIPSをまとめることにしました。

== [[ロードマップ|Eosの今後の発展（ロードマップ）について]] ==
　Eosの今後の開発方針([[ロードマップ]])について述べます。

=== [[ロードマップ]] ===
　現在、開発はOSDNのチケットシステムを利用しており、チケット駆動型開発になっています。チケットの粒度はさまざまで、現在、いろいろと試しながら、開発環境を構築しています。

=== [[CUDA]]への対応 ===
　[[EosのCUDAへの対応状況]]を述べます。
　

== FAQ and TIPS ==
=== [[FAQ]] ===
　よくある質問をまとめました。まだまだ不十分ですが、少しずつ増やしていきたいと思います。

=== [[EosのTIPS]] ===
　よくある画像処理法をまとめてました。まだまだ不十分ですが、少しずつ増やしていきたいと思います。

=== [[Eos関連ソフトウェアのTIPS]] ===
　Eosに関連するソフトウェアの使い方をまとめています。

=== [[LINUXに関連したソフトウェアのTIPS]] ===

=== [[OSXに関連したソフトウェアのTIPS]] ===
　ＯＳＸで利用されているソフトウェアについてまとめています。

== 開発にかける思い ==
　開発当時と比べても非常に多くのソフトウェアが開発され、利用されている。その中で、継続的に開発していく意味はどこにあるのだろうか。[[開発にかける思いByYasunaga]]を少しずつ書き綴っていこう。

== Eos User Group ==
　Eosを利用する上での情報共有の場を、仮にFacebookの上に作りました。参加されたい方は、facebook上で登録をお願いします。

== '''イメージイラストについて''' ==

現在、Eospediaのイメージイラストを募集中です。
我こそはという方はEospedia管理者まで御連絡下さい。

Eospedia(WIKI)の使い方・設定に関しては、[http://meta.wikimedia.org/wiki/Main_Page ユーザーズガイド]を参照して下さい。

== Eos関連ツール及びサイト ==
=== 開発言語 ===
*[[C]]
*[[C++]]
*[[Ruby]]
*[[Tcl]]
*[[Tk]]

=== ワークフロー関係(PIONE) ===
==== ペトリネット ====
*[[PNML]]
*[[WoPeD]]
==== アクション記述 ====
*[[Markdown]]

==== ログファイル ====
*[[プロセスマイニング]]：プロセスをモデル化，可視化し，そこから，プロセスの課題などをデータマイニングの手法を使って取り出す分析方法
*[[XES]]:ログファイル形式
*[[ProM]]:可視化のためのツール

=== ドキュメント作成ツール ===
*[[Pandoc]]
*[[html]]
*[[mediawiki]]
*[[Eospediaの編集で使用しているツール]]

== エディタ、統合開発環境 ==
=== [[Visual Studio Code]] ===
Microsoft主導でオープンソース開発が進められている、クロスプラットフォーム(Windows/macOS/Linux)のプログラミングエディタです。

=== [[Vim]] ===
言わずと知れた著名なテキストエディタです。非常にとっつきにくいですが、慣れると捗ります。

== その他 ==
=== [[クライオ電顕備忘録]] ===
　クライオ電顕関連の備忘録です。まとまり次第他の項目に順次移したりします。

=== [[MicroED]] ===
MicroED(Micro crystal Electron Diffraction:微結晶電子線回折)に関する情報を書き残していきます。

=== [[リモートワーク推進]] ===
リモートワーク推進のためのツール関連について書き残していきます。

=== [[Python]] ===
Python関係について書き残していきます。

=== [[Linux関連]] ===
Linux関連について書き残していきます。

=== [[EMAN2関連]] ===
EMAN2関連について書き残していきます。

=== [[Moodle関連]] ===
Moodle関連について整理しています。

=== [[計算機利用ことはじめ]] ===
研究室で初めて計算機を使う方へ向けたお役立ち情報を書いていきます。

=== [[単粒子解析ことはじめ]] ===
研究室で初めて単粒子解析をする方へ向けたお役立ち情報。

=== [[クライオ電顕ことはじめ]] ===
研究室でクライオ電顕観察に挑戦する方へ向けて。

=== [[Docker関連]] ===
Dockerを利用して研究、開発の環境を構築する方法を書いていきます。

=== [[EMPIAR]] ===
電顕画像データベースである[[EMPIAR]]について

=== [[XML Schema]] ===
XMLのデータ構造を定義するための言語であるXML Schema(スキーマ)について

=== [[Git]] ===

=== [[Tcl/Tk]] ===

=== [[HDF5]] ===

=== [[研究お役立ちツール]] ===
研究活動をするうえで役に立つと思ったツールを書いておきましょう。

== MaiML入門 ==
MaiML(JIS K0200)は、計測分析及びその関連の工程を中心として、包括的にデータとして記録するためのデータフォーマットであり、データレイクとしてのカタログとしても対応可能である。

=== [[MaiML]] ===

== 外部リンク ==
=== Eos関連サイト===

* [http://www.yasunaga-lab.bio.kyutech.ac.jp/EosJ/ Eospedia.jp]
* [http://www.yasunaga-lab.bio.kyutech.ac.jp/Eos/ Eospedia.en]
* [http://sourceforge.jp/projects/eos/ Eos SourceForge]

=== 電子顕微鏡画像処理関連サイト ===
*[https://www.imagescience.de/em2em.html em2em]:汎用画像フォーマット変換ツール
* [http://en.wikibooks.org/wiki/Software_Tools_For_Molecular_Microscopy Software Tools For Molecular Microscopy]
* [http://emdatabank.org/emsoftware.html EM Software on EMDataBank]

=== 所属関連サイト ===
* [http://www.yasunaga-lab.bio.kyutech.ac.jp/ 安永研究室]
* [http://www.bio.kyutech.ac.jp/ 生命情報工学科]
* [http://www.iizuka.kyutech.ac.jp/ 情報工学部／情報工学府]
* [http://www.kyutech.ac.jp/ 九州工業大学]

== メディアウィキの始め方 ==
* [[testpage]] : メディアウィキのテスト頁
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings/ja 設定一覧]
* [http://www.mediawiki.org/wiki/Manual:FAQ/ja MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki リリース情報メーリングリスト]

ダウンロード

2024-09-09T07:36:07Z

Tacyas: /* ● GITHUBをご利用の方 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====

===== ● OSDNを利用の方 =====

====== 必要ツールのダウンロード　======

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

====== インストール方法　======

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone git@github.com:tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 超簡易インストール（共同開発をしたい方向け）　====
===== ● OSDNを利用の方 =====

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone git@github.com:tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T07:35:39Z

Tacyas: /* ● GITHUBをご利用の方 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====

===== ● OSDNを利用の方 =====

====== 必要ツールのダウンロード　======

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

====== インストール方法　======

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone git@github.com:tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 超簡易インストール（共同開発をしたい方向け）　====
===== ● OSDNを利用の方 =====

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone https://github.com/tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T07:21:03Z

Tacyas: /* 超簡易インストール（共同開発をしたい方向け）　 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====

===== ● OSDNを利用の方 =====

====== 必要ツールのダウンロード　======

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

====== インストール方法　======

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone https://github.com/tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 超簡易インストール（共同開発をしたい方向け）　====
===== ● OSDNを利用の方 =====

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone https://github.com/tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T07:08:57Z

Tacyas: /* 超簡易インストール（利用したいだけの方向け）　 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====

===== ● OSDNを利用の方 =====

====== 必要ツールのダウンロード　======

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

====== インストール方法　======

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

===== ● GITHUBをご利用の方 =====

現状では、まだ環境設定を自由にできるツールに変更出来ていないので、

$ cd $HOME

として、ホームディレクトリにEosのディレクトリができることを前提にしています。
下記のコマンドにより、Eosのディレクトリができます。

$ git clone https://github.com/tacyas/Eos.git

or もし、github上にアカウントをもち、ssh用のキーが登録されている場合

$ git clone https://github.com/tacyas/Eos.git

その後、環境設定をします。現在は、$HOME/Eosにあることを前提にしておりますが、EOS_HOMEという環境変数を使うこととしています。

$ source Eos/env/Eos_env

導入テスト

$ mrcInfo -h

により、下記の内容がでれば成功です。XXXXのところは環境依存です。

Usage: /Users/tacyas/Eos/bin/XXXX/mrcInfo
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input::mrcImage
[-i[nput]t[ype] InType (Eos ).as(String ) ] :Optional :InputType
[-o[utput] Out (stdout ).as(outFile::ASCII ) ] :Optional :Output::ASCII
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
-mode
+16: one line Tailer information
>> MRC Mode
Eos
CCP4-2000
IMODextendedMRC
FEIextendedMRC

この後、動作しない場合は、再構築をすることになります。

$ cd $EOS_HOME
$ make rebuild

により再構築が可能です。

==== 超簡易インストール（共同開発をしたい方向け）　====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

● GITHUBを利用の方

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T06:49:41Z

Tacyas: /* 必要ツールのダウンロード　 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====
===== 必要ツールのダウンロード　=====

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

===== インストール方法　=====

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

==== 超簡易インストール（共同開発をしたい方向け）　====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

● GITHUBを利用の方

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T06:49:26Z

Tacyas: /* 必要ツールのダウンロード　 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====
===== 必要ツールのダウンロード　=====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

===== インストール方法　=====

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

==== 超簡易インストール（共同開発をしたい方向け）　====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

● GITHUBを利用の方

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T05:12:44Z

Tacyas: /* 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====
===== 必要ツールのダウンロード　=====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

●　GITHUBをご利用の方

===== インストール方法　=====

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

==== 超簡易インストール（共同開発をしたい方向け）　====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

● GITHUBを利用の方

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

ダウンロード

2024-09-09T04:50:09Z

Tacyas: /* 超簡易インストール（共同開発をしたい方向け）　 */

'''Eos'''のダウンロード方法について

== 前段階 ==

=== OS-X(Mac)で利用したい方 ===
OS-Xで動作させたい方は、[[EosOnMac]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

=== Linuxで利用したい方 ===
Linux上で動作させたい方は、[[EosOnLinux]]で示されたプログラムをインストールしてから、下記の手順でダウンロードしてください。

== gitが利用できる方 ==

gitがご利用できる方は、SourceForge.jpからのダウンロード([[http://sourceforge.jp/projects/eos/ projects/eos]])が可能です。gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]をご覧下さい。以下は、簡単にインストールに関連するコマンドをまとめておきます。

=== 簡易インストール (git版：初めて Eosを利用したい方、とにかくEosを画像処理に使ってみたい方) ===
　初めてEosを利用したい方は、次のコマンドで実行することが出来ます。

　それぞれのコマンドの意味は、下記に記述しています。

==== 超簡易インストール（利用したいだけの方向け）　====
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、ブラウザで直接、下記にアクセスすると、ダウンロードできます。

[https://ja.osdn.net/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eos.sh]

[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?n　　　　　　　　　OSDN上にアカウントがなく、ひとまずインストールして利用したい方は入力しなくてよいです。　　　　　　
Do you want to rewrite /home/Eos/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/Eos/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

もしも，OSのバージョン等の関係で動かなかったときは，下記のコマンドで再構築して下さい．
$ cd $EOS_HOME
$ make rebuild

==== 超簡易インストール（共同開発をしたい方向け）　====
● OSDNを利用の方

$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh
$ curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

もしくは、直接、ブラウザでダウンロードして下さい。
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw install-eso.sh]
[https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env]

● GITHUBを利用の方

$ source /tmp/Eos_env
$ source /tmp/install-eos.sh
Set the directory to be installed in [/home/XXX/Eos]: 　　　　　　　　XXXは、ホームディレクトリを示しています。そのままでよいなら、Enterを、変更したければ入力して下さい。
Directory: /home/XXX/Eos
Do you have your git account for OSDN [Y|y or N|n] ?y　　　　　　　　OSDN上のアカウントをお持ちの方はy　として設定して下さい。　　　　　　
Set the git account for OSDN [XXX]: ssh-keygenを設定したアカウントを設定して下さい。通常はそのままで大丈夫です。
Do you want to rewrite /home/XXX/.bash_prfile ? [Y|y or N|n] y　　　　　環境変数の設定をするかどうかを示しています。
Do you want to rewrite /home/XXX/.bashrc ? [Y|y or N|n] y
Cloning into '/home/XXX/Eos'...
Username for 'https://scm.osdn.jp': XXXXX OSDN上のユーザー名を入力して下さい。
Password for 'https://XXXXX@scm.osdn.jp': 　　　　　　　　　　　　　OSDN上のパスワードを入力して下さい。
-----
Cloning into 'YYYYYYYYY'...　　　　　　　　　　　　　　　　　　　　　YYYYYYYYは、ホストの環境毎に異なります。
-----
Setting an environment for Eos
Please check /home/Eos/.bash_profile.
You finished Eos installation.

==== 各コマンドの詳細 ====
===== install-eos.sh のダウンロード=====
インストーラをダウンロードします。zshなどで、?が特別な意味を持つ場合には、¥?に置き換えてみて下さい。

<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/install-eos.sh?export=raw > /tmp/install-eos.sh

として、インストールコマンドをダウンロードします。

===== Eos_env のダウンロード=====
<strike>curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

同様に、SourceForgeからではなく、OSDNからのダウンロードに変更して

curl -L https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

若しくは、

<strike>wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env</strike>

wget -q -O - https://osdn.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw > /tmp/Eos_env

として、環境設定ファイルをダウンロードします。

===== Eos本体のダウンロード(インストール） =====

====== インストールコマンドの実行方法 ======
　上記の二つのファイルがダウンロード出来た後に次のコマンドを実行して下さい。

まず、環境変数を設定します。
$ source /tmp/Eos_env

$ source /tmp/install-eos.sh
or
$ source /tmp/install-eos.sh a_directory_to_be_installed
or
$ source /tmp/install-eos.sh a_directory_to_be_installed osdn_username

インストールするべきディレクトリ（a_directory_to_be_installed）や、osdn_usernameが指定されている場合には、次からのいくつかのステップがスキップされます。

＊install-eos.shは、随時、バージョンアップしていますので、注意して下さい。

====== インストール先ディレクトリの設定 ======

　次に、インストール先のディレクトリを尋ねられますので、入力して下さい。上記で、インストール先のディレクトリが指定されている場合にはスキップされます。
そのままEnterキーを押すと、デフォールト（通常は、$HOME/Eos）となっている$HOME/Eosにインストールされます。

Set the directroy to be installed [/Users/xxxx/Eos]: /Users/xxxx/EosTest

として、空のディレクトリを指定して下さい。そのままエンターを押すと、現在表示されているディレクトリにインストールされることになります。

＊　空のディレクトリでなく、既にインストールしているディレクトリが設定された場合には、下記のエラーを出して終了します。
Already installed
Use update-eos.sh for updating or set a new directory for installation

＊　デフォールトディレクトリを予め変更したい場合には、環境変数EOS_HOME0を設定して下さい。
$ export EOS_HOME0=/tmp/Eos

====== gituserの設定 ======
　OSDNにユーザーとしてアカウントを持っているかどうかが尋ねられます。

　ダウンロードした方が、ツールを共同開発するのでなければ、nまたはNを入力して下さい。

Do you have your git account for OSDN [Y|y or N|n] ? n

　ツールを共同開発する場合には、OSDNとしてのユーザー登録が必要です。この作業はあとからでも可能です。
自分自身のダウンロードしたものを変更することはユーザー登録がなくても問題ありません。開発したものを
OSDN上にプッシュ（アップロード）するために必要となります。

Do you have your git account for OSDN [Y|y or N|n] ? y
Set the git account for OSDN [XXX]:XXX

として、設定して下さい。このXXXは、通常、ユーザー名です。OSDN上のアカウントではなく、こちらでgitを使うユーザーのアカウントです。

====== 環境変数の設定方法 ======

　環境変数などを設定するEos_envの呼び出しを.bash_profileを組み込むかどうかを選択します。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] n

こちらを選択した場合には、自分で設定してもらうか、毎回、sourc $EOS_HOME/env/Eos_env を実行することになります。

Do you want to rewrite /Users/tacyas/.bash_prfile ? [Y|y or N|n] y

こちらの場合には、.bash_profileに書き加えられます。
下記の範囲に書かれており、書き換えられる可能性があるので注意して下さい。
## Eos_env Start
.....
## Eos_env End

====== インストールの開始 ======

　後は、自動的にダウンロードが始まります。

　OSDN上にアカウントがあると答えた方は、OSDN上のアカウントを途中で聞いてこられます。
Username for 'https://scm.osdn.jp': XXXXX
Password for 'https://XXXXX@scm.osdn.jp':

　その後、順調に設定が終了すれば、最後に、

You finished Eos installation.

が出力されます。
　<strike>ホームディレクトリの中の.bashrcファイルの中に、シェルの起動時にEos_envを実行するスクリプトが挿入されています。</strike>

うまくいかない場合には、ダウンロードしてきた/tmp/Eos_env、もしくは、上記で指定したディレクトリ/env/Eos_envを起動時に実行することになります。
$ source Eos_env
にて実行できます。

実行環境によっては、$HOME/.profileの中に書き込む必要がある場合があります。

下記を参考にして下さい。$HOME/Eosとしてインストールされているものとなっています。
別の場所にインストール場合には、EOS_HOME0のコメントをはずして、設定する必要があります。
また、OSDN上にユーザーアカウントをもって、共同開発を考えている方は、EOS_GITUSER0を設定する必要があります。

## Eos_env Start
##

if [ ! -z $EOS_HOME0 ] ; then
if [ -f $EOS_HOME0/env/Eos_env -a ! -f $HOME/.Eos_env ] ; then
ln -s $EOS_HOME0/env/Eos_env $HOME/.Eos_env
fi
fi

#export EOS_HOME0=Eos
#export EOS_GITUSER0=EosUser

test -r $HOME/.Eos_env && . $HOME/.Eos_env

##
## Eos_env End

==== 実行の確認 ====

$ mrcInfo -h

が動けばひとまずインストールの完了です。

●注意事項１：いくつかのコマンドは、cuda、X11などの環境がないために動作しない環境があったりします。その場合には、必要なライブラリ等をインストールしたりする必要があります。その詳細は別に述べます。

●注意事項２：この状態で、自分自身のところで開発を行うことはできます。ただし、sourceforge上にアップロードすることはできません。アップロードしたい場合には、originのURLの変更とsourceforge上のアカウントの登録が必要です。また、最新版しかダウンロードしていません。過去の履歴を全てダウンロードしてこないと、gitの仕様上、アップロードしていくことができません。gitのunshallow機能をつかって、全てをダウンロードする必要があります。詳細は別に述べます。

●注意事項３：OS-X(10.11, El Capitan)では、dyldの関係でcudaライブラリ等がロード出来ません。SIPをdisableにする必要が現在あります。このページの下にあるトラブルシューティングを参考にして下さい。

=== gitコマンドを直接使ってインストールしたい方：初めてのディレクトリにインストールする場合 ===
Eosの複製をgitを使って作製します。

==== Eosの共同開発を考えている場合（SourceForge上にアカウントが必要） ====
共同開発を考えている方、つまり、編集後、SourceForge上にソースをアップ(push)する事を前提とする場合についてこちらでは説明します。

===== SourceForgeへの登録 =====
SourceForge上のUsernameとPassword及びpublic_keyをsourceforge上に登録する必要があります。

===== 環境変数の設定 =====
下記を実行する場合、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw Eos_env] をダウンロードしてください。
これは、下記のダウンロード作業を行った場合には、$EOS_HOME/env/Eos_envとして登録されているものと同じです。
次に、下記のコマンドを実行してください。インストール先は、$HOME/Eosがデフォールトで設定されています。環境変数：EOS_HOME0 を設定すれば、自分がインストールしたいディレクトリにインストールすることも可能です。

$ source Eos_env

これにより、各種の環境変数が設定されます。この作業無しで実行する場合には、環境変数がもつ、$EOS_HOMEの替わりにインストールしたいディレクトリを設定する必要があります。

ユーザー名とSourceForge上のUsernameが異なる場合には、環境ファイルもしくは、手動にて、EOS_GITUSERの設定をします。

export EOS_GITUSER=(SourceForge上のUsername)
or
export EOS_GITUSER=$USER

===== gitを用いたダウンロードの実行 =====

$EOS_HOMEが既に設定されている場合には次のようにcloneを作成する事が出来ます。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

インストールを指定したい場合、指定したいディレクトリを指定する必要があります。ここでは、$HOME/Eosの場合の例を示しています。

$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git $HOME/Eos
or
$ git clone --depth 1 https://scm.sourceforge.jp/gitroot/eos/base.git $HOME/Eos

その後、それぞれのホストに応じて必要なバイナリやライブラリをダウンロードします。

$ cd $EOS_HOME
$ make setting
$ cd $EOS_HOME/hostdepend
$ git clone --depth 1 ${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/hostdepend${EOS_HOSTDIR}.git ${EOS_HOSTDIR}

※ EOS_HOSTDIRは、バイナリの存在場所を変更するための環境変数です。Eos_envの中で、自動的に設定されます。

[[CUDA]]のインストールが必要な場合があります。[[EosOnCUDA]]を参考にして下さい。

==== Eosを使いたいだけの場合、もしくは、自分の所だけで開発を行いたい場合（SourceForge上にアカウントが必要ない） ====
編集しないか、もしくは、編集してもSourceForge上にソースをアップ(push)する事を前提としない場合には次のような作業を行うことになります。簡易インストーラが実行している内容がこれに対応します。

$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/base.git $EOS_HOME
or
$ git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/base.git $EOS_HOME

$EOS_HOMEが設定されていない場合には、直接、ディレクトリを指定して下さい。ただし、そのディレクトリを今後も利用する場合には、$EOS_HOMEとして設定する必要があります。

その後、それぞれのHOST毎に異なるバイナリを落としてきます。

$ source $EOS_HOME/env/Eos_env

を実行します。次に、

$ echo ${EOS_HOSTDIR}

が設定されていることを確認して、下記を実行します。SourceForge上にhostdepend${EOS_HOSTDIR}があることが前提です。それ以外のHOSTDIRが必要な方はご連絡ください。

$ cd $EOS_HOME/hostdepend; git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}
or
$ cd $EOS_HOME/hostdepend; git clone --depth 1 http://scm.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意１】sshやhttpsを使ってダウンロードする場合には、開発者として登録が必要です。ssh-keygenを使って作製したpublic_keyをsourceforge上に登録する必要があります。上述を参照してください。

【注意２】アカウントを設定せず、gitを使ってダウンロードした場合には、そのままでは、Eos上で新たに開発したものを登録(git-push)することができません。下記の注意３，４をご参照下さい。

【注意３】 開発者として、SourceForgeに登録した場合には、その後、git remoteコマンドを使って、originを変更してください。

cd $EOS_HOME
git remote -v
git remote rm origin
git remote add origin $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/base.git

cd $EOS_HOME/hostdepend/$EOS_HOSTDIR
git remote -v
git remote rm hostdepend$(EOS_HOSTDIR).git
git remote add hostdepend$(EOS_HOSTDIR).git $(EOS_GITUSER)@git.sourceforge.jp:/gitroot/eos/hostdepend$(EOS_HOSTDIR).git

【注意４】 --depth 1は、最新版のみを取得するためのオプションです。つけない場合は、すべての履歴をコピーすることになります。一方で、開発者として、git-pushを行う為には、全ての履歴をコピーしてくる必要があります。ディスクの空きを確認した後、--unshallowを使ってダウンロードしてください。うまくいかない場合には、gitのリポジトリが大きすぎて、キャッシュが作れないことが原因です。その場合には、順に--depthを深くしてください。例えば、次のようなコマンドが利用できます。

$ for i in `seq 1 100` ; do git clone --depth $i git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR} ; done
$ git clone --unshallow git://git.sourceforge.jp/gitroot/eos/hostdepend${EOS_HOSTDIR} .git ${EOS_HOSTDIR}

【注意５】使用するコマンドによっては他のライブラリをリビルドする必要があります。ダウンロード方法は[[#付加的なレポジトリを利用したい場合]]に記載しています。

==== 付加的なレポジトリを利用したい場合 ====
チュートリアルで利用するデータやMakefileが置かれています。
いずれも、$EOS_HOMEのディレクトリで実施して下さい。

$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/tutorial.git

テスト用のデータファイルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/data.git

Eosのマニュアルなどが置かれています。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/optional.git

Eosで利用される他の開発コードが置かれています。コマンドや環境によっては動作するのに必要な場合もあります。
$ cd $EOS_HOME
$ git clone --depth 1 git://git.sourceforge.jp/gitroot/eos/others.git
 

==== 全てのデータを一括でダウンロードしたい場合(makeコマンドを使用) ====
まず、[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/Makefile?export=raw 最新のMakefile]と[https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/Eos_env?export=raw 最新のEos_env]をダウンロードして、Eos_envのファイルを開き、EOS_HOMEにダウンロードディレクトリを設定します。（ディレクトリは空にして下さい。）さらに、EOS_GITUSERにsourceforgeのアカウントを設定します。お持ちでない場合は空にして下さい。（この場合はpushができませんので、ご注意ください。） 
 

設定後に下記のコマンドを実行します。 
<pre>
$ source Eos_env # Eos_envがあるディレクトリで実行
$ make git-clone-all # Makefileがあるディレクトリで実行
</pre>
 

ダウンロード完了後のMakefile、env/Eos_envは$EOS_HOME内のものを使用しますので、EOS_HOMEやEOS_GITUSERの内容を同じように変更します。 
 

=== 簡易版アップデート（簡単に最新版に更新したい方） ===

簡易アップデートのためのコマンドupdate-eos.shを利用してアップデートを行うことができます。
もちろん新しいディレクトリにインストールすることでも対応できます。

==== update-eos.sh のダウンロード====

Eos/env/のディレクトリの中に、update-eos.shのファイルが見当たらないバージョンをお持ちの方は、下記の方法で
ダウンロードしてください。

curl -L https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh
-
若しくは、

wget -q -O - https://sourceforge.jp/projects/eos/scm/git/base/blobs/master/env/update-eos.sh?export=raw > /tmp/update-eos.sh

として、アップデートコマンドをダウンロードします。

==== アップデートコマンドの実行 ====

DSDN上にアカウントを持っていない方は、

$ EOS_GITUSER0= source /tmp/update-eos.sh
or
$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh

によりアップデートコマンドが動作します。アカウントが存在する方は、下記のuserを自身のアカウントに置き換えていただき

$ EOS_GITUSER0=user source /tmp/update-eos.sh
もしくは、
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh
もしくは、
$ cd $EOS_HOME; EOG_GITUSER=user make git-fetch; EOG_GITUSER=user make git-merge

としてアップデートを行ってください。複数のDirectoryを利用している方はそのディレクトリを引数で設定すると容易にアップデート出来ます。

$ EOS_GITUSER0= source $EOS_HOME/env/update-eos.sh directory
or
$ EOS_GITUSER0=user source $EOS_HOME/env/update-eos.sh directory

=== 最新版に更新する場合(既に、ローカルにgitを用いてダウンロードしているものがある場合) ===
Eosの最新にアップデートすることができます。

==== makeを用いた更新 ====
$EOS_HOME/Makefileが最新のものになっていれば、上記のことを下記のMakefileにて実行できます。 
※ $EOS_HOMEは、例えば、$HOME/Eosディレクトリを指しています。 
　環境ファイルをそのまま使用する場合は、baseディレクトリを$HOMEに置き、Eosとリネームして下さい。

$ cd $EOS_HOME
$ make git-fetch
$ make git-merge

==== 最新版の取得 ====
$ git fetch ;# 変更があったファイルをダウンロード
or
$ git fetch ssh://${EOS_GITUSER}@git.sourceforge.jp:/gitroot/eos/base.git
or
$ git fetch git://git.sourceforge.jp/gitroot/eos/base.git

===== 最新版の取得（別法） =====
git pullは、fetch/merge等が自動的に実行されます。自分自身がソースコードを変更していない場合には一度に実施することができます。分かっている場合にのみ、使いましょう。疑問が少しでもある場合には、fetch/mergeを順に行うことをお薦めします。

$ git pull git://git.sourceforge.jp/gitroot/eos/base.git

==== 変更になっている部分の確認 ====
$ git log FETCH_HEAD ;# 変更になっている部分を表示

==== 変更を追加 ====
変更になっている部分を確認した後、自分自身が変更したものとマージしても問題がなければ、変更を追加します。自分自身も変更している場合には注意が必要です。

$ git merge FETCH_HEAD ;# 変更になっているものをマージする

=== Eosの機能追加、修正を登録する場合(make) ===

Eosそのものの機能(Eosが提供しているMakefile)を使ってインストールすることができます。この場合、基本的にmaster レポジトリに登録することになります。

$ cd $EOS_HOME ; # Eosのディレクトリに移動します。
$ make git-add ; # 変更や加えられたファイルをレポジトリに一時的に格納します
$ make git-commit ; # 変更点等のコメント毎、レポジトリに格納します

タグを変更したいとき 
※ 現在、ソースコードをアップロード毎にバージョン名によるタグで管理しています。[[Eosの開発]]のルールに従って、アップロード前にタグを付けるよう、ご協力をお願いします。

$ git tag
$ git tag newtag

アップロードします

$ make git-push ; # SourceForge上にアップします

=== Eosの機能追加、修正を登録する場合(git) ===

自分自身が機能追加、修正をかけ、登録する場合の例を下記に挙げておきます。
git add ; # 自分自身の複製で変更したものを加える
git commit ; # 変更したモノをgitに格納する
#
git push ; # git serverに格納
or
git push origin master
or
git push origin master

master以外のレポジトリを利用したい場合は、masterではなく、別のレポジトリを準備することになります。

※ gitコマンド使い方の詳細は、[[http://sourceforge.jp/magazine/09/03/16/0831212 sourceforge]]もしくは、gitの解説書をご覧下さい。

== 直接ダウンロードしたい方、開発環境は必要なく、実行だけを行いたい方 ==
下記のサイトから、バイナリtarballをダウンロードが可能です。

[[http://www.yasunaga-lab.bio.kyutech.ac.jp/ja/reserach/eos/eos-download-sites/ EosHomePage]]
or
[[http://sourceforge.jp/projects/eos/releases/ Sourceforge]]

上記にアップされていないバイナリ形式に興味がある方は安永(yasunaga@bio.kyutech.ac.jp)までご連絡下さい。

作成されたディレクトリの構成（[[Eosの構造]]）は別ページにて説明しています。

※　2013/02より、大幅にディレクトリの構成が変更になっています。ご注意下さい。目的は、ホスト依存のバイナリコードと非依存なソースコードを切り離すことが目的です。ヘテロな環境での実行を維持しながら、NFSなどでexportされた一つのディレクトリで実行するために変更しました。

== 動作環境 ==

　現在、手元に環境があり、動作することが確認出来ているのは、下記のものです。

LINUX 32bits/64bits
OS-X 32bits/64bits
Windows with Cygwin

== うまく動作しない場合 ==

=== コンパイルされていない場合 ===
Q1)　使いたいツールを実行しようとすると Not Installed: XXXXX-version YYYYYY　といわれる

A1)　設定された環境でコンパイル・リンクがなされていません。src/Tools以下のディレクトリにあるCLASS/YYYYYY　のディレクトリに移動し、make check; make depend; make install　とうってみましょう。

=== ライブラリがインストールされていない場合 ===
Q1 /....../Eos/bin/X86LINUX64/Display2: error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory と言われた場合

A1) libXssをインストールして下さい。
$ yum install */*libXss*

=== Xcodeのインストールが不十分な場合 ===

Q2 ) OS-Xでmakeを利用しようとすると下記のようなエラーコードがでる

sh: line 1: 8482 Trace/BPT trap: 5 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make 2> /dev/null
make: error: unable to find utility "make", not a developer tool or in PATH

A2)　いずれかのダイナミックライブラリがうまくインストールされていない場合にこのようなエラーが出ます。

直接、下記のコマンドを実行してみましょう。

/Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -sdk '' -find make

足りないライブラリに関してエラーを出力しています。多くの場合、ダイナミックライブラリのパスの設定の問題です。

sudo cp /System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Resources/libTIFF.dylib $EOS_HOME//util/X86MAC64/lib/

として、必要とされるライブラリを$EOS_HOME//util/X86MAC64/lib/コピーしてみて下さい。

=== gitのメモリが足りないとき ===
Q3) git cloneをかけようとすると、
remote: aborting due to possible repository corruption on the remote side.
fatal: early EOF
fatal: index-pack failed
として停止してしまう。

A3) これは、Eosのパッケージが大きすぎて、gitがindexを取得できないために生じます。

=== LD_LIBRARY_PATH に問題がある場合 ===
Q. El Captan (10.11)でcudaに関して、下記の様な dyldのエラーが生じる

$ mrcInfo -h
dyld: Library not loaded: @rpath/libcudart.6.5.dylib
Referenced from: /Users/tacyas/Eos/bin/X86MAC64/mrcInfo
Reason: image not found
/Users/tacyas/Eos/bin/mrcInfo: line 110: 424 Trace/BPT trap: 5 ${EOS_HOME}/bin/${OSTYPE}/${BASENAME} "$@"

A. csrutilコマンドを使う必要があります。

*リカバリーモードで立ち上げます。
*command + R を押しながら、電源をいれます。
*ユーティリティからターミナルを立ち上げます。
*下記のコマンドを実行します。

$ csrutil diable
$ reboot

これで利用できるはずです。今後問題を解決したいと思います。

mrcImageGLCM

2024-07-09T07:40:24Z

Tacyas: ページの作成:「'''mrcImageGLCM'''とは、画像のテクスチャ（2Ｄ／３Ｄ）の状態を数値化するEosのコマンドである。　　画像のテクスチャを...」

'''mrcImageGLCM'''とは、画像のテクスチャ（2Ｄ／３Ｄ）の状態を数値化する[[Eos]]の[[コマンド]]である。

　　画像のテクスチャを数値化するためのGLCM(Gray Level Co-occurrence Matrix)を用いて、2Ｄ及び3Ｄの画像のテクスチャ情報を取り出すプログラムとして、利用できます。

== オプション一覧 ==

Usage: mrcImageGLCM
Options:
[-i[nput] In (NULL ).as(inFile::mrcImage ) ] :Essential :Input
[-o[utput] Out (NULL ).as(outFile::mrcImage ) ] :Optional :Output:GLImage
[-O[utput] OutInfo (stdout ).as(outFile::ASCII ) ] :Optional :Output:Information
[-e[psilon] epsilon (2.2e-16 ).as(Real ) ] :Optional :SmallValueForLog
[-thres[hold]High thresHigh (1.0 ).as(Real ) ] :Optional :HighCut
[-thres[hold]Low thresLow (0.0 ).as(Real ) ] :Optional :LowCut
[-exceptValue exceptValue (0.0 ).as(Real ) ] :Optional :Except Value
[-range range (2.0 ).as(Real ) ] :Optional :mean+-range*sd (LowCut-HighCut)
[-nHist nHist (8 ).as(Integer ) ] :Optional :GrayLevel
[-offset offset (1 ).as(Integer ) ] :Optional :Distance
[-angle angleMode (15 ).as(Integer ) ] :Optional :Angle:1-0, 2-45, 4-90, 8-135 for 2D, 2^13-1=8191 for 3D
[-areaX minAreaX (0 ).as(Real )
maxAreaX (1.0 ).as(Real ) ] :Optional :
[-areaY minAreaY (0 ).as(Real )
maxAreaY (1.0 ).as(Real ) ] :Optional :
[-areaZ minAreaZ (0 ).as(Real )
maxAreaZ (1.0 ).as(Real ) ] :Optional :
[-c[onfig] configFile (NULL ).as(inFile ) ] :Optional :ConfigurationFile
[-m[ode] mode (0 ).as(Integer ) ] :Optional :Mode
----- Additional Usage -----
angleMode: 2^0-2^12, 2^13-1 for all
1: (1, 0, 0)
2: (1, 1, 0)
4: (0, 1, 0)
8: (-1,1, 0)
16: (1, 0, 1)
32: (1, 1, 1)
64: (0, 1, 1)
128: (-1,1, 1)
256: (1, 0,-1)
512: (1, 1,-1)
1024: (0, 1,-1)
2048: (-1,1,-1)
4096: ( 0, 0, 1)

===メインオプション===


<table border="1">
<div align="left">
<tr>
<th>オプション</th>
<th>必須項目/選択項目</th>
<th>説明</th>
<th>デフォルト</th>
</tr>
<tr>
<td>-i</td>
<td>必須</td>
<td>入力ファイル設定</td>
<td>NULL</td>
</tr>
<tr>
<td>-o</td>
<td>必須</td>
<td>出力ファイル設定</td>
<td>NULL</td>
</tr>
<tr>
<td>-m</td>
<td>選択</td>
<td>モードを設定</td>
<td>0</td>
</tr>
<tr>
<td>-h</td>
<td>選択</td>
<td>ヘルプを表示</td>
<td>　</td>
</tr>
</div>
</table>

===モードの詳細===


<table border="1">
<div align="left">
<tr>
<th>モード</th>
<th>説明</th>
</tr>
<tr>
<td>0</td>
<td>8ビット</td>
</tr>

</div>
</table>

== 実行例 ==

===オプション指定なし===
<div>[[画像:out.gif]]</div>

コピー用 
<pre>
'''xxxx'''とは、YYYYYを実施する[[Eos]]の[[コマンド]]である。



== オプション一覧 ==

===メインオプション===


<table border="1">
<div align="left">
<tr>
<th>オプション</th>
<th>必須項目/選択項目</th>
<th>説明</th>
<th>デフォルト</th>
</tr>
<tr>
<td>-i</td>
<td>必須</td>
<td>入力ファイル設定</td>
<td>NULL</td>
</tr>
<tr>
<td>-o</td>
<td>必須</td>
<td>出力ファイル設定</td>
<td>NULL</td>
</tr>
<tr>
<td>-m</td>
<td>選択</td>
<td>モードを設定</td>
<td>0</td>
</tr>
<tr>
<td>-h</td>
<td>選択</td>
<td>ヘルプを表示</td>
<td>　</td>
</tr>
</div>
</table>

===モードの詳細===


<table border="1">
<div align="left">
<tr>
<th>モード</th>
<th>説明</th>
</tr>
<tr>
<td>0</td>
<td>8ビット</td>
</tr>

</div>
</table>

== 実行例 ==

===オプション指定なし===
<div>[[画像:out.gif]]</div>

</pre>

eTomoチュートリアル

2023-02-12T07:08:27Z

Tacyas: /* 2つの軸を結合する */

''eTomoチュートリアル''

== 未加工のチルトシリーズの初期設定と表示 ==

　このチュートリアルでは、小さな2軸のサンプルデータセットと、Etomoへのステップバイステップガイドが含まれています。このチュートリアルは、トモグラフィガイドを置き換えるものではありません。各ステップの詳細については、より包括的なトモグラフィガイドを参照してください。サンプルデータセットは、プロセス全体を問題なく処理する必要があるため選択されました。トモグラフィガイドは、2軸断層撮影の計算に使用される多くのプログラムのトラブルシューティングと学習に関する参考資料です。

　このチュートリアルのこのバージョンでは、IMOD 4.9にいくつかの新機能が示されています。 IMOD 4.9がインストールされていない場合は、アップグレードするか、端末にimodhelpと入力し、インストールされているバージョンに含まれるEtomoチュートリアルを選択してください。

　まず、Webサイトからサンプルデータセットをダウンロードしてください。次のように入力してデータを解凍します。

imoduntar tutorialData.tar.gz

　これはチュートリアルを開始するのに必要な2つの未加工のスタックBBa.stとBBb.stをそれぞれ含むディレクトリtutorialDataを作成します。また、データセットの完成後に残っている小さな作業ファイルのすべてを含むサブディレクトリ、finalFiles、および最終的な再構成のコピーがあります。

　ファイル名には、独自のデータセットに従わなければならない規則が反映されています。生スタックには拡張子.stがあり、二重軸スタックには共通のルート名がa.stとb.stで終わります。この拡張子は、単に規約に過ぎず、画像ファイルの形式を示すものではありません。拡張子.mrcを持つことも可能です。Etomoはファイル名を拡張子.stに変更します。適切な形式でデータファイルを持っていて他の拡張子を持っている場合は、ファイル名の拡張子を.stに変更する必要があります。

== Etomoのセットアップ ==

Etomoを起動するには、次のように入力します。

etomo

　

　Etomoを最初に起動すると、Front Pageパネルが表示され（上の図を参照）、Etomoで実行する操作を選択できます。この時点で、Build Tomogramボタンを押すか、FileとRecent Projectsメニューの既存のデータセットを開くことで、新しいデータセットの作業を開始できます。

　Build Tomogramを押して、Setup Tomogramパネルを表示します（上の図を参照）。 Project Logウィンドウも開き、アクションの履歴が含まれ、特定の手順に固有の有用なログファイルソリューションがレポートされます。

　新しいデータセットの作業を開始するには、以下のフィールドを入力する必要があります。 Dataset nameは、未加工のチルトシリーズ（または二軸データセットが収集された場合はroot_namea.st）を含むファイルの名前です。Dataset nameフィールドに関連付けられている黄色いファイル選択ボタンをクリックするか、ディレクトリパスとファイル名をフィールドに直接入力して、Detaset nameを入力できます。 Backup directoryは、手順を実行するたびに小さい作業ファイルを保存するオプションのフィールドです。バックアップディレクトリを使用しない場合は、このフィールドを空白のままにできます。

　Templatesボックスで、plasticSection.adocSystem templateを選択します。このテンプレートはIMODインストールの一部であり、この種の再構成に適したいくつかのパラメータを設定するために使用できます。

　データセットがSingle axis（単軸）かDual axis（二軸）かを選択します。 Montageオプションは、モンタージュチルトシリーズの処理に使用できます。

　次のフィールドは、ピクセルサイズ（nm）、金基準直径（nm）のサイズ、イメージ回転（度）を指定します。ピクセルサイズ（nm単位）は、顕微鏡、カメラ、および倍率によって異なります。画像回転（垂直からの傾斜軸角度、度）も顕微鏡と倍率によって異なります。 Scan Headerボタンを押すと、MRCファイルヘッダーで指定されている場合はピクセルサイズと画像回転値が取得されます。このチュートリアルの例では、このデータセット（2.02）と画像回転（-12.5）のピクセルサイズを定義するには、Scan Headerを押します。金の基準直径（10 nm）のサイズを指定する必要があります。

　Parallel Processingチェックボックスが有効になっている場合は、チェックを外して画面がここに示されているように見えるようにします。このチュートリアルでは扱いませんが、パラレル処理では、複数のコンピュータまたは1台のコンピュータ上の複数のプロセッサにプロセスを分散させることができます（有効化の方法については、Etomoの使用を参照してください）。Image distortionフィールドのファイルエントリを空白のままにします。この機能を使用して、非線形の画像歪みが測定され、特性化されていれば補正することができます。これはエネルギーフィルタのデータで特に有効です。Mag勾配補正項目を空白のままにします。この機能には、各画像に適用される倍率勾配を持つファイルが含まれています。これは、モンタージュデータでの使用に便利です。

　Axis Aおよび必要に応じてAxis Bボックスのいずれか一方または両方の軸の傾き角度のソースを指定します。この例では、傾斜角が拡張ヘッダに格納されるため、データからのデフォルトの抽出傾斜角を使用する必要があります。ゼロ度から2方向に撮影したチルトシリーズを再構成する場合は、Series was bidirectional fromをオンにすることができます。これにより、適切なアライメントパラメータの設定が行われます。必要に応じて、個々の投影を指定して、処理ステップから除外することもできます。この除外リストの構文は、コンマで区切られた範囲のリストです（1,4-5,60-70など）。このセクションには、3dmodで表示するための生データファイルを開くためのボタンもあります。

　前処理ステップの決定や、画質の悪い特定のビューがあるかどうかを確認したり、アライメントと再構成から除外したりする場合は、未加工のチルトシリーズファイルを見ると便利です。

　ビューの画質が悪い（フォーカスがないなど）かどうかを判断するには、Raw Image Stackボタンを押してRawスタックを開きます。動画を通してマウスの中ボタンをクリックすることで未加工のチルトシリーズの画像を表示します。どのように画像が少し跳ね上がるかに注目してください。アライメントと再構成から除外する特定のビューを書き留めます。このサンプルデータセットでは、除外する必要がある画像はありません。

　チュートリアルのサンプルデータセットに固有の詳細は上に示されています。このサンプルデータセットの場合、Dataset nameはBBa.stです。それは二重軸セットです。画素サイズは2.02nmであり、基準直径は10nmであり、画像回転は-12.5度である。このデータセットの傾斜角度は、データファイルから保存され、抽出されます。

　Create Com Scriptsボタンを押して断層像の生成に進みます。

== Etomoメインウィンドウ ==

　このチュートリアルを終了する前にEtomoを終了する必要がある場合は、中止したところからデータセットが含まれているチュートリアルデータディレクトリに移動し、次のように入力して続行できます。

$ etomo BB.edf

　メインウィンドウはいくつかの領域で構成されています。左側には、操作する断層像計算の特定のステージを選択できるボタン（プロセス制御ボタン）の列があります。一番上には、現在のプロセスまたは完了した最後のプロセスのステータスを通知するプロセスモニタがあります。プロセスモニタの左側には、Axis AとAxis Bの間を移動するためのAxisボタンがあります。メインウィンドウは現在、Axis Aに対して開いています。

　プロセス制御ボタンは、上から下に向かって処理の順番に並べられています。ボタンはプロセスの段階を示すために色分けされています。赤はプロセスが開始されていないことを示し、マゼンタはプロセスが現在進行中であることを示し、緑はプロセスが完了したことを示します。いずれかのボタンが選択されると、ウィンドウの右側に特定のプロセスに関連する情報とフィールドが表示されます。これらのフォームはプロセスパネルと呼ばれます。それらを使用すると、必要なパラメータを変更し、その処理ステップで必要な特定のプログラムを実行することができます。各プロセスパネルのパラメータとボタンは通常、フローチャートのように実行する順序で上から下に配置されます。プロセスを実行すると（プロセスパネルのいずれかのボタンを押すと）、プロセスモニターはプロセスの処理が完了したこととその時間を表示します。

== 前処理 ==

　画像がCCDカメラを使用して顕微鏡上で収集された場合、最初の暗い電子または個々の画像の収集中にCCDカメラに当たるランダムなX線が、データファイルのピクセル値の極端な高低差を引き起こす可能性があります。その結果、これらの極端な値はコントラストを破壊し、再構成に人工的な効果を引き起こす可能性があります。このチュートリアルの例では、このような問題を引き起こす極端なピクセル値はありません。ただし、これらのピクセル値を削除する手順については、ここで概要を説明する。最初に、ファイルに極端なピクセル値があるかどうかを判断する簡単な方法は、未処理のスタックのイメージヘッダーの最小値と最大値を調べることです。これを行うには、コマンドラインターミナルで次のように入力する。

$ header BBa.st

　最小値、最大値、および平均濃度の値に注目します。最小濃度値が負の数または0である場合、暗い電子の収集中にX線イベントが原因で、データセットに極端な黒いピクセルがある可能性があります。最大濃度が高い場合は、データセットに極端な白いピクセルがあります。極端な値がデータセットのどこかに潜んでいて、それらを削除するための前処理が必要な場合は、前処理ボタンを押してこのパネルを開きます。

　前処理に関連する基本的な手順（チュートリアルのデータセットでは不要）を以下に示します。

・Show Min / Max for Raw Stack ボタンを押すと、各セクションの最小密度と最大密度をRawスタックに表示するプログラムであるクリップ統計が実行されます。テキスト出力とこれらの密度のグラフが表示された状態でウィンドウが開きます。

・Create Fixed Stack ボタンを押して、X線を除去した第2のスタックを作成します。

・View Fixed Stack ボタンを押してそのスタックを表示し、Show Min / Max for Raw Stackボタンを押して固定スタックのクリップ統計を実行します。極端なピクセル値が修正されているかどうかを確認します。

・3dmodの黒と白のスライダが非常に接近していない状態でコントラストが良好に表示され、未処理のスタッククリップの統計出力からの異常な値が固定スタック出力からなくなった場合は、Use Fixed Stackボタンを押します。

この操作の詳細については、トモグラフィガイドの PRE-PROCESSING: REMOVING X-RAYSセクションを参照して下さい。

== 粗調整 ==
“Coarse Alignment”プロセス制御ボタンを押して、粗く整列したスタックを作成します。

“Calculate Cross-Correlation”ボタンを押すと、隣り合う傾斜画像毎の相互相関プログラムが実行されます。
* このプログラムは、相互相関を用いて、傾き系列の連続する画像間の最初の並進アライメントを見つけまう（すなわち、xとyだけシフトする）。
* 出力ファイル“BBa.prexf”には、次のステップで画像データに適用される変換（または推奨シフト）のリストが含まれています。

“Generate Coarse Aligned Stack”ボタンを押すと、2つのプログラムが実行されます。
Xftoxgは、傾き相互相関によって作成された変換を使用して、一貫した「グローバル」アライメントセットを取得します。
これらの新しい変換は、Newstackプログラムを使用して画像データに適用されます。
出力ファイル“BBa.preali”が作成されます。
“View Aligned Stack in 3dmod”ボタンを押すと、プリアライメント（一定方向に整列）されたスタックを見ることができます。
相互に作用するMidasプログラムを使用して、大きな画像シフトを手動で編集することができます。これらは、このデータセットの問題ではありません。詳細については、「トモグラフィガイド」の「粗調製」を参照してください。

Midasが実行されている場合には、傾斜軸が垂直になるようにMidasが画像を回転させるため、傾き軸回転登録が使用されます。
“Fiduclalless alignment”チェックボックスは、基準点アライメントなしでトモグラフィを作成するために選択できます。詳細については、「トモグラフィガイド」の「相関アライメントを使用したクイックトモグラムの作成」を参照してください。
事前にスタックされたスタックに問題がなければ、完了ボタンを押して杉のステップに進みます。

== 金粒子の位置に基づいた基準モデルの作成 ==

基準モデルを生成するに利用できる3つのオプションがある。最も一般的なのは、Make seed and trackオプションでいくつかの金粒子基準マーカーを追跡することだ。この開始点は手動または自動で選択できる。これらの開始点はある一部分のみから選ばれ、基準点がそこから追跡されるため、粒子モデルと呼ばれる。データセットに金粒子基準マーカーがないか、少なすぎる場合は、Use patch tracking to make fiducial modelオプションを使用できる。Run RAPTOR and fixオプションは、スタンフォードで開発されたプログラムを使用し、傾斜系列（像の一軸トモグラフィー）を通じて金基準マーカーを自動的に探して追跡する。詳細については、トモグラフィーガイドのFIDUCIAL MODEL GENERATION（基準モデル作成）の項目を参照。まず初めに新しい機能を使用して、金粒子の位置を自動的に選択する。その後バックアップして古典的な方法へ進むが、これはより不明瞭なデータセットを解析する場合の手順を示すことに適している。

Total number（追跡する粒子の総数）に25を入力し、Select beads on two surfacesにチェックを入れる。

Generate Seed Modelボタンを押す。

操作が完了すると、各平面で選択された粒子の数がProject Logウィンドウに表示される。Open Seed Modelボタンを押すと、選択した粒子の基準点が表示される。粒子の基準点を見るには、1度の部分までスクロールしなければならない。緑色の点は底面の粒子を、マゼンタの点は上面の粒子を色づけている。次のステップでは、このモデルを粒子として使用して完全な基準モデルを作成する。

Track Beadsタブを選択する。

Track Seed Modelボタンを押す。

これにより、粒子追跡プログラムが実行され、他のすべての部分で金粒子が見つかる。tracka.comで作成された出力ファイルは、完成した基準モデルのBBa.fidである。このコンピュータ生成モデルは完全ではなく、基準モデル中にずれが生じる可能性がある。欠落した粒子の基準点の合計数がProject logウィンドウに表示される。多数の基準点が欠落している場合は、Track with Fiducial Model as Seedボタンを押す。これにより、金粒子のような基準モデルを追跡するプログラムが再実行される。この場合、基準点は記入されない。

粒子の基準点がまだ欠落している場合、次の手順ではこの基準モデルを編集する反復プロセスが必要となる。特に、ここにあるように基準点の超過がある場合は、すべてのずれを直す必要はないことに注意。しかし、大部分の粒子の基準点が傾斜系列（像の一軸トモグラフィー）の両端まで追跡されていることを確認することが重要である。

Fix Fiducial Modelボタンを押す。

この手順では、3dmod中に内蔵されたスタック（BBa.preali）と基準モデルファイル（BBa.fid）が開く。

粒子修正のダイアログボックスがFill gapsモードで表示される。粒子修正は、基準モデルの編集を容易にする。

Go to Next Gapボタンをクリックする（または、スペースキーをホットキーとして使用する）。これによって、隣接する区画上に基準点がない点（黄色の円で強調表示されている点）を表示させる。Page Upキー（ポイントの上に上矢印が表示されている場合）またはPage Downキー（ポイントの上に下矢印が表示されている場合）を使用して欠落している粒子のある区画を探し、マウスの中ボタンを使用して金粒子の中心を基準点に加える。「＋」キーで画像の倍率を上げて、区画のコントラストを調整することは、特にトモグラフィーの傾斜が高いときに便利である。

メイン3dmodウィンドウ上に「No Gaps Not Found」というメッセージが表示されるまで、Go to Next Gapを繰り返す。File -> Save model、またはホットキー「s」を押してモデルファイルを保存し、完了ボタンを押して粒子位置の精細な調整へ進む。

== 連続的な傾斜の整列 ==
Fine Aligment パネルは、さまざまなアライメントパラメータを解決するための3つのタブのセットで構成されています。一般的な位置合わせは、最初にFine Alignment boxの下部にあるCompute alignmentボタンを押して行います。

このコマンドファイルでは、プログラムTiltalignを実行して、傾斜したビューの変位、回転、傾きおよび倍率の差異を見出します。このプログラムはfiducial modelでの金粒子の位置と最適なフィットを見つけるためのmetric minimization（メートル最小法）が使われています。これは行われたことの概要を示すログファイルを作成します。すべての未知数に対する合計値と残差誤差平均とsdの比率のレポートがプロジェクトログウィンドウに表示されます。ログファイル全体にアクセスするには、プロセスに関連付けられたウィンドウ領域上でマウスカーソルを右クリックします。これにより、3つまたは4つのセクションに分割されたメニューが開きます。最初のセクションでは、現在のプロセスに関連するログファイルを開くことができます。 2番目のセクションでは、アライメントパラメータのグラフを見ることができますが、他のほとんどのパネルには存在しません。次のセクションでは現在のプロセスに関連するマニュアルページを開き、最後のメニューセクションでは一般的なヘルプガイドを開きます。ログファイルを開くには、[Align axis: a log file（軸を合わせる：ログファイル）]を選択します。これにより、このログファイルの完全なログと短いセクションが含まれるタブ付きのファイルが開きます。私の例では、最初のCompute Alignment runは0.236の残差平均を与えました。

この結果は次のステップを説明するのにとても良いので、ここでバックアップを取っていきます。最初に3dmodを終了し、ターミナルウィンドウに移動してシードモードを削除するか、名前を変更します。
例：　mv BBa.seed BBa_auto.seed

次に、Etomoで、左側のSeed ModelタブのFiducial Model Gen.を押し、画面がこのようになるようにMake seed model manualyを作成します。

View Seed Modelボタンを押す。
（このボタンは別のモデルが作られる前にSeed Fiducial Modelと名付けられていました）。これにより、3dmodでBBa.prealiが開き、BBa.seedと名付けられた空のモデルファイルが作成されます。また、Make SeedとAutocenterにチェックの入った Bead Fixerダイアログボックスが表示されます。オフの場合は、Automatic new contourをチェックします。 3dmodではセッションごとにこの設定が記憶されます

3dmodはファイルを中間セクションに開きます（このチュートリアルスタックのセクション31）。キーボードのInsertキーを押すことで中央のセクションに戻ることができます。

Zap（画像）ウィンドウで、金粒子の中央にカーソルを合わせ、マウスの中央ボタンを押して、モデルポイントを20-30の金粒子の中央に配置します。自動で新しい輪郭がチェックされるので、新しい金粒子ごとに新しい輪郭が作成されます。Autocenterがチェックされているので、3dmodはモデルポイントが金粒子の中央に配置されていることを確認する必要があります。したがって、ギャップを埋めるときほど注意を払う必要はありません。例（BBa.seed）では25個の金粒子を選択しました。モデルには1つのオブジェクト、25の輪郭が含まれ、各輪郭には1つの点があります。このシードモデルを保存します。

次に、Track Beadsタブをもう一度選択します。今回は結果が非常に良い状態に保たれるように、Sobel filterのRefine centerをオフにします。

Track Seed Modelを押してシードモードを追跡します。これまでのように、Fix Fiducial Modelを押して、ギャップを記入してください。もう一度ファインアライメントステップに
進みます。

Compute Alignmentを押します。今回は残差がすこし大きくなっています。

より良いアライメントステップの目標は、このチュートリアルデータセットのピクセルサイズを残差誤差平均0.2〜0.5に減らすことです。より小さなピクセルサイズのデータセットは、より大きな残留誤差を持つことを意味する。
Tiltalignプログラムは、基準モデルに関する有益な情報を提供する2つのモデルファイルも作成します。最初の（BBa.3dmod）は、解決された位置に基づいて基準点の3次元モデルを表示します。2つのサーフェス上に存在する基準点には2つの異なる色が割り当てられます。一方はピンクの球、もう一方はグリーンの球です。 Fine Alignmentボックスの下部にある3Dモデルの表示ボタンをクリックして、このモデルを調べます。

見える範囲にピンクとグリーンの球がいい具合に分布しているのが見られます。キーパッドの数字の8を押して回転させ、エッジを表示します。このビューでは2つの表面の分かれ目が見られます。アラインメントが歪曲するのでいずれかの特定の領域に基準点群をもつモデルを使用しないでください。3dmodvウィンドウを閉じます。

Tiltalignが生成する第2のモデルは、残差ベクトルモデルです。 Fine Alignmentボックスの下部にあるView Residual Vectorsボタンを押します。これは、事前に整列されたスタックを3dmodで開き、各セクションに残差ベクトルモデルを表示します。

このモデルは、現在のモデル点を緑色の矢印の原点として、残りの位置を矢印の終点として表示します。この変位は非常に小さい（<2ピクセル）ため、この残留変位は実際のモデル点と区別するために10倍に拡大されています。大きな（> 2k×2k）画像では、残差モデルはしばしば1つの領域に大きな変位を示しますが、他の領域には存在しません。これらの場合、残差モデルは局所的なアラインメントが必要な時に決めるのに役立ちます。この例では、局所的なアラインメントは必要ありません。一般的に、より極端な傾きにおいてより大きな残差を持ちます。次のいくつかのステップで3dmodを開いたままにして、View / Edit Fiducial Modelボタンを押して基準モデルを編集用にリロードします。これにより、大きな残差モデルを修正モードでBead Fixerダイアログボックスが表示され、aligna.logファイルがロードされます。

以下の反復ステップは、大きな残差を有する基準点を固定することを含む。

Bead FixerダイアログボックスのGo to Next Residualをクリックします。

大きい残差を持つモデルポイントには、推奨移動の方向を指す赤い矢印が表示されます。モデルポイントが金に適切に集中していないことが観察できると思われます。Bead FixerダイアログボックスでMove Point by Residualをクリックすると、モデルポイントが推奨量だけ移動します。これはほとんどの場合良い働きをするのですが、この推奨が間違っていると思われる場合は、カーソルを金粒子の中央に合わせてマウスの右ボタンをクリックすることで手動で移動できます。この推奨は、すべての基準点にフィットする数学的アライメントモデルによって予測された位置であり、粒子が実際に画像内に位置する場所の分析に基づいている訳ではありません。アライメントモデルにうまく収まらないほど歪んだ標本である場合、矢印は実際の金の位置から離れていることがよくあります。

残差が見つからなくなるまでGo to Next 1big 1residualおよびMove Point by Residualを繰り返します。ホットキー（残差によってポイントを移動する）は次の残差に移動します。目標は、それが関連する基準点の上に各点を集中させることです。残りの矢印は必ずしも正しいとは限りません。ポイントはマウスの右ボタンでクリックして移動することもできます。時には、他の表面からの基準点は、現在の基準点の範囲を観察するのを困難にします。ページアップボタンとページダウンボタンを使用して基準点を区別します（ただし、Go to Next Big Residualで選択したセクションに常に戻ります）。Undo Moveボタンを押すと、残差による移動を元に戻すことができます。

修正する残差がなくなると、モデルファイルを保存してファイルを開いたままにします。
aligna.logファイルにアクセスし、Surface Anglesタブに移動します。

下部のTotal tilt angle changeに気を付けてください（この例ではこの値は-0.40でした）。この値をTotal tilt angle offsetの下のFine Alignment Volume Position Parameters boxに入力します。Compute Alignmentボタンをもう一度押します。アラインメントは訂正が組み込まれた状態で計算され、3dmodは結果のログファイルを再度読み込みます。メインの3dmodウィンドウの下部にあるテキストボックスを参照してください。

大きな残差のあるモデル点を修正するには、もう一度進んでください。モデルを保存します。
データセットの両面に金の分布が良好であれば、歪みを解くことができます。Fine AlignmentボックスのGlobal Variablesタブを押します。

パネルの下部にあるDistortion Solution Type領域でFull solutionオプションを選択します。これにより、X軸方向の伸びと歪みの2種類のねじれが解決されます。既定のグループサイズを維持し、Compute Alignmentボタンを押して配列を実行します。Compute Alignmentが実行されると、3dmodはログファイルを再読み込みします。
3dmodのウィンドウに戻り、歪みを解決した後にTiltalignが示してきた新しい残差の修正を繰り返してください。次に、Bead FixerウィンドウのSave＆Run Tiltalignボタンを押してモデルを保存し、位置合わせを計算します。Etomoのパラメータを変更していない限り、このボタンを使用することによりEtomoに戻る必要がなくなります。3dmodでアライメントとチェックのモデルポイントを数回実行した後、最終平均残差は0.2〜0.4になるはずです。この例では、最後の残留誤差平均は0.326でした。

== ３つの小さな再構成を作成するためにデータセットをサンプリングする ==

次のステップンも目標は、できるだけ平坦で最小のボリュームに収まるように再構成をシフトして回転させることです。
これは、断層画像の３つの領域、すなわち、傾斜画像の上部、中央および下部付近から計算された3つの領域をサンプリングすることによって行われる。
（これらのサンプルが適切でない場合は、断層撮影された断層像全体を使ってこれを行うことができます；詳細については、断層撮影ガイドのトモグラム全体の位置づけを参照してください。）
調整可能な２つの回転があります：傾斜軸周りの回転、（断層像の長さ全体にわたって同じ高さZで断面が出るように、X軸周りの回転を含む）X-Z平面で見たときの断面レベルを作るための回転。
IMOD4.9の新機能により、セクションの上面と下面が自動的に検出され、図面を保存して面を定義することができます。
この軸を手動で操作します。2番目の軸に自動位置決め機能を使用します。
これはビニングされたデータセットなので、“Positioning tomogram thickness”を200に減らします。
これにより、元のセクションよりもはるかに厚い再構成が作成されます。
“Create Sample Tomograms”を押します。

このコマンドファイルは、まずイメージスタックの上、中央、下から60ピクセルのスライバ（鋭角や微細な形状のこと）を抽出して整列させます。
次に、これらのサンプルを使用して、整列したスタックの上、中央、下から20個の薄切りの再構成を作成します。
これらの出力ファイルの名前はtopa.rec、mida.rec、bota.recです。“Create Boundary Models”を押します。
このステップでは、各再構成の上面と下面を定義するモデルを作成します。
“Create Boundary Models”を押すと、3次元MODは3つの再構成を一度に読み込み、topa.recが最初に表示され、エッジが表示されます。
3次元MODは、tomopitcha.modという名前の空のモデルからも開始されます。

Zapウィンドウの上部バーには、‘４D’の機能と、前後矢印があります。
前方矢印をクリックすると、それぞれmida.recとbota.recの再構成が繰り返されます。
topa.recから開始する。コントラストスライダを使用してコントラストを調整します。
ボリュームの中央のマテリアルが不鮮明な外観になっていることに注意してください。
これは、生物学的材料を用いた再構築の一部である。
マウスの中央のボタンを使用して、生物材料を含む領域を定義する上面の左側に１つのモデル点を配置し、上面の右側に第2のモデル点を配置します。
線が2つの点を接続します。
セクションの底面を、それぞれ左右２つの点でモデル化します。
Zapウィンドウの上部にある‘4th D’の右にある矢印ボタンを押すことによって、mid.recとbot.recファイルに切り替えます。
他の２つの再構成の上面と底面のモデリングを繰り返します。
最終的なモデルは1つのオブジェクトと６つの輪郭を持ち、各輪郭は２つのモデル点を持つ必要があります。このモデルファイルを保存します。
一般に、最終断層像の厚さは、描く線の間の実際の距離よりも約10-20ピクセルほど厚いことが有効です。
これを達成するために、追加されたボーダーの厚さで入力を調整することができます。
デフォルト値の5は断層像を10ピクセル厚くします。それを10ピクセルに変更して20ピクセル厚にします。
“Compute Z Shift and Pitch Angles”を押します。
これらのモデル輪郭に基づいて、トモピッチは再構成を可能な限りフラットにし、可能な限り最小の容積に収めるためのパラメータを決定する。
これらのオフセットは、既存の角度オフセット、ZシフトおよびX軸傾斜値に自動的に追加されます。
最終断層像の厚さは、トモピッチログからEtomoによって入力されます。

== フルサイズのスライス像を作成する最後の実行 ==

Create Final Alignmentボタンを押します。最終的な配置変換が作成されたら、完了ボタンを押して次のステップに進みます。

最終整列スタックの作成

Create Aligned Stackを押します。
このコマンドは、最終整列されたスタックのフルサイズの画像に整列変換を適用します。出力ファイルの名前はBBa.aliです。

完全に整列されたスタックは、View Full Aligned Stackを押すことで表示できますが、これは必須ではありません。 CTF補正、基準点の消去、および整列されたスタックのフィルタリングのためのオプションの手順がありますが、ここでも必要ありません。 Done（完了ボタン）を押して次のステップに進みます。

傾斜パラメータセクションの初期設定のフィルタリングパラメータは、多くの場合に適用できますが、変更することもできます。または、整列されたスタックをフィルタリングして再構成時のノイズを減らすことができます（詳細については、トモグラフィガイドのTOMOGRAM GENERATIONセクションを参照してください）。

トモグラムの生成

Generate Tomogramを押します。

断層像が計算されると、View Tomogram in 3dmodを押すことで断層像を調べることができます。スペースを節約するために、この時点で中間イメージスタックを削除すること（Delete Intermediate Image Stacks）もできます。

マウスの中ボタンを押して、スライス撮影の上面から底面まで一連の断層撮影写真をステップスルーすることによって、再構成を経て映像を再生します。

== .第2の軸（軸B）上 ==

軸Bを表示するには、Etomoウィンドウの上部にあるAxis Bボタンを押します。これにより、軸Bの傾斜シリーズを整列させ、スライス像を計算するための操作を実行するために使用できるもう1組のプロセスボタンが表示されます。混乱を避けるために、軸Aは青い背景を持ち、軸Bは緑色の背景になっています。

Etomoのメインウィンドウの右側には、軸Bの傾斜シリーズを整列させ、断層像を計算するための操作を実行するためのプロセスボタンがあります。このサンプルのデータセットでは、前処理ステップは必要ありません。軸Aで説明したように、Coarse Alignmentの過程に進みます。

粗く整列されたスタックが生成されたら、Doneを押して次のステップに進みます。
両方の傾斜軸を組み合わせるには、追跡しているビーズの少なくともいくつか（8-10）が2つのセットで同じでなければなりません。これを達成するには、基準点の移動プログラムを使用します。

A軸からの基準点の移動

Transfer Fiducials From Other Axisボタンを押すと、最初の軸からの基準モデルに基づいて2番目の軸の粒子基準モデルを作成する基準点の移動プログラム（Transferfid）が実行されます。プログラムは、最もよく対応する2つのセット中の画像のペアを検索し、最初のセットの基準点を転送して、2番目のセットの粒子基準モデルを作成します。最後に、プログラムは第1軸と第2軸の間で対応している基準点をリストし、これをProject logウィンドウに表示します。

いくつかの基準点が転送できなかった場合でも心配しないでください。この例では、19個の基準点が対応しています。

これは少し低く、2つの軸が非常によく一致しないために起こっています。手動でポイントを追加することもできますが、自動的にポイントを追加すると便利です。Add points to seed model automatically（シードモデルに自動的にポイントを追加）を選択すると、自動粒子パネルが開きます。

Add beads to existing model（既存のモデルにビーズを追加する）が選択されており、2つの断層上の総数（Total number）と選択ビーズの設定も、もう一方の軸から転送されていることに注意してください。

Add Points to Seed Modelを押して、BBb.seedというTransferfidによって生成された粒子基準モデルにさらに多くの基準点を追加します。Track Beads タブを選択し、軸BウィンドウのTrack Seed Model （基準モデル）の追跡に進みます。

これは自動的に軸Bセットの基準点を追跡します。 BBb.fidファイルでの基準点の欠落を修正するには、A軸について上で説明したように、Fix Fiducial Model を押して基準点の修正を行います。修正されたら、Doneを押して細かい整列とトモグラムの計算過程に進みます。

軸 Aセットについて上記で説明したことに従って、同じ手順を進めます。

簡単に：
Fine Alignmentボックス中Global variable のCompute Alignmentボタンを押します。

この時点で、大きな差をがある基準点を編集し、モデルを保存し、アライメントを計算することによって、 Aセットのように反復アラインメントを開始します。アラインメントが完了したら、Doneを押して、スライス像の生成ステップに進みます。

トモグラフィーの自動位置決め

自動位置決めを使用するには、Find boundary model automatically（境界モデルを自動的に検索）にチェックを入れ、Positioning tomogram thicknessを再度200に設定します。

Create Samples & Boundary Model（サンプルと境界モデルの作成）とView Boundary Model（境界モデルの表示）ボタンが再ラベルされていることに注目してください。自動断層撮影の位置決めは、標本または断層像全体のいずれかで行うことができます。そして、断層像全体は標準試料位置に十分な材料がない場合に、より精度が上がります。ここではサンプルを使用しますが、断層像全体から境界モデルを調べるには多少異なる方法が必要です（詳細については、断層撮影ガイド全体の自動位置決めに関するセクションを参照してください）。

Create Samples＆Boundary Modelを押します。終了したら、View Boundary Modelを押して、描いた輪郭を調べます。

上記のA軸について概説した「最終整列スタック」の手順に進みます。

上記のA軸について概説したように、「断層像生成」ステップを続行します。

== 2つの軸を結合する ==

Axis Aボタンを押してA Axisに戻ります。
2つの断層像を結合するには、断層像の組み合わせプロセスボタンを押します。

断層撮影組み合わせパネル
断層像コンビネーションパネル：3つのタブ　セットアップ(Setup)、初期マッチ(Initial Match)、最終マッチ(Final Match)。

セットアップ情報は、特定のデータセットについて与えられるウィンドウがあります。
最初のセクションでは、Tomogram Matching Relationshipについて説明します。

B断層像をAに一致させることが最も一般的です。
Solvematch Parametersボックスに基準マーカの分布に関する情報が表示されます。この例では、基準点は両側にあります。このデータセットの場合、プログラムは一度にすべてのポイントに適合する問題がないため、Aから使用する開始ポイントを記入する必要はありません。

次のセクションでは、ローカル3D相互相関を使用して配置を精緻化するためのパッチパラメータの情報を示します。小さなパッチを選択します。どちらの中のパッチや大型パッチはほとんどのデータ・セットのために必要とされるが、このデータセットは、そのサイズを小さくするためにビニングされていますので、小さなパッチは、それらの情報をたくさん持っています。

自動パッチフィッティングを使用するチェックボックスがオンになっていることに注意してください。十分な情報が見つからない場合、IMOD 4.9のこの新しい機能は自動的にパッチのサイズを増やします。パッチサイズは不必要に増加しません。
自動パッチフィッティングが選択されている場合、プログラムはボリュームに存在する情報の量も分析し、十分な情報がないパッチを除外しようとします。
この手順で十分に機能しない場合は、パッチを抽出する領域を示す古い方法に戻ってください。これらの方法でいくつかの経験をするために、ボリュームの座標制限を設定する手順を説明します。

パッチが抽出されるボリュームの限界を指定する必要がある場合、一致する断層像を見ることが重要です。Z軸の範囲全体を使用することはほとんどできません。また、X軸とY軸の場合でも、デフォルトを使うのは良いことではありません。

制限を見つけるには、パネルの下部にある3dmod Volume Aボタンを押します。
これは3dmodでBBa.recを開きます。画像を一歩一歩見て、X軸、Y軸、Z軸のどの範囲にボリュームのマッチングに役立つ情報が含まれているかを決定します。
この例では、X軸とY軸のデフォルトが維持されています。
この例ではZ軸分とZ軸の最大スライス内の約半分の材料（23および74）ぼやけない最初と最後のスライスに設定しました。

場合によっては、座標の制限値を設定しても、2つの軸が結合できるように十分に空の領域が削除されるわけではありません。

その場合は、パッチ領域モデルを作成する必要があります。パッチ領域モデルを作成するには、パッチ領域モデルを使用するチェックボックスをオンにし、[パッチ領域モデルの作成/編集 ]ボタンを押して、一致する軸を開きます。
モデルモードでは、生物学的材料を含む領域の周りを閉じた輪郭をトレースします。断層像で10スライスごとにこれを行います。モデルを保存します。名前はpatch_region.modです。
パッチ領域モデルを作成することは、画像内に多量の樹脂または空き領域を有するデータセットを再構築する場合に特に有用である。
このサンプルデータセットは、パッチ領域モデルを必要としません。

セットアップパネルのパラメータを入力したら、Create Combine Scriptsを押して、結合手順でさまざまなプログラムを実行する一連のコマンドファイルを作成します。
ポップアップする警告メッセージは無視してください。
Start Combineを押すと、2軸断層像の組み合わせが開始されます。Etomoは、様々なプログラムが実行されている間、自動的にInitial Matchに進み、最後にFinal Matchタブに進みます。
断層像の合成が完了したら、Open Combined Volumeを押して、最終断層像を表示します。最後のステップに進むには完了を押します。

== 中間ファイルの後処理およびクリーンアップ ==

後処理には、ボリュームトリミングとバイトスケーリングのステップと、それに続く中間ファイルの削除が含まれます。また、ボリュームを平坦化し、縮小したボリュームを作成するオプションもあります。非常に大きなデータセットで作業する場合はこれらの両方が便利であり、フラット化はシリアルセクションを再構築するときに特に役立ちます。使用方法の説明は、「トモグラフィガイド」の「POST-PROCESSING」セクションにあります。

2つの軸の1つに結合された最終的な再構成は、常にsum.recと呼ばれます。（単一の軸データセットがある場合、この時点での再構成ファイルの名前は、データセット名とそれに続く_full.recです。）3dmod Full Volumeを押してsum.rec再構築を開きます。再構成をステップ実行して、最終ボリュームのX、Y、Z範囲を決定します。XとYの範囲を設定する便利な方法は、Zapウィンドウのツールバーのラッシュバンドを破線の四角形でオンにし、マウスの左ボタンを押して目的の領域の左上隅を押し、マウスを下にドラッグします右隅。必要に応じてZを設定することもできます。Loを押して最小ZとHiを設定します最大Zを設定します。3dmodからGet XYZ Volume Rangeを押すと、3dmodからゴムバンド（Xバンドが設定されている場合はZ値）のX値とY値が取得されます。この例では、XとYのデフォルト範囲が使用されています。非細胞性物質を排除するために、Z軸（フリップトモグラム内）の範囲は、Z minが19であり、Z maxが67であるように設定されている。最後に、スケーリング範囲を設定して、金ビーズを除外するスライスの範囲を見つけます。この例では、スケーリングはセクションに基づいており、スライス24と70の間の範囲を持っています（3dmodを使用してこれらの数値を入力する場合は以下を参照）。
ゴールドを含まないスライスの範囲を見つけることができないことがあります。例えば、ここで使用されているサンプルには、セルの外側のプラスチック樹脂上に、スケーリングに使用する同じスライスに現れる金粒子が含まれています。このような金粒子を排除するためのXおよびYスケール範囲を制限することにより、最終的な断層像のコントラストが改善される。3dmod Full Volumeボタンを押しZAPウィンドウを立ち上げます。金粒子を示すスライスに移動し、それらを除く領域の周りにラバーバンドを置きます。これを行うには、Zスライダーの左のラバーバンドトグルを押します。

目的の領域の左上隅にマウスの左ボタンを押し、マウスを右下隅にドラッグします。次に、Zスライダをスケーリング範囲の下側に移動して（24）、Loを押します。Zスライダーをスケーリング範囲（70）の上部に移動しHiを押します。

EtomoのScalingボックスに移動し、Get XYZ Sub-Area From 3dmodボタンを押します。これにより、Etomoは選択したX、Y、Zの値を取得します。デフォルトの方向変更オプションは、特別なオプションなしで3dmodや他のプログラムで簡単に読み込めるように、最終的なボリュームをX軸回りに回転させます。Trimvolを実行するにはTrim Volumeボタンを押します。Trimvolは、ボリュームをトリミングしてバイトに変換するための単一のツールです。最後に、3dmod Trimmed Volumeを押して、トリムされた最後のボリューム（BB.recという名前）を表示します。Doneを押してファイルのクリーンアップに進みます。
中間ファイルのクリーンアップ：

ファイルのクリーンアップは非常に重要です。断層像生成プロセスは、多くの大きな中間ファイルを生成する。Intermediate file cleanupボックスは、我々は削除することができ、中間、非必須ファイル考えるもの示しています。最終的な断層像が本当に最終的なものであることを確認したら、中間ファイルを強調表示し、Delete Selectedボタンを押して選択することができます。すべてのファイルをハイライト表示するには、1つのファイルをクリックして、CtrlキーとAキーを同時に押します（OSXのコマンドとA）。
最終的な二重軸断層像はBB.recと名付けられ、3dmod BB.recコマンドを使用してEtomoの外で見ることができます。トモグラムの多くの細胞機能のモデリングについては、3dmodの紹介を参照してください。これは簡単なデータセットであり、自分自身のデータでさらに問題が発生する可能性が高いため、実際のデータセットの作業を開始するときは、「トモグラフィガイド」を読んでください。また、Etomoの使用法を読むと、Etomoをより効果的に使用することができますヘルプへのアクセスや並列処理の設定などの機能について説明しています。最後に、バッチ再構成チュートリアルの指示に従ってこのデータセットを処理すると、再構成を高速化するためのバッチ処理の可能性を確認できます。

eTomoチュートリアル

2023-02-12T06:56:49Z

Tacyas: /* 2つの軸を結合する */

''eTomoチュートリアル''

== 未加工のチルトシリーズの初期設定と表示 ==

　このチュートリアルでは、小さな2軸のサンプルデータセットと、Etomoへのステップバイステップガイドが含まれています。このチュートリアルは、トモグラフィガイドを置き換えるものではありません。各ステップの詳細については、より包括的なトモグラフィガイドを参照してください。サンプルデータセットは、プロセス全体を問題なく処理する必要があるため選択されました。トモグラフィガイドは、2軸断層撮影の計算に使用される多くのプログラムのトラブルシューティングと学習に関する参考資料です。

　このチュートリアルのこのバージョンでは、IMOD 4.9にいくつかの新機能が示されています。 IMOD 4.9がインストールされていない場合は、アップグレードするか、端末にimodhelpと入力し、インストールされているバージョンに含まれるEtomoチュートリアルを選択してください。

　まず、Webサイトからサンプルデータセットをダウンロードしてください。次のように入力してデータを解凍します。

imoduntar tutorialData.tar.gz

　これはチュートリアルを開始するのに必要な2つの未加工のスタックBBa.stとBBb.stをそれぞれ含むディレクトリtutorialDataを作成します。また、データセットの完成後に残っている小さな作業ファイルのすべてを含むサブディレクトリ、finalFiles、および最終的な再構成のコピーがあります。

　ファイル名には、独自のデータセットに従わなければならない規則が反映されています。生スタックには拡張子.stがあり、二重軸スタックには共通のルート名がa.stとb.stで終わります。この拡張子は、単に規約に過ぎず、画像ファイルの形式を示すものではありません。拡張子.mrcを持つことも可能です。Etomoはファイル名を拡張子.stに変更します。適切な形式でデータファイルを持っていて他の拡張子を持っている場合は、ファイル名の拡張子を.stに変更する必要があります。

== Etomoのセットアップ ==

Etomoを起動するには、次のように入力します。

etomo

　

　Etomoを最初に起動すると、Front Pageパネルが表示され（上の図を参照）、Etomoで実行する操作を選択できます。この時点で、Build Tomogramボタンを押すか、FileとRecent Projectsメニューの既存のデータセットを開くことで、新しいデータセットの作業を開始できます。

　Build Tomogramを押して、Setup Tomogramパネルを表示します（上の図を参照）。 Project Logウィンドウも開き、アクションの履歴が含まれ、特定の手順に固有の有用なログファイルソリューションがレポートされます。

　新しいデータセットの作業を開始するには、以下のフィールドを入力する必要があります。 Dataset nameは、未加工のチルトシリーズ（または二軸データセットが収集された場合はroot_namea.st）を含むファイルの名前です。Dataset nameフィールドに関連付けられている黄色いファイル選択ボタンをクリックするか、ディレクトリパスとファイル名をフィールドに直接入力して、Detaset nameを入力できます。 Backup directoryは、手順を実行するたびに小さい作業ファイルを保存するオプションのフィールドです。バックアップディレクトリを使用しない場合は、このフィールドを空白のままにできます。

　Templatesボックスで、plasticSection.adocSystem templateを選択します。このテンプレートはIMODインストールの一部であり、この種の再構成に適したいくつかのパラメータを設定するために使用できます。

　データセットがSingle axis（単軸）かDual axis（二軸）かを選択します。 Montageオプションは、モンタージュチルトシリーズの処理に使用できます。

　次のフィールドは、ピクセルサイズ（nm）、金基準直径（nm）のサイズ、イメージ回転（度）を指定します。ピクセルサイズ（nm単位）は、顕微鏡、カメラ、および倍率によって異なります。画像回転（垂直からの傾斜軸角度、度）も顕微鏡と倍率によって異なります。 Scan Headerボタンを押すと、MRCファイルヘッダーで指定されている場合はピクセルサイズと画像回転値が取得されます。このチュートリアルの例では、このデータセット（2.02）と画像回転（-12.5）のピクセルサイズを定義するには、Scan Headerを押します。金の基準直径（10 nm）のサイズを指定する必要があります。

　Parallel Processingチェックボックスが有効になっている場合は、チェックを外して画面がここに示されているように見えるようにします。このチュートリアルでは扱いませんが、パラレル処理では、複数のコンピュータまたは1台のコンピュータ上の複数のプロセッサにプロセスを分散させることができます（有効化の方法については、Etomoの使用を参照してください）。Image distortionフィールドのファイルエントリを空白のままにします。この機能を使用して、非線形の画像歪みが測定され、特性化されていれば補正することができます。これはエネルギーフィルタのデータで特に有効です。Mag勾配補正項目を空白のままにします。この機能には、各画像に適用される倍率勾配を持つファイルが含まれています。これは、モンタージュデータでの使用に便利です。

　Axis Aおよび必要に応じてAxis Bボックスのいずれか一方または両方の軸の傾き角度のソースを指定します。この例では、傾斜角が拡張ヘッダに格納されるため、データからのデフォルトの抽出傾斜角を使用する必要があります。ゼロ度から2方向に撮影したチルトシリーズを再構成する場合は、Series was bidirectional fromをオンにすることができます。これにより、適切なアライメントパラメータの設定が行われます。必要に応じて、個々の投影を指定して、処理ステップから除外することもできます。この除外リストの構文は、コンマで区切られた範囲のリストです（1,4-5,60-70など）。このセクションには、3dmodで表示するための生データファイルを開くためのボタンもあります。

　前処理ステップの決定や、画質の悪い特定のビューがあるかどうかを確認したり、アライメントと再構成から除外したりする場合は、未加工のチルトシリーズファイルを見ると便利です。

　ビューの画質が悪い（フォーカスがないなど）かどうかを判断するには、Raw Image Stackボタンを押してRawスタックを開きます。動画を通してマウスの中ボタンをクリックすることで未加工のチルトシリーズの画像を表示します。どのように画像が少し跳ね上がるかに注目してください。アライメントと再構成から除外する特定のビューを書き留めます。このサンプルデータセットでは、除外する必要がある画像はありません。

　チュートリアルのサンプルデータセットに固有の詳細は上に示されています。このサンプルデータセットの場合、Dataset nameはBBa.stです。それは二重軸セットです。画素サイズは2.02nmであり、基準直径は10nmであり、画像回転は-12.5度である。このデータセットの傾斜角度は、データファイルから保存され、抽出されます。

　Create Com Scriptsボタンを押して断層像の生成に進みます。

== Etomoメインウィンドウ ==

　このチュートリアルを終了する前にEtomoを終了する必要がある場合は、中止したところからデータセットが含まれているチュートリアルデータディレクトリに移動し、次のように入力して続行できます。

$ etomo BB.edf

　メインウィンドウはいくつかの領域で構成されています。左側には、操作する断層像計算の特定のステージを選択できるボタン（プロセス制御ボタン）の列があります。一番上には、現在のプロセスまたは完了した最後のプロセスのステータスを通知するプロセスモニタがあります。プロセスモニタの左側には、Axis AとAxis Bの間を移動するためのAxisボタンがあります。メインウィンドウは現在、Axis Aに対して開いています。

　プロセス制御ボタンは、上から下に向かって処理の順番に並べられています。ボタンはプロセスの段階を示すために色分けされています。赤はプロセスが開始されていないことを示し、マゼンタはプロセスが現在進行中であることを示し、緑はプロセスが完了したことを示します。いずれかのボタンが選択されると、ウィンドウの右側に特定のプロセスに関連する情報とフィールドが表示されます。これらのフォームはプロセスパネルと呼ばれます。それらを使用すると、必要なパラメータを変更し、その処理ステップで必要な特定のプログラムを実行することができます。各プロセスパネルのパラメータとボタンは通常、フローチャートのように実行する順序で上から下に配置されます。プロセスを実行すると（プロセスパネルのいずれかのボタンを押すと）、プロセスモニターはプロセスの処理が完了したこととその時間を表示します。

== 前処理 ==

　画像がCCDカメラを使用して顕微鏡上で収集された場合、最初の暗い電子または個々の画像の収集中にCCDカメラに当たるランダムなX線が、データファイルのピクセル値の極端な高低差を引き起こす可能性があります。その結果、これらの極端な値はコントラストを破壊し、再構成に人工的な効果を引き起こす可能性があります。このチュートリアルの例では、このような問題を引き起こす極端なピクセル値はありません。ただし、これらのピクセル値を削除する手順については、ここで概要を説明する。最初に、ファイルに極端なピクセル値があるかどうかを判断する簡単な方法は、未処理のスタックのイメージヘッダーの最小値と最大値を調べることです。これを行うには、コマンドラインターミナルで次のように入力する。

$ header BBa.st

　最小値、最大値、および平均濃度の値に注目します。最小濃度値が負の数または0である場合、暗い電子の収集中にX線イベントが原因で、データセットに極端な黒いピクセルがある可能性があります。最大濃度が高い場合は、データセットに極端な白いピクセルがあります。極端な値がデータセットのどこかに潜んでいて、それらを削除するための前処理が必要な場合は、前処理ボタンを押してこのパネルを開きます。

　前処理に関連する基本的な手順（チュートリアルのデータセットでは不要）を以下に示します。

・Show Min / Max for Raw Stack ボタンを押すと、各セクションの最小密度と最大密度をRawスタックに表示するプログラムであるクリップ統計が実行されます。テキスト出力とこれらの密度のグラフが表示された状態でウィンドウが開きます。

・Create Fixed Stack ボタンを押して、X線を除去した第2のスタックを作成します。

・View Fixed Stack ボタンを押してそのスタックを表示し、Show Min / Max for Raw Stackボタンを押して固定スタックのクリップ統計を実行します。極端なピクセル値が修正されているかどうかを確認します。

・3dmodの黒と白のスライダが非常に接近していない状態でコントラストが良好に表示され、未処理のスタッククリップの統計出力からの異常な値が固定スタック出力からなくなった場合は、Use Fixed Stackボタンを押します。

この操作の詳細については、トモグラフィガイドの PRE-PROCESSING: REMOVING X-RAYSセクションを参照して下さい。

== 粗調整 ==
“Coarse Alignment”プロセス制御ボタンを押して、粗く整列したスタックを作成します。

“Calculate Cross-Correlation”ボタンを押すと、隣り合う傾斜画像毎の相互相関プログラムが実行されます。
* このプログラムは、相互相関を用いて、傾き系列の連続する画像間の最初の並進アライメントを見つけまう（すなわち、xとyだけシフトする）。
* 出力ファイル“BBa.prexf”には、次のステップで画像データに適用される変換（または推奨シフト）のリストが含まれています。

“Generate Coarse Aligned Stack”ボタンを押すと、2つのプログラムが実行されます。
Xftoxgは、傾き相互相関によって作成された変換を使用して、一貫した「グローバル」アライメントセットを取得します。
これらの新しい変換は、Newstackプログラムを使用して画像データに適用されます。
出力ファイル“BBa.preali”が作成されます。
“View Aligned Stack in 3dmod”ボタンを押すと、プリアライメント（一定方向に整列）されたスタックを見ることができます。
相互に作用するMidasプログラムを使用して、大きな画像シフトを手動で編集することができます。これらは、このデータセットの問題ではありません。詳細については、「トモグラフィガイド」の「粗調製」を参照してください。

Midasが実行されている場合には、傾斜軸が垂直になるようにMidasが画像を回転させるため、傾き軸回転登録が使用されます。
“Fiduclalless alignment”チェックボックスは、基準点アライメントなしでトモグラフィを作成するために選択できます。詳細については、「トモグラフィガイド」の「相関アライメントを使用したクイックトモグラムの作成」を参照してください。
事前にスタックされたスタックに問題がなければ、完了ボタンを押して杉のステップに進みます。

== 金粒子の位置に基づいた基準モデルの作成 ==

基準モデルを生成するに利用できる3つのオプションがある。最も一般的なのは、Make seed and trackオプションでいくつかの金粒子基準マーカーを追跡することだ。この開始点は手動または自動で選択できる。これらの開始点はある一部分のみから選ばれ、基準点がそこから追跡されるため、粒子モデルと呼ばれる。データセットに金粒子基準マーカーがないか、少なすぎる場合は、Use patch tracking to make fiducial modelオプションを使用できる。Run RAPTOR and fixオプションは、スタンフォードで開発されたプログラムを使用し、傾斜系列（像の一軸トモグラフィー）を通じて金基準マーカーを自動的に探して追跡する。詳細については、トモグラフィーガイドのFIDUCIAL MODEL GENERATION（基準モデル作成）の項目を参照。まず初めに新しい機能を使用して、金粒子の位置を自動的に選択する。その後バックアップして古典的な方法へ進むが、これはより不明瞭なデータセットを解析する場合の手順を示すことに適している。

Total number（追跡する粒子の総数）に25を入力し、Select beads on two surfacesにチェックを入れる。

Generate Seed Modelボタンを押す。

操作が完了すると、各平面で選択された粒子の数がProject Logウィンドウに表示される。Open Seed Modelボタンを押すと、選択した粒子の基準点が表示される。粒子の基準点を見るには、1度の部分までスクロールしなければならない。緑色の点は底面の粒子を、マゼンタの点は上面の粒子を色づけている。次のステップでは、このモデルを粒子として使用して完全な基準モデルを作成する。

Track Beadsタブを選択する。

Track Seed Modelボタンを押す。

これにより、粒子追跡プログラムが実行され、他のすべての部分で金粒子が見つかる。tracka.comで作成された出力ファイルは、完成した基準モデルのBBa.fidである。このコンピュータ生成モデルは完全ではなく、基準モデル中にずれが生じる可能性がある。欠落した粒子の基準点の合計数がProject logウィンドウに表示される。多数の基準点が欠落している場合は、Track with Fiducial Model as Seedボタンを押す。これにより、金粒子のような基準モデルを追跡するプログラムが再実行される。この場合、基準点は記入されない。

粒子の基準点がまだ欠落している場合、次の手順ではこの基準モデルを編集する反復プロセスが必要となる。特に、ここにあるように基準点の超過がある場合は、すべてのずれを直す必要はないことに注意。しかし、大部分の粒子の基準点が傾斜系列（像の一軸トモグラフィー）の両端まで追跡されていることを確認することが重要である。

Fix Fiducial Modelボタンを押す。

この手順では、3dmod中に内蔵されたスタック（BBa.preali）と基準モデルファイル（BBa.fid）が開く。

粒子修正のダイアログボックスがFill gapsモードで表示される。粒子修正は、基準モデルの編集を容易にする。

Go to Next Gapボタンをクリックする（または、スペースキーをホットキーとして使用する）。これによって、隣接する区画上に基準点がない点（黄色の円で強調表示されている点）を表示させる。Page Upキー（ポイントの上に上矢印が表示されている場合）またはPage Downキー（ポイントの上に下矢印が表示されている場合）を使用して欠落している粒子のある区画を探し、マウスの中ボタンを使用して金粒子の中心を基準点に加える。「＋」キーで画像の倍率を上げて、区画のコントラストを調整することは、特にトモグラフィーの傾斜が高いときに便利である。

メイン3dmodウィンドウ上に「No Gaps Not Found」というメッセージが表示されるまで、Go to Next Gapを繰り返す。File -> Save model、またはホットキー「s」を押してモデルファイルを保存し、完了ボタンを押して粒子位置の精細な調整へ進む。

== 連続的な傾斜の整列 ==
Fine Aligment パネルは、さまざまなアライメントパラメータを解決するための3つのタブのセットで構成されています。一般的な位置合わせは、最初にFine Alignment boxの下部にあるCompute alignmentボタンを押して行います。

このコマンドファイルでは、プログラムTiltalignを実行して、傾斜したビューの変位、回転、傾きおよび倍率の差異を見出します。このプログラムはfiducial modelでの金粒子の位置と最適なフィットを見つけるためのmetric minimization（メートル最小法）が使われています。これは行われたことの概要を示すログファイルを作成します。すべての未知数に対する合計値と残差誤差平均とsdの比率のレポートがプロジェクトログウィンドウに表示されます。ログファイル全体にアクセスするには、プロセスに関連付けられたウィンドウ領域上でマウスカーソルを右クリックします。これにより、3つまたは4つのセクションに分割されたメニューが開きます。最初のセクションでは、現在のプロセスに関連するログファイルを開くことができます。 2番目のセクションでは、アライメントパラメータのグラフを見ることができますが、他のほとんどのパネルには存在しません。次のセクションでは現在のプロセスに関連するマニュアルページを開き、最後のメニューセクションでは一般的なヘルプガイドを開きます。ログファイルを開くには、[Align axis: a log file（軸を合わせる：ログファイル）]を選択します。これにより、このログファイルの完全なログと短いセクションが含まれるタブ付きのファイルが開きます。私の例では、最初のCompute Alignment runは0.236の残差平均を与えました。

この結果は次のステップを説明するのにとても良いので、ここでバックアップを取っていきます。最初に3dmodを終了し、ターミナルウィンドウに移動してシードモードを削除するか、名前を変更します。
例：　mv BBa.seed BBa_auto.seed

次に、Etomoで、左側のSeed ModelタブのFiducial Model Gen.を押し、画面がこのようになるようにMake seed model manualyを作成します。

View Seed Modelボタンを押す。
（このボタンは別のモデルが作られる前にSeed Fiducial Modelと名付けられていました）。これにより、3dmodでBBa.prealiが開き、BBa.seedと名付けられた空のモデルファイルが作成されます。また、Make SeedとAutocenterにチェックの入った Bead Fixerダイアログボックスが表示されます。オフの場合は、Automatic new contourをチェックします。 3dmodではセッションごとにこの設定が記憶されます

3dmodはファイルを中間セクションに開きます（このチュートリアルスタックのセクション31）。キーボードのInsertキーを押すことで中央のセクションに戻ることができます。

Zap（画像）ウィンドウで、金粒子の中央にカーソルを合わせ、マウスの中央ボタンを押して、モデルポイントを20-30の金粒子の中央に配置します。自動で新しい輪郭がチェックされるので、新しい金粒子ごとに新しい輪郭が作成されます。Autocenterがチェックされているので、3dmodはモデルポイントが金粒子の中央に配置されていることを確認する必要があります。したがって、ギャップを埋めるときほど注意を払う必要はありません。例（BBa.seed）では25個の金粒子を選択しました。モデルには1つのオブジェクト、25の輪郭が含まれ、各輪郭には1つの点があります。このシードモデルを保存します。

次に、Track Beadsタブをもう一度選択します。今回は結果が非常に良い状態に保たれるように、Sobel filterのRefine centerをオフにします。

Track Seed Modelを押してシードモードを追跡します。これまでのように、Fix Fiducial Modelを押して、ギャップを記入してください。もう一度ファインアライメントステップに
進みます。

Compute Alignmentを押します。今回は残差がすこし大きくなっています。

より良いアライメントステップの目標は、このチュートリアルデータセットのピクセルサイズを残差誤差平均0.2〜0.5に減らすことです。より小さなピクセルサイズのデータセットは、より大きな残留誤差を持つことを意味する。
Tiltalignプログラムは、基準モデルに関する有益な情報を提供する2つのモデルファイルも作成します。最初の（BBa.3dmod）は、解決された位置に基づいて基準点の3次元モデルを表示します。2つのサーフェス上に存在する基準点には2つの異なる色が割り当てられます。一方はピンクの球、もう一方はグリーンの球です。 Fine Alignmentボックスの下部にある3Dモデルの表示ボタンをクリックして、このモデルを調べます。

見える範囲にピンクとグリーンの球がいい具合に分布しているのが見られます。キーパッドの数字の8を押して回転させ、エッジを表示します。このビューでは2つの表面の分かれ目が見られます。アラインメントが歪曲するのでいずれかの特定の領域に基準点群をもつモデルを使用しないでください。3dmodvウィンドウを閉じます。

Tiltalignが生成する第2のモデルは、残差ベクトルモデルです。 Fine Alignmentボックスの下部にあるView Residual Vectorsボタンを押します。これは、事前に整列されたスタックを3dmodで開き、各セクションに残差ベクトルモデルを表示します。

このモデルは、現在のモデル点を緑色の矢印の原点として、残りの位置を矢印の終点として表示します。この変位は非常に小さい（<2ピクセル）ため、この残留変位は実際のモデル点と区別するために10倍に拡大されています。大きな（> 2k×2k）画像では、残差モデルはしばしば1つの領域に大きな変位を示しますが、他の領域には存在しません。これらの場合、残差モデルは局所的なアラインメントが必要な時に決めるのに役立ちます。この例では、局所的なアラインメントは必要ありません。一般的に、より極端な傾きにおいてより大きな残差を持ちます。次のいくつかのステップで3dmodを開いたままにして、View / Edit Fiducial Modelボタンを押して基準モデルを編集用にリロードします。これにより、大きな残差モデルを修正モードでBead Fixerダイアログボックスが表示され、aligna.logファイルがロードされます。

以下の反復ステップは、大きな残差を有する基準点を固定することを含む。

Bead FixerダイアログボックスのGo to Next Residualをクリックします。

大きい残差を持つモデルポイントには、推奨移動の方向を指す赤い矢印が表示されます。モデルポイントが金に適切に集中していないことが観察できると思われます。Bead FixerダイアログボックスでMove Point by Residualをクリックすると、モデルポイントが推奨量だけ移動します。これはほとんどの場合良い働きをするのですが、この推奨が間違っていると思われる場合は、カーソルを金粒子の中央に合わせてマウスの右ボタンをクリックすることで手動で移動できます。この推奨は、すべての基準点にフィットする数学的アライメントモデルによって予測された位置であり、粒子が実際に画像内に位置する場所の分析に基づいている訳ではありません。アライメントモデルにうまく収まらないほど歪んだ標本である場合、矢印は実際の金の位置から離れていることがよくあります。

残差が見つからなくなるまでGo to Next 1big 1residualおよびMove Point by Residualを繰り返します。ホットキー（残差によってポイントを移動する）は次の残差に移動します。目標は、それが関連する基準点の上に各点を集中させることです。残りの矢印は必ずしも正しいとは限りません。ポイントはマウスの右ボタンでクリックして移動することもできます。時には、他の表面からの基準点は、現在の基準点の範囲を観察するのを困難にします。ページアップボタンとページダウンボタンを使用して基準点を区別します（ただし、Go to Next Big Residualで選択したセクションに常に戻ります）。Undo Moveボタンを押すと、残差による移動を元に戻すことができます。

修正する残差がなくなると、モデルファイルを保存してファイルを開いたままにします。
aligna.logファイルにアクセスし、Surface Anglesタブに移動します。

下部のTotal tilt angle changeに気を付けてください（この例ではこの値は-0.40でした）。この値をTotal tilt angle offsetの下のFine Alignment Volume Position Parameters boxに入力します。Compute Alignmentボタンをもう一度押します。アラインメントは訂正が組み込まれた状態で計算され、3dmodは結果のログファイルを再度読み込みます。メインの3dmodウィンドウの下部にあるテキストボックスを参照してください。

大きな残差のあるモデル点を修正するには、もう一度進んでください。モデルを保存します。
データセットの両面に金の分布が良好であれば、歪みを解くことができます。Fine AlignmentボックスのGlobal Variablesタブを押します。

パネルの下部にあるDistortion Solution Type領域でFull solutionオプションを選択します。これにより、X軸方向の伸びと歪みの2種類のねじれが解決されます。既定のグループサイズを維持し、Compute Alignmentボタンを押して配列を実行します。Compute Alignmentが実行されると、3dmodはログファイルを再読み込みします。
3dmodのウィンドウに戻り、歪みを解決した後にTiltalignが示してきた新しい残差の修正を繰り返してください。次に、Bead FixerウィンドウのSave＆Run Tiltalignボタンを押してモデルを保存し、位置合わせを計算します。Etomoのパラメータを変更していない限り、このボタンを使用することによりEtomoに戻る必要がなくなります。3dmodでアライメントとチェックのモデルポイントを数回実行した後、最終平均残差は0.2〜0.4になるはずです。この例では、最後の残留誤差平均は0.326でした。

== ３つの小さな再構成を作成するためにデータセットをサンプリングする ==

次のステップンも目標は、できるだけ平坦で最小のボリュームに収まるように再構成をシフトして回転させることです。
これは、断層画像の３つの領域、すなわち、傾斜画像の上部、中央および下部付近から計算された3つの領域をサンプリングすることによって行われる。
（これらのサンプルが適切でない場合は、断層撮影された断層像全体を使ってこれを行うことができます；詳細については、断層撮影ガイドのトモグラム全体の位置づけを参照してください。）
調整可能な２つの回転があります：傾斜軸周りの回転、（断層像の長さ全体にわたって同じ高さZで断面が出るように、X軸周りの回転を含む）X-Z平面で見たときの断面レベルを作るための回転。
IMOD4.9の新機能により、セクションの上面と下面が自動的に検出され、図面を保存して面を定義することができます。
この軸を手動で操作します。2番目の軸に自動位置決め機能を使用します。
これはビニングされたデータセットなので、“Positioning tomogram thickness”を200に減らします。
これにより、元のセクションよりもはるかに厚い再構成が作成されます。
“Create Sample Tomograms”を押します。

このコマンドファイルは、まずイメージスタックの上、中央、下から60ピクセルのスライバ（鋭角や微細な形状のこと）を抽出して整列させます。
次に、これらのサンプルを使用して、整列したスタックの上、中央、下から20個の薄切りの再構成を作成します。
これらの出力ファイルの名前はtopa.rec、mida.rec、bota.recです。“Create Boundary Models”を押します。
このステップでは、各再構成の上面と下面を定義するモデルを作成します。
“Create Boundary Models”を押すと、3次元MODは3つの再構成を一度に読み込み、topa.recが最初に表示され、エッジが表示されます。
3次元MODは、tomopitcha.modという名前の空のモデルからも開始されます。

Zapウィンドウの上部バーには、‘４D’の機能と、前後矢印があります。
前方矢印をクリックすると、それぞれmida.recとbota.recの再構成が繰り返されます。
topa.recから開始する。コントラストスライダを使用してコントラストを調整します。
ボリュームの中央のマテリアルが不鮮明な外観になっていることに注意してください。
これは、生物学的材料を用いた再構築の一部である。
マウスの中央のボタンを使用して、生物材料を含む領域を定義する上面の左側に１つのモデル点を配置し、上面の右側に第2のモデル点を配置します。
線が2つの点を接続します。
セクションの底面を、それぞれ左右２つの点でモデル化します。
Zapウィンドウの上部にある‘4th D’の右にある矢印ボタンを押すことによって、mid.recとbot.recファイルに切り替えます。
他の２つの再構成の上面と底面のモデリングを繰り返します。
最終的なモデルは1つのオブジェクトと６つの輪郭を持ち、各輪郭は２つのモデル点を持つ必要があります。このモデルファイルを保存します。
一般に、最終断層像の厚さは、描く線の間の実際の距離よりも約10-20ピクセルほど厚いことが有効です。
これを達成するために、追加されたボーダーの厚さで入力を調整することができます。
デフォルト値の5は断層像を10ピクセル厚くします。それを10ピクセルに変更して20ピクセル厚にします。
“Compute Z Shift and Pitch Angles”を押します。
これらのモデル輪郭に基づいて、トモピッチは再構成を可能な限りフラットにし、可能な限り最小の容積に収めるためのパラメータを決定する。
これらのオフセットは、既存の角度オフセット、ZシフトおよびX軸傾斜値に自動的に追加されます。
最終断層像の厚さは、トモピッチログからEtomoによって入力されます。

== フルサイズのスライス像を作成する最後の実行 ==

Create Final Alignmentボタンを押します。最終的な配置変換が作成されたら、完了ボタンを押して次のステップに進みます。

最終整列スタックの作成

Create Aligned Stackを押します。
このコマンドは、最終整列されたスタックのフルサイズの画像に整列変換を適用します。出力ファイルの名前はBBa.aliです。

完全に整列されたスタックは、View Full Aligned Stackを押すことで表示できますが、これは必須ではありません。 CTF補正、基準点の消去、および整列されたスタックのフィルタリングのためのオプションの手順がありますが、ここでも必要ありません。 Done（完了ボタン）を押して次のステップに進みます。

傾斜パラメータセクションの初期設定のフィルタリングパラメータは、多くの場合に適用できますが、変更することもできます。または、整列されたスタックをフィルタリングして再構成時のノイズを減らすことができます（詳細については、トモグラフィガイドのTOMOGRAM GENERATIONセクションを参照してください）。

トモグラムの生成

Generate Tomogramを押します。

断層像が計算されると、View Tomogram in 3dmodを押すことで断層像を調べることができます。スペースを節約するために、この時点で中間イメージスタックを削除すること（Delete Intermediate Image Stacks）もできます。

マウスの中ボタンを押して、スライス撮影の上面から底面まで一連の断層撮影写真をステップスルーすることによって、再構成を経て映像を再生します。

== .第2の軸（軸B）上 ==

軸Bを表示するには、Etomoウィンドウの上部にあるAxis Bボタンを押します。これにより、軸Bの傾斜シリーズを整列させ、スライス像を計算するための操作を実行するために使用できるもう1組のプロセスボタンが表示されます。混乱を避けるために、軸Aは青い背景を持ち、軸Bは緑色の背景になっています。

Etomoのメインウィンドウの右側には、軸Bの傾斜シリーズを整列させ、断層像を計算するための操作を実行するためのプロセスボタンがあります。このサンプルのデータセットでは、前処理ステップは必要ありません。軸Aで説明したように、Coarse Alignmentの過程に進みます。

粗く整列されたスタックが生成されたら、Doneを押して次のステップに進みます。
両方の傾斜軸を組み合わせるには、追跡しているビーズの少なくともいくつか（8-10）が2つのセットで同じでなければなりません。これを達成するには、基準点の移動プログラムを使用します。

A軸からの基準点の移動

Transfer Fiducials From Other Axisボタンを押すと、最初の軸からの基準モデルに基づいて2番目の軸の粒子基準モデルを作成する基準点の移動プログラム（Transferfid）が実行されます。プログラムは、最もよく対応する2つのセット中の画像のペアを検索し、最初のセットの基準点を転送して、2番目のセットの粒子基準モデルを作成します。最後に、プログラムは第1軸と第2軸の間で対応している基準点をリストし、これをProject logウィンドウに表示します。

いくつかの基準点が転送できなかった場合でも心配しないでください。この例では、19個の基準点が対応しています。

これは少し低く、2つの軸が非常によく一致しないために起こっています。手動でポイントを追加することもできますが、自動的にポイントを追加すると便利です。Add points to seed model automatically（シードモデルに自動的にポイントを追加）を選択すると、自動粒子パネルが開きます。

Add beads to existing model（既存のモデルにビーズを追加する）が選択されており、2つの断層上の総数（Total number）と選択ビーズの設定も、もう一方の軸から転送されていることに注意してください。

Add Points to Seed Modelを押して、BBb.seedというTransferfidによって生成された粒子基準モデルにさらに多くの基準点を追加します。Track Beads タブを選択し、軸BウィンドウのTrack Seed Model （基準モデル）の追跡に進みます。

これは自動的に軸Bセットの基準点を追跡します。 BBb.fidファイルでの基準点の欠落を修正するには、A軸について上で説明したように、Fix Fiducial Model を押して基準点の修正を行います。修正されたら、Doneを押して細かい整列とトモグラムの計算過程に進みます。

軸 Aセットについて上記で説明したことに従って、同じ手順を進めます。

簡単に：
Fine Alignmentボックス中Global variable のCompute Alignmentボタンを押します。

この時点で、大きな差をがある基準点を編集し、モデルを保存し、アライメントを計算することによって、 Aセットのように反復アラインメントを開始します。アラインメントが完了したら、Doneを押して、スライス像の生成ステップに進みます。

トモグラフィーの自動位置決め

自動位置決めを使用するには、Find boundary model automatically（境界モデルを自動的に検索）にチェックを入れ、Positioning tomogram thicknessを再度200に設定します。

Create Samples & Boundary Model（サンプルと境界モデルの作成）とView Boundary Model（境界モデルの表示）ボタンが再ラベルされていることに注目してください。自動断層撮影の位置決めは、標本または断層像全体のいずれかで行うことができます。そして、断層像全体は標準試料位置に十分な材料がない場合に、より精度が上がります。ここではサンプルを使用しますが、断層像全体から境界モデルを調べるには多少異なる方法が必要です（詳細については、断層撮影ガイド全体の自動位置決めに関するセクションを参照してください）。

Create Samples＆Boundary Modelを押します。終了したら、View Boundary Modelを押して、描いた輪郭を調べます。

上記のA軸について概説した「最終整列スタック」の手順に進みます。

上記のA軸について概説したように、「断層像生成」ステップを続行します。

== 2つの軸を結合する ==

Axis Aボタンを押してA Axisに戻ります。
2つの断層像を結合するには、断層像の組み合わせプロセスボタンを押します。

断層撮影組み合わせパネル
断層像コンビネーションパネルは：3つのタブに整理され、セットアップ、初期マッチ、そして最終マッチ。
セットアップ情報は、特定のデータセットについて与えられるウィンドウがあります。最初のセクションでは、Tomogram Matching Relationshipについて説明します。B断層像をAに一致させることが最も一般的です。
Solvematch Parametersボックスに基準マーカの分布に関する情報が表示されます。この例では、基準点は両側にあります。このデータセットの場合、プログラムは一度にすべてのポイントに適合する問題がないため、Aから使用する開始ポイントを記入する必要はありません。
次のセクションでは、ローカル3D相互相関を使用して配置を精緻化するためのパッチパラメータの情報を示します。小さなパッチを選択します。どちらの中のパッチや大型パッチはほとんどのデータ・セットのために必要とされるが、このデータセットは、そのサイズを小さくするためにビニングされていますので、小さなパッチは、それらの情報をたくさん持っています。自動パッチフィッティングを使用するチェックボックスがオンになっていることに注意してください。十分な情報が見つからない場合、IMOD 4.9のこの新しい機能は自動的にパッチのサイズを増やします。パッチサイズは不必要に増加しません。
自動パッチフィッティングが選択されている場合、プログラムはボリュームに存在する情報の量も分析し、十分な情報がないパッチを除外しようとします。この手順で十分に機能しない場合は、パッチを抽出する領域を示す古い方法に戻ってください。これらの方法でいくつかの経験をするために、ボリュームの座標制限を設定する手順を説明します。
パッチが抽出されるボリュームの限界を指定する必要がある場合、一致する断層像を見ることが重要です。Z軸の範囲全体を使用することはほとんどできません。また、X軸とY軸の場合でも、デフォルトを使うのは良いことではありません。制限を見つけるには、パネルの下部にある3dmod Volume Aボタンを押します。これは3dmodでBBa.recを開きます。画像を一歩一歩見て、X軸、Y軸、Z軸のどの範囲にボリュームのマッチングに役立つ情報が含まれているかを決定します。この例では、X軸とY軸のデフォルトが維持されています。
この例ではZ軸分とZ軸の最大スライス内の約半分の材料（23および74）ぼやけない最初と最後のスライスに設定しました。

場合によっては、座標の制限値を設定しても、2つの軸が結合できるように十分に空の領域が削除されるわけではありません。その場合は、パッチ領域モデルを作成する必要があります。パッチ領域モデルを作成するには、パッチ領域モデルを使用するチェックボックスをオンにし、[パッチ領域モデルの作成/編集 ]ボタンを押して、一致する軸を開きます。モデルモードでは、生物学的材料を含む領域の周りを閉じた輪郭をトレースします。断層像で10スライスごとにこれを行います。モデルを保存します。名前はpatch_region.modです。パッチ領域モデルを作成することは、画像内に多量の樹脂または空き領域を有するデータセットを再構築する場合に特に有用である。このサンプルデータセットは、パッチ領域モデルを必要としません。
セットアップパネルのパラメータを入力したら、Create Combine Scriptsを押して、結合手順でさまざまなプログラムを実行する一連のコマンドファイルを作成します。ポップアップする警告メッセージは無視してください。Start Combineを押すと、2軸断層像の組み合わせが開始されます。Etomoは、様々なプログラムが実行されている間、自動的にInitial Matchに進み、最後にFinal Matchタブに進みます。
断層像の合成が完了したら、Open Combined Volumeを押して、最終断層像を表示します。最後のステップに進むには完了を押します。

== 中間ファイルの後処理およびクリーンアップ ==

後処理には、ボリュームトリミングとバイトスケーリングのステップと、それに続く中間ファイルの削除が含まれます。また、ボリュームを平坦化し、縮小したボリュームを作成するオプションもあります。非常に大きなデータセットで作業する場合はこれらの両方が便利であり、フラット化はシリアルセクションを再構築するときに特に役立ちます。使用方法の説明は、「トモグラフィガイド」の「POST-PROCESSING」セクションにあります。

2つの軸の1つに結合された最終的な再構成は、常にsum.recと呼ばれます。（単一の軸データセットがある場合、この時点での再構成ファイルの名前は、データセット名とそれに続く_full.recです。）3dmod Full Volumeを押してsum.rec再構築を開きます。再構成をステップ実行して、最終ボリュームのX、Y、Z範囲を決定します。XとYの範囲を設定する便利な方法は、Zapウィンドウのツールバーのラッシュバンドを破線の四角形でオンにし、マウスの左ボタンを押して目的の領域の左上隅を押し、マウスを下にドラッグします右隅。必要に応じてZを設定することもできます。Loを押して最小ZとHiを設定します最大Zを設定します。3dmodからGet XYZ Volume Rangeを押すと、3dmodからゴムバンド（Xバンドが設定されている場合はZ値）のX値とY値が取得されます。この例では、XとYのデフォルト範囲が使用されています。非細胞性物質を排除するために、Z軸（フリップトモグラム内）の範囲は、Z minが19であり、Z maxが67であるように設定されている。最後に、スケーリング範囲を設定して、金ビーズを除外するスライスの範囲を見つけます。この例では、スケーリングはセクションに基づいており、スライス24と70の間の範囲を持っています（3dmodを使用してこれらの数値を入力する場合は以下を参照）。
ゴールドを含まないスライスの範囲を見つけることができないことがあります。例えば、ここで使用されているサンプルには、セルの外側のプラスチック樹脂上に、スケーリングに使用する同じスライスに現れる金粒子が含まれています。このような金粒子を排除するためのXおよびYスケール範囲を制限することにより、最終的な断層像のコントラストが改善される。3dmod Full Volumeボタンを押しZAPウィンドウを立ち上げます。金粒子を示すスライスに移動し、それらを除く領域の周りにラバーバンドを置きます。これを行うには、Zスライダーの左のラバーバンドトグルを押します。

目的の領域の左上隅にマウスの左ボタンを押し、マウスを右下隅にドラッグします。次に、Zスライダをスケーリング範囲の下側に移動して（24）、Loを押します。Zスライダーをスケーリング範囲（70）の上部に移動しHiを押します。

EtomoのScalingボックスに移動し、Get XYZ Sub-Area From 3dmodボタンを押します。これにより、Etomoは選択したX、Y、Zの値を取得します。デフォルトの方向変更オプションは、特別なオプションなしで3dmodや他のプログラムで簡単に読み込めるように、最終的なボリュームをX軸回りに回転させます。Trimvolを実行するにはTrim Volumeボタンを押します。Trimvolは、ボリュームをトリミングしてバイトに変換するための単一のツールです。最後に、3dmod Trimmed Volumeを押して、トリムされた最後のボリューム（BB.recという名前）を表示します。Doneを押してファイルのクリーンアップに進みます。
中間ファイルのクリーンアップ：

ファイルのクリーンアップは非常に重要です。断層像生成プロセスは、多くの大きな中間ファイルを生成する。Intermediate file cleanupボックスは、我々は削除することができ、中間、非必須ファイル考えるもの示しています。最終的な断層像が本当に最終的なものであることを確認したら、中間ファイルを強調表示し、Delete Selectedボタンを押して選択することができます。すべてのファイルをハイライト表示するには、1つのファイルをクリックして、CtrlキーとAキーを同時に押します（OSXのコマンドとA）。
最終的な二重軸断層像はBB.recと名付けられ、3dmod BB.recコマンドを使用してEtomoの外で見ることができます。トモグラムの多くの細胞機能のモデリングについては、3dmodの紹介を参照してください。これは簡単なデータセットであり、自分自身のデータでさらに問題が発生する可能性が高いため、実際のデータセットの作業を開始するときは、「トモグラフィガイド」を読んでください。また、Etomoの使用法を読むと、Etomoをより効果的に使用することができますヘルプへのアクセスや並列処理の設定などの機能について説明しています。最後に、バッチ再構成チュートリアルの指示に従ってこのデータセットを処理すると、再構成を高速化するためのバッチ処理の可能性を確認できます。

File Formats and Other Documentation

2022-12-31T08:19:49Z

Tacyas: /* Section Data */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode（MRCファイルのモード）
|-
|ImageSize ||X and Y size of images（画像のサイズ）
|-
|Montage ||1 if the file is a montage（モンタージュかどうか）
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files(.idocフォーマットかどうか)
|-
|ImageFile ||In a .mdoc file, contains the name of the image file(.mdocの中で含む画像ファイルの名前)
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
（pixelあたりのスペーシング（Å），回折像では，1/Å）
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees（傾斜角）
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns（ステージ位置x y：ミクロン）
|-
|StageZ ||Z stage position in microns（ステージ位置z：ミクロン）
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
|TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
|TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
|LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
|NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
|MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
|ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
|ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
|MapProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、見かけ上のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、上述の4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。

# ピクセル座標系は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。

# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-31T08:17:17Z

Tacyas: /* Global Data */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode（MRCファイルのモード）
|-
|ImageSize ||X and Y size of images（画像のサイズ）
|-
|Montage ||1 if the file is a montage（モンタージュかどうか）
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files(.idocフォーマットかどうか)
|-
|ImageFile ||In a .mdoc file, contains the name of the image file(.mdocの中で含む画像ファイルの名前)
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
（pixelあたりのスペーシング（Å），回折像では，1/Å）
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
|TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
|TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
|LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
|NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
|MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
|ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
|ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
|MapProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、見かけ上のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、上述の4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。

# ピクセル座標系は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。

# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-31T08:10:37Z

Tacyas: /* 外部で定義されたNavigatorアイテムのインポート */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
|TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
|TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
|LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
|NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
|MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
|ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
|ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
|MapProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、見かけ上のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、上述の4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。

# ピクセル座標系は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。

# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-31T07:40:32Z

Tacyas: /* Navigation File Section Data */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
|TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
|TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
|LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
|NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
|MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
|ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
|ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
|MapProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-31T07:40:12Z

Tacyas: /* Navigation File Section Data */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
|TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
|TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
|LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
|NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
|MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
|ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
|ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-31T07:39:36Z

Tacyas: /* Navigation File Section Data */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
|TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
|TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:42:09Z

Tacyas: /* 設定ファイルおよびキャリブレーションファイルの入力 */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合に利用する。
この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:36:29Z

Tacyas: /* = HighFocusMagCal: */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合です。この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ====
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:35:19Z

Tacyas: /* ステージキャリブレーションと2x2変換行列 */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合です。この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ===
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力するステージのx軸に対する変化
** xpx
** xpy
* 入力するステージのｙ軸に対する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:34:06Z

Tacyas: /* ステージキャリブレーションと2x2変換行列 */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合です。この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ===
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（ビニングしていないピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は残念なものであり、X軸を傾斜軸をもつ基準となる「試料」座標系に対して相対的に、典型的なステージ座標系を反転させる必要がることを示している。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* 入力xに帯する変化
** xpx
** xpy
* 入力ｙに帯する変化
** ypx
** ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:22:03Z

Tacyas: /* ステージキャリブレーションと2x2変換行列 */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合です。この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ===
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（アンビンジングピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は、Xをチルト軸に沿わせた基礎となる「標本」座標系に対して、典型的なステージ座標系を反転させるという点で不運なものである。

StageCalibrationの行には
* Mag Index
* Camera number(カメラ番号)
* xpx
* xpy
* ypx
* ypy
* キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
* Magnification(倍率)

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:19:32Z

Tacyas: /* その他 */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合です。この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ===
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（アンビンジングピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は、Xをチルト軸に沿わせた基礎となる「標本」座標系に対して、典型的なステージ座標系を反転させるという点で不運なものである。

StageCalibrationの行には
マグ指数
カメラ番号
xpx
xpy
ypx
ypy
キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
倍率

== その他 ==

=== 画像の回転 ===

「試料」の座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

↑正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動

イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。

　 ↑正のYステージ移動のための画像移動
　 |
　 |
　　 |
　　　　　 |
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:14:00Z

Tacyas: /* Navigation File Section Data */

== Image Metadata Files ==
SerialEMは、画像のメタデータをIMOD "autodoc" フォーマットでテキストファイルに保存する。
この形式は、キーワードと値のペアをセクションと呼ばれるブロックに整理したものである。
このセクションには、さまざまな種類のデータが含まれているが、
SerialEMのファイルでは、基本的に1種類のセクションしか使用しない。
セクションは、大括弧付きのキーと値のペアで始まります。

[セクションタイプ = 名前]

ここで、セクションの「名前」または値は通常，ユニークに設定するが、
IMOD autodocリーダーではそうである必要はない。

セクションヘッダ以下の行は、次のような形式で表現される。
キー = 値
そのセクションに関連するデータを提供する。
さらに、キーと値のペアは、セクション・ヘッダの前のファイルの最初に記載することもでき、これらはグローバル値として参照される。

すべての値はオートドキュメントファイルにテキスト文字列として保存されるが、特定の種類の情報を期待するソフトウェアは、これらの文字列を1つまたは複数の浮動小数点または整数値に変換することがよくある。

IMOD ライブラリ libcfshr の autodoc モジュールには、1 つ、2 つ、3 つ、または多数の浮動小数点または整数値をファイルの指定セクションに格納または取得するための関数が含まれている。 autodoc形式がSerialEMに選ばれた理由は、このライブラリがすぐに利用できること、このような関数を利用すると便利なこと、IMODのautodoc読込み機能との互換性があること、などである。

SerialEMが生成する画像関連autodocファイルには2種類ある。

1) ".mdoc "ファイルは、MRCファイルに関するデータを提供し、画像ファイルと同じ名前ですが、拡張子が".mdoc "になっています。セクションタイプは "ZValue "で、各セクションの名前はファイル内の画像のZ値で、0から順に番号が付けられている。

2) 一連の単一画像TIFFファイルをMRCファイルと同様に扱うための情報を提供する".idoc "ファイル。ここでのセクションタイプは "Image "で、各セクションの名称はTIFFファイルの名称である。

グローバルデータは、MRCファイルのヘッダーにある情報の一部を複製したものである。
また、MRCファイルのタイトルは "T "型のセクションヘッダに格納されます。

SerialEMが使用するIMODライブラリは、HDFファイルのメタデータにアクセスするために同じ内部オートドック構造を使用する。
したがって、これらのメタデータ情報をすべてautodoc形式のテキストファイルに抽出することは、次のようなコマンドで簡単にできる。

extracttilts -attr filename.hdf filename.hdf.mdoc

のようなコマンドで、これらのメタデータ情報をオートドック形式のテキストファイルに抽出することができる。

=== Global Data ===
{| class="wikitable"
|+Global Data
|-
|DataMode ||MRC file mode
|-
|ImageSize ||X and Y size of images
|-
|Montage ||1 if the file is a montage
|-
|ImageSeries ||1 for an .idoc file describing a series of single-image files
|-
|ImageFile ||In a .mdoc file, contains the name of the image file
|-
|PixelSpacing ||Pixel spacing in Angstroms that would be in MRC header (or in 1/Angstroms for diffraction images)
|}

=== Section Data ===
{| class="wikitable"
|+Section Data
|-
|TiltAngle ||Tilt angle in degrees
|-
|PieceCoordinates ||Pixel coordinates in X and Y and section Z value for montage piece
|-
|StagePosition ||X and Y stage position in microns
|-
|StageZ ||Z stage position in microns
|-
|Magnification ||"Film" magnification value
|-
|CameraLength ||Camera length in mm for image in diffraction mode
|-
|MagIndex ||Magnification index
|-
|Intensity ||Raw intensity value between 0 and 1
|-
|SuperMontCoords ||X and Y pixel coordinates of frame in a supermontage
|-
|PixelSpacing ||Pixel spacing in Angstroms for individual image (or in 1/Angstroms for diffraction image)
|-
|ExposureDose ||Dose on specimen during camera exposure in electrons/sq. A
|-
|DoseRate ||Dose rate to the camera, in electrons per physical pixel per second
|-
|SpotSize ||Microscope spot size
|-
|Defocus ||Relative defocus readout from microscope (microns)
|-
|TargetDefocus ||Current target for autofocus (microns)
|-
|ImageShift ||X and Y image shift in basic units (close to microns)
|-
|RotationAngle ||Rotation of image from having tilt axis along X axis (CCW +)
|-
|ExposureTime ||Image exposure time
|-
|Binning ||Image binning on the camera
|-
|UsingCDS ||1 if image was taken with CDS mode on
|-
|CameraIndex ||Index of the CameraProperties section for the camera used
|-
|DividedBy2 ||1 if image was divided by 2
|-
|RotationAndFlip ||RotationAndFlip property of K2 or K3 camera
|-
|LowDoseConSet ||Control set index plus 1 if image taken in Low Dose, or negative of index if not in Low Dose (index 0-6 for View, Focus, Trial, Record, Preview, Search, Mont-map; 7 for tracking, 8 for montage)
|-
|MinMaxMean ||Minimum, maximum, and mean value for this image
|-
|PriorRecordDose ||For an image in a tilt series taken in Low Dose mode, the cumulative dose in the Record area prior to this image, including Record and Preview images and View i||mages taken in tasks
|-
|XedgeDxy ||Edge displacement in X and Y for montage piece to the right of this piece
|-
|YedgeDxy ||Edge displacement in X and Y for piece above this piece
|-
|XedgeDxyVS ||Edge displacement for piece to right, computed with very sloppy option
|-
|YedgeDxyVS ||Edge displacement for piece above, computed with very sloppy option
|-
|StageOffsets ||When aligning montage pieces with image shift, this is the effective stage position (actual position plus the stage equivalent to the image shift adjustment) |minus the nominal stage position of the piece.
|-
|AlignedPieceCoords ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option off.
|-
|AlignedPieceCoordsVS ||Piece coordinates adjusted by the solved shifts for each piece when pieces are aligned in overview with 'Very sloppy' option on.
|-
|SubFramePath ||Directory or file in which subframes of exposure were stored
|-
|NumSubFrames ||Number of subframes stored
|-
|FrameDosesAndNumbers ||Dose per frame in electrons per square Angstrom followed by number of frames at that dose; variable-sized frame sums will have multiple pairs of such values
|-
|DateTime ||Time and date of image acquisition; the format of the date is dd-Mon-yy regardless of locale.
|-
|NavigatorLabel ||Label of Navigator item, added if Acquire at Items is being run and a tilt series is not
|-
|FilterSlitAndLoss ||Energy filter slit width and energy loss if slit is in, 0 0 otherwise
|-
|ChannelName ||Detector name for a STEM image
|-
|MultishotHoleAndPosition ||Hole identifier and position within hole when taking multiple record images; peripheral positions are numbered from 1 and the center is numbered 0. For a regular pattern, hole identifiers are a pair of numbers relative to the center of the pattern; for a custom pattern, they are simply numbers starting at 1.
|-
|CameraPixelSize ||For diffraction image, the size of the image pixel on the camera in microns, namely the physical chip pixel size times the binning.
|-
|Voltage ||High voltage in kV for diffraction image.
|}

=== Direct Electron Specific Section Data ===
{| class="wikitable"
|+
Direct Electron Specific Section Data
|-
|DE12-ServerSoftwareVersion ||Server software version
|-
|DE12-PreexposureTime(s) ||Pre-exposure time
|-
|DE12-TotalNumberOfFrames ||Total number of frames in acquisition
|-
|DE12-FramesPerSecond ||Frame rate in frames per second
|-
DE12-CameraPosition ||Whether camera was retracted or inserted
|-
DE12-ProtectionCoverMode ||Whether protection cover is kept open or open and closed for this shot
|-
DE12-ProtectionCoverOpenDelay(ms) ||Delay after opening prtection cover
|-
DE12-TemperatureDetector(C) ||Detector temperature
|-
DE12-FaradayPlatePeakReading(pA/cm2) ||Current reading from Faraday plate during exposure
|-
|DE12-SensorModuleSerialNumber ||Serial number of sensor
|-
|DE12-SensorReadoutDelay(ms) ||Delay before starting to read out sensor during exposure
|-
|DE12-IgnoredFramesInSummedImage ||Number of frames ignored in a summed image
|}

=== Additional Data in MontSection ===
{| class="wikitable"
|+
|Additional Data in MontSection
|-
|FullMontSize ||Full size of montage in X and Y if all pieces are present
|-
|BufISXY ||Image shift associated with overview buffer
|-
|ProbeMode ||1 for microporbe, 0 for nanoprobe
|-
|MoveStage ||1 if for a stage montage
|-
|ConSetUsed ||Control set used for the montage (0 = View, 3 = Record, 5 = Search, 6 = MontMap
|-
|MontBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center
|-
|ValidBacklash ||The nominal backlash for this montage, or 0 0 if using an anchor at the center or doing a zigzag pattern
|-
|DriftSettling ||Drift settling in control set used
|-
|CameraModes ||Shutter mode and read mode
|-
|FocusOffset ||Focus offset for low dose View or Search, assigned to map item DefocusOffset if a map is made
|-
|NetViewShifts ||Image shift offsets for low dose View or Search
|-
|ViewBeamShifts ||Beam shift offsets for low dose View or Search
|-
|ViewBeamTilts ||Incremental beam tilts for low dose View or Search
|-
|ViewDefocus ||Focus offset for low dose View or Search, assigned to image buffer when reading in
|-
|Alpha ||Alpha value on JEOL
|-
|FilterState ||0/1 if slit is out/in, and slit width
|}

== Navigator File for serialEM ==

SerialEM Navigator　Fileに関する説明になります。

下記の翻訳に　なります。
[[https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator https://bio3d.colorado.edu/SerialEM/stableHlp/html/about_formats.htm#navigator ]]

SerialEM 3.6では、Navigatorの出力が1項目につき1行のタブ区切り形式からオートドック形式に変更され、代わりにXMLとして出力するオプションが追加されている。
XMLやautodocファイルは、以前のバージョンのタブ区切りファイルと同様に、読み挙げることができる。

グローバル・データは2行あります。

AdocVersion = x.xx
LastSavedAs = xy.nav

という2行のグローバルデータがあり、2行目は最後に保存したときのファイルの完全な絶対パスとファイル名である。

次に、各項目は'Item'タイプのセクションにあり、そのラベル文字列を値として持つ。

次の表は、セクションに出現するすべてのキー、期待される値の種類、それが必須かどうか、必須でない場合はどのようなデフォルト値が設定されるかを示したものである。

=== Navigation File Section Data===
{| class="wikitable"
|-
!Key !!Type of value !!Default value, or Required !!CMapDrawItem member(s) !!Description
|-
|Color ||Integer ||Req ||mColor ||Color index (0-5)
|-
|StageXYZ ||Three Floats ||Req (unless external) ||mStageX/Y/Z ||Stage position adjusted for current mag
|-
|NumPts ||Integer ||Req ||mNumPoints ||Number of points
|-
|Corner ||Integer ||0 ||mCorner ||Flag for corner point
|-
|Draw ||Integer ||1 ||mDraw ||Flag to draw
|-
|RegPt ||Integer ||0 ||mRegPoint ||Registration point number
|-
|Regis ||Integer ||Req ||mRegistration ||Registration at which item exists
|-
|Type ||Integer ||Req ||mType ||Type: 0-2 for point, polygon, map
|-
|Note ||String ||blank ||mNote ||Note string
|-
|GroupID ||Integer ||0 ||mGroupID ||ID of group thatitem belongs to
|-
|PolyID ||Integer ||0 ||mPolygonID ||ID of polygon used to define supermontage
|-
|FitToPolygonID ||Integer ||0 ||mFitToPolygonID ID of polygon that this montage map was fit to
|-
|Imported ||Integer ||0 ||mImported ||Indicator of an imported map or point drawn on one
|-
|RegisteredToID ||Integer ||0 ||mRegisteredToID ||For an imported map, ID of map that it was registered to for transforming
|-
|SuperMontXY ||Two Integers ||-1,-1 ||SuperMontX/Y ||Camera coordinate of a montage in supermontage
|-
|OrigReg ||Integer ||Regis ||mOriginalReg ||Original registration (default is Registration)
|-
|DrawnID ||Integer ||0 ||mDrawnOnMapID ||ID of map point/polygon was drawn on
|-
|BklshXY ||Two Floats ||0,0 ||mBacklashX/Y ||Backlash when a montage was taken or associated with item
|-
|SamePosId ||Integer ||0 ||mAtSamePosID ||Items with this matching were taken at same raw stage position
|-
|RawStageXY ||T|wo Floats ||-10000,-10000 ||mRawStageX/Y ||Raw stage position before adjustments
|-
|Acquire ||Integer ||0 ||mAcquire ||Flag for acquiring
|-
|PieceOn ||Integer ||-1 ||mPieceDrawnOn ||Index of montage piece item was drawn on (piece_#_in_X * #_of_pieces_in_Y + piece_#_in_Y), or index of nearest piece if item is on a missing piece, in which case XYinPc will not be written to file.
|-
|XYinPc ||Two Floats ||-1,-1 ||mX/YinPiece ||X,Y coordinates in the montage piece, in right-handed pixels of stored montage
|-
|MapFile ||String ||Req if Map ||mMapFile ||Full or relative path of map file (see Read & Open)
|-
|MapID ||Integer ||Req if Map ||mMapID ||Unique ID (all items get one, not just maps)
|-
|FocusAxisPos Float ||-1.e8 ||mFocusAxisPos ||Stored position of Focus area on inter-area axis
|-
|LDAxisAngle ||Two integers ||0,0 ||mRotateFocusAxis, mFocusAxisAngle ||First value: 1 to rotate inter-area axis from tilt axis, 0 not to; second value: angle of rotation
|-
|FocusOffsets ||Two Floats ||0,0 ||mFocusX/Yoffset ||Offset of focus subarea in X and Y in unbinned pixels (Y inverted)
|-
|HoleArray ||Two integers ||0,0 ||mNumX/Yholes ||# of positions in X and Y for multiple Record
|-
|SkipHoles ||List of integers ||none ||mSkipHolePos ||Pairs of X,Y indexes for positions to skip from that array specified in HoleArray. Positions are numbered from 0 at lower-left in stage coordinates
|-
TSstartEndAngles ||Two Floats ||-1.e8,-1.e8 mTSstartAngle, mTSendAngle Starting and ending angles of range for tilt series item
|-
TSbidirAngle ||Float ||-1.e8 ||mTSbidirAngle ||Bidirectional starting angle for tilt series item
|-
|TargetDefocus ||Float ||-1.e8 ||mTargetDefocus ||Target defocus for Acquire or tilt series item
|-
|FileToOpen ||String ||none ||mFileToOpen ||Name of file to open for Acquire or tilt series item
|-
|TSParamIndex ||Integer ||-1 ||mTSParamIndex ||Index of into parameter array for tilt series
|-
|MontParamIndex ||Integer ||-1 ||mMontParamIndex ||Index into array of parameters for montages to open
|-
|FilePropIndex ||Integer ||-1 ||mFilePropIndex ||Index into array of file options for file to open
|-
|MapMontage ||Integer ||Req if Map ||mMapMontage ||Flag that map is a montage
|-
|MapSection ||Integer ||Req if Map ||mMapSection ||Section number in file
|-
||MapBinning ||Integer ||Req if Map ||mMapBinning ||Binning at which map was taken, or of initial overview map image for montage
|-
||MapMagInd ||Integer ||Req if Map ||mMapMagInd ||Magnification index of map, or of non-map image a point or polygon was drawn on
|-
||MapCamera ||Integer ||Req if Map ||mMapCamera Camera index
|-
|MapScaleMat ||Four Floats ||Req if Map ||mMapScaleMat ||Stage to pixel scale matrix for drawing, based on pixels of initial map image. For
montage, needs to be adjusted by ratio of currently loaded map width/height to initial map width/height
|-
|MapWidthHeight ||Two Integers ||Req if Map mMapWidth/Height ||Size of initial map image at which scale matrix was defined
|-
|MapMinMaxScale ||Two Floats ||0,0 ||mMapMin/MaxScale ||Min and max scale values of image when map was defined
|-
|MapFramesXY ||Two Integers ||0,0 ||mMapFramesX/Y|| Number of montage frames when acquired
|-
|MontBinning ||Integer ||0 ||mMontBinning ||Actual binning of montage used to make the map
|-
|MapExposure ||Float ||0. ||mMapExposure ||Exposure time for original map images
|-
|MapSettling ||Float ||0. ||mMapSettling ||Drift settling
|-
|ShutterMode ||Integer ||-1 mShutterMode ||Shutter mode
|-
|K2ReadMode ||Integer ||0 mK2ReadMode ||Read mode for K2/K3 camera
|-
|MapSpotSize ||Integer ||0 ||mMapSpotSize ||Spot size at which map was taken
|-
|MapIntensity ||Double ||0 ||mMapIntensity ||Intensity at which map was taken
|-
|MapSlitIn ||Integer ||0 ||mMapSlitIn ||Filter slit state when map was taken
|-
|MapSlitWidth ||Float ||-1. ||mMapSlitWidth ||Filter slit width when map was taken
|-
|RotOnLoad ||Integer ||0 ||mRotOnLoad ||Flag to rotate when load
|-
|RealignedID ||Integer ||0 ||mRealignedID ||ID of lower mag map with nearby realign error
|-
|RealignErrXY ||Two Floats ||0,0 ||mRealignErrX/Y ||Final stage error of that realign operation
|-
LocalErrXY ||Two Floats ||0,0 ||mLocalRealiErrX/Y ||Error in second round of realign operation
|-
|RealignReg ||Integer 0 ||mRealignReg ||Original registration of that realign
|-
|ImageType ||Integer ||0 ||mImageType ||Map file type 0-3 for MRC, IMOD, TIFF, IDOC
|-
|MontUseStage ||Integer ||-1 ||mMontUseStage ||1 if montage was taken with stage, 0 if not, -1 if unknown
|-
|DefocusOffset ||Float ||0. ||mDefocusOffset ||Defocus offset for map based on View images
|-
|K2ReadMode ||Integer ||0 ||mK2ReadMode ||Read mode for K2/K3 camera
|-
NetViewShiftXY ||Two Floats ||0,0 ||mNetViewShiftX/Y ||Net IS offset for a View image map
|-
MapAlpha ||Integer ||-999 ||mMapAlpha ||JEOL alpha value
|-
ViewBeamShiftXY ||Two ||Floats ||0,0 ||mViewBeamShiftX/Y ||Incremental beam shift to apply for a View map
|-
ViewBeamTiltXY ||Two ||Floats ||0,0 ||mViewBeamTiltX/Y ||Incremental beam tilt to apply for a View map
|-
M|apProbeMode ||Integer ||-1 ||mMapProbeMode ||Probe mode (0 for nano, 1 for micro)
|-
||MapLDConSet ||Integer ||-1 ||mMapLowDoseConSet ||Set # (0-4) used for map taken in low dose
|-
|MapTiltAngle ||Float ||-10000. ||mMapTiltAngle ||Tilt angle at which map was taken
|-
|PtsX ||NumPts Floats ||Req ||mPtX ||X stage cordinates of points
|-
|PtsY ||NumPts Floats ||Req ||mPtY ||Y stage cordinates of points
|-
|UserValueN ||String ||none ||mUserValueMap ||Arbitrary value set by script; N is # (currently1-8)
|-
|colspan="5"|BaseMarkerShift - a section containing a stored shift from Shift to Marker (names are from BaseMarkerShift structure).
|-
|FromMag ||Integer || ||fromMagInd ||Mag index of map item was marked on
|-
|ToMag ||Integer || ||toMagInd ||Mag index of image with marker point
|-
|ShiftX ||Float || ||shiftX ||X component of shift in microns
|-
|ShiftY ||Float || ||shiftY ||Y component of shift in microns
|-
|colspan="5"|T|SParam - a section containing tilt series parameters. See TiltSeriesParam.h in the source code for a description of each item.
|-
|colspan="5"|MontParam - a section containg montage parameters. See MontageParam.h in the source code for a description of each item.
|-
|colspan="5"|FileOptions - a section containing properties for opening a file. See FileOptions.h in the source code in case this has descriptions.
|}

== 外部で定義されたNavigatorアイテムのインポート ==

map上の画像座標で位置を指定したアイテムをNavigatorファイルに追加し、SerialEMにステージ座標への変換をさせることができる。
StageXYZエントリーの代わりに、アイテムは以下のいずれかのエントリーを持つことができる。

# CoordsInMap - マップ画像内のピクセル座標で、1フレーム画像でも、ピースの定常空間でのモンタージュでも、公称のピース座標でもかまわない。
# CoordsInAliMont - モンタージュマップ内のピクセル座標．ここで，ピースは Very Sloppy オプションを使わずに整列される．つまり， .mdoc ファイル内の AlignedPieceCoords で指定された座標に配置される。
# CoordsInAliMontVS - モンタージュマップにおいて、Very Sloppyオプションでピースが整列されたときのピクセル座標、つまり、AlignedPieceCoordsVSで指定された座標に配置されたものである。
# CoordsInPiece - モンタージュの1つのピース内のピクセル座標で、 PieceOn エントリで指定する必要がある。すなわち，piece index = piece_#_in_X * _of_pieces_in_Y + piece_#_in_Y で，すべて0から番号が振られる．

以下の点は、外部定義項目にも適用される。

# 1つのアイテムには、4つのエントリまたはStageXYZのうち1つだけを入力することができる。
# 各項目は3つの数字を取り、3番目はステージZ座標で、これはそのまま使用される。
# アイテムは、Navigatorファイルで外部アイテムの前に表示されるマップを指定するDrawnIDエントリを持っているか、外部定義アイテムだけを含むファイルでマージされたNavigatorテーブル内に既に存在する必要がある。
# ピクセル座標は、マップの左下を0,0とする右手系である。
# モンタージュのオーバービュー画像は、常にXのサイズを4の倍数に切り上げて表示されます。
# CoordsInAliMont または CoordsInAliMontVS では、マップファイルには、それぞれ AlignedPieceCoords または AlignedPieceCoordsVS エントリを持つ mdoc ファイルが必要です。
# 点またはポリゴンのいずれかを外部から入力することができる。
# PtsXとPtsYで与えられる点の座標もピクセル座標でなければならず、メインアイテムのステージ位置と同じように変換される。
# PtsXとPtsZの点座標は、NumPtsの項目が0である点項目については任意であり、ない場合はメインステージの座標と同じにされます。
# 各アイテムには、前述の項目に加えて、Color、Regis、Typeの項目が必要です。
# 外部で定義されたアイテムがMapIDを持っていない場合、ユニークなIDが割り当てられます。 IDを割り当てる場合、マップアイテムのIDとは重複しないようにすることが重要です。最も簡単な方法は、100000以下のIDを割り当てることです。現在、プログラムは100000を超えるIDを生成するからです。
# グループIDがない場合は、割り当てられません。

Navigatorファイルから正常に読み込まれた項目については、詳細なエラーレポートが用意されています。項目処理時のエラーの種類はログにまとめられ、Debug Outputが'n'に設定されている場合は、各項目についてエラーの種類がラベルで識別され報告されます。ただし、必須項目がない、またはオートドックからデータを読み取る際にエラー（1行の値が少なすぎるなど）が発生したため、項目が最初に拒否された場合は詳細が表示されない。

== 設定ファイルおよびキャリブレーションファイルの入力 ==

このセクションは、設定ファイルまたはキャリブレーションファイルへの長いエントリを解釈する必要がある場合です。この項目は、必要に応じて追加されます。すべてのアルファ値は0から始まり、1ではありません。

=== 設定ファイルのエントリ ===

==== LowDoseParameters（低電子線量パラメータ）: ====
LowDoseParameters: V F T R S の低線量セット番号0から4、または状態番号（1からの番号）の負値。
mag インデックス、またはカメラ長インデックスの負値
スポットサイズ
強度
軸オフセット(ミクロン)
通常/EFTEM/STEMの場合は0-2、ステートの場合は0
フィルタースリット
フィルタースリット幅
エネルギー損失
ゼロロスフラグ
ビームX&Yオフセット
日本電子ではα、それ以外は-99
回折フォーカス
ビームチルトX & Y
プローブモード
ダークフィールドモードフラグ
ダークフィールドチルト X & Y

====AutocenterParams:====

カメラ
マグ指数
スポットサイズ
強度
ビニング
露出
セントロイドを使用する場合は1
プローブモード
1：センタリング用にビームをシフトする
ビームシフト量（単位：ミクロン
Xビームシフトを追加
Yビームシフトを追加

==== MultishotParams: ====

表示用ビーム径
メインリングのオフセンターショットまでの距離
メインリングのショット数
センターショットを行う。-1（前）、0（なし）、1（後
アーリーリターン最後尾のみ1、全て2、最初で全部で3
アーリーリターンのフレーム数
記録ショットを保存するかどうか
画像シフト後の追加遅延
照明された領域を直径の描画に使用するかどうか
ビームチルトを調整するかどうか（可能な場合
1はホール内パターン、2はマルチホール、3はその両方
カスタムホールのリストを使用する
穴と穴の間のIS遅延を増加させるファクター
イメージシフトベクトルのX成分(X方向)
X方向の画像シフトベクトルのY成分
画像シフトベクトルのX成分（Y方向
画像シフトベクトルのY成分（Y方向
X方向の穴の数
Y方向の穴の数
レギュラーパターンの穴位置が測定されたときの倍率
カスタムホールを定義するマグ
クロスパターンが3x3のときに撮影
2番目のリングのショットを行う
2つ目のリングのショット数
セカンドリングのオフセンターショットまでの距離
レギュラーパターンを定義したときのチルト角
カスタムホールを定義する際のチルト角
レギュラーアレイに関連するホールファインダーで検出された角度

=== キャリブレーションファイルのエントリ ===

==== StandardLMFocus: このエントリは、LMで記録された標準フォーカスを含む、または真心フォーカスが非LMである。 ====
倍率インデックス
マイクロプローブでのフォーカス値、ない場合は-999
ナノプローブでのフォーカス値、ない場合は-999
倍率
フォーカス値は、0～1の絶対値か、日本電子の場合、粗焦点と微焦点の成分をエンコードした大きな値

==== FocusCalibration: ====
magインデックス
カメラ番号
X方向の傾き
Y方向の傾き
ビームチルト
ポイント数
方向インデックス
プローブモード
アルファ
倍率

==== SpotIntensities: ====
ナノプローブ、マイクロプローブのどちらかが、クロスオーバーより下とクロスオーバーより上の2つのキャリブレーションを行っている場合、2つのテーブルが存在する場合があります。ただし、1つのテーブルで、1つの条件がクロスオーバーより下で行われ、もう1つの条件がクロスオーバーより上で行われることがあります。内部的にはすべて別々のテーブルに分類されます。各行の内容は以下の通りです。
スポットサイズ
マイクロプローブの強度比、取得強度、クロスオーバー強度
ナノプローブの強度比、取得した強度、クロスオーバー強度

ここで、比率が0の場合は、そのスポットサイズでの測定がないことを示す。

==== BeamShiftCalibration（ビームシフトキャリブレーション） ====
このキャリブレーションは、指定された倍率での画像シフトからビームシフトへの2x2変換行列である。
magインデックス
画像シフトのX変化量に対するビームシフトのX変化量
画像シフトのY変化に対するビームシフトのX変化
画像シフトのX変化量に対するビームシフトのY変化量
画像シフトのY変化量に対するビームシフトのY変化量
α
プローブモード
同じマグレンジとビーム条件で新たにキャリブレーションを行う場合、キャリブレーションを保持する場合は1、保持しない場合は0。
倍率

==== HighFocusMagCal: ===
スポットサイズ
プローブモード
強度
デフォーカス
マグチェンジ
ローテーション
クロスオーバー
アパーチャサイズ

==== ステージキャリブレーションと2x2変換行列 ====
ステージキャリブレーションは4つの行列項からなり、他の2x2変換行列と同様に、X入力値の変化に対する出力X値の変化（xpx）、Yの変化に対するX値の変化（xpy）、Xの変化に対するY値の変化（ypyx）、Yの変化に対するY値の変化（ypy）として表現される。この順序でファイルに書き込まれる。この場合、入力値はステージ位置の変化量（ミクロン）であり、出力値は画像の移動量（アンビンジングピクセル）の負値、つまり元の中心に対する新しい中心座標の画像上の位置である。この負の値は、Xをチルト軸に沿わせた基礎となる「標本」座標系に対して、典型的なステージ座標系を反転させるという点で不運なものである。

StageCalibrationの行には
マグ指数
カメラ番号
xpx
xpy
ypx
ypy
キャリブレーションを行った絶対焦点（日本電子の場合、粗動と微動の合成値）
倍率

== その他 ==

=== 画像の回転 ===

標本座標系は、X軸を正のチルト軸とする右手系である。 (正のチルト軸を原点とし、正のチルトでステージを反時計回りに回転させる）。画像の回転は、カメラ画像が試料面における画像からCCW回転した量、すなわち画像の正のX軸から画像内の正のチルト軸までの角度（CCW正）と定義される。

カメラが1台しかなく、較正された絶対回転を持つ RotationAndPixel 行がない場合、ある倍率での回転は、MagnificationTable のそのマグの回転値、GlobalExtraRotation、そのカメラの ExtraRotation の合計である予備値から推定される。テーブル内に相対回転がある場合、フォールバックは絶対回転として1つのマグに割り当てられ、これにより他のマグに対して回転を導き出すことができます。これは、フォールバック角度がどのマグに適用されるべきかを知る方法がないため、あいまいな状況です。

いったん較正された絶対角度があると、MagnificationTable 回転、GlobalExtraRotation、および ExtraRotation は、RotationAndPixel テーブルにリストされている、絶対回転で mag に相対回転でリンクされているすべての mag に対して無関係になります。ある mag の相対回転は、その mag の回転角から次に低い mag の回転を引いたものに等しくなります; この関係により、回転角が較正された絶対角で mag から外側に伝搬されることが可能になります。これらのマグにイメージシフトの較正がある場合、そのマグ範囲内の試料ではイメージシフトが不変であると仮定することにより、イメージシフトの較正がある同じマグ範囲の他のマグにも回転を割り当てることができる。 Thermo/FEIのスコープではLMとnonLM、JEOLのスコープではPLAを使用し、回転が伝達されない境界があります。MagnificationTable の回転は、これらのメカニズムのいずれかによって回転が割り当てられていない他のマグに対する予備的な役割を保持します。そのようなマグの回転は、問題のマグの MagnificationTable 回転と近くのマグの回転の差を追加することによって、回転が割り当てられた一番近いマグから得られます。

同じレベルに複数のカメラがある場合、つまり、複数の非エネルギーフィルターカメラまたは複数のエネルギーフィルターカメラがあり、一方が較正された絶対角度を欠いている場合、状況はさらに複雑になります。プログラムは、可能であれば画像シフト較正を使用して、別のカメラから絶対角度を取得します。ここで説明するすべての割り当ては、DebugOutput を 'c' に設定してプログラムを起動したときに表示されます。 ShiftManager::PropagateRotations()も参照してください。

画像の回転値は、ステージのキャリブレーションと密接に関係しています。 Thermo/FEI scope や JEOL scope のオメガフィルターなしの場合、画像回転を 0 にすると次のような画像移動パターンになる。

正のYステージの移動に対する画像の移動
|
|
|
|
---------> Xステージの正の移動に対する画像の移動
イメージ回転角は、イメージ移動の軸がこのパターンに対して反時計回りに回転される量です。画像回転（と傾斜軸角度）は、atan2(-ypx, -xpx) (X軸回転から) または atan2(-ypy, -xpy) - 90 ( Y軸回転から) に等しいはずで、プログラムは、ステージキャリブレーションで回転角度を報告するときにこれらの二つの推定値を平均化する。オメガフィルター付きの日本電子の場合、このようなパターンになります。
正のYステージ移動のための画像移動
|
|
|
|
<--------- 正のXステージ移動のための画像移動
X軸を反転させるので、プロパティInvertStageXAxisを設定する必要があります。この場合、画像の回転は atan2(ypx, xpx) と atan2(-ypy, -xpy) - 90 から推定されます。これらの推定値は単に報告されるだけで、プログラムによって直接使用されることはありません。何らかの効果を得るには、RotationAndPixel 行に配置する必要があります。

File Formats and Other Documentation

2022-12-30T06:00:42Z

Tacyas: /* Navigation File Section Data */

File Formats and Other Documentation

2022-12-30T05:45:19Z

Tacyas: /* Navigation File Section Data */

File Formats and Other Documentation

2022-12-30T05:44:22Z

Tacyas: /* Navigation File Section Data */

File Formats and Other Documentation

2022-12-30T05:43:27Z

Tacyas: /* Navigation File Section Data */

File Formats and Other Documentation

2022-12-30T05:41:38Z

Tacyas: /* Navigation File Section Data */

File Formats and Other Documentation

2022-12-30T05:40:21Z

Tacyas: /* Navigator File for serialEM */

File Formats and Other Documentation

2022-12-30T05:35:39Z

Tacyas: /* Navigator File for serialEM */

File Formats and Other Documentation

2022-12-30T05:35:18Z

Tacyas: /* = Section Data */

File Formats and Other Documentation

2022-12-30T05:33:53Z

Tacyas: /* Navigator File for serialEM */

File Formats and Other Documentation

2022-12-30T05:32:30Z

Tacyas: /* Image Metadata Files */

File Formats and Other Documentation

2022-12-30T05:30:20Z

Tacyas: /* Image Metadata Files */

File Formats and Other Documentation

2022-12-30T05:27:16Z

Tacyas: /* Image Metadata Files */

File Formats and Other Documentation

2022-12-30T05:19:33Z

Tacyas: /* Image Metadata Files */

File Formats and Other Documentation

2022-12-30T05:14:26Z

Tacyas: /* Image Metadata Files */

File Formats and Other Documentation

2022-12-30T05:09:55Z

Tacyas: /* Image Metadata Files */

File Formats and Other Documentation

2022-12-30T05:08:59Z

Tacyas: /* Navigator File for serialEM */

File Formats and Other Documentation

2022-12-30T05:07:19Z

Tacyas: /* Navigator File for serialEM */

File Formats and Other Documentation

2022-12-30T05:06:28Z

Tacyas: /* Image Metadata Files */