この記事では、ZOS-API で解析を実行するために使用するコマンドと、解析後に意味のある方法で結果を抽出する方法を示します。
著者 Alexandra Culler
OpticStudio には、プログラミング タブ にZOS-API の広範なヘルプドキュメントが含まれています。
そのドキュメント内で、すべての解析用列挙型は、ZOSAPI.Analysis の名前空間リファレンスで参照することができます。
特定の解析を実行するために使用できるその解析固有のメソッドがありますが、一般的なメソッドNew_Analysis()を使用して、任意の解析タイプを開くこともできます。このメソッドには、入力として解析用列挙型が必要です。適切な列挙型が見つかったら、以下の様に適応することで解析を実行できます。
my_analysis = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.ANALYSIS_ENUMERATOR_HERE);
以上の様に解析の設定を開くと、一般的に解析の設定を調整できる方法は2つあります。1つ目は、一般的に使用される一部の解析には、その解析に固有の設定インターフェイスが用意されています。 例はIAS_FftMtf です。すべての解析設定インターフェイスは、ZOSAPI.Analysis.Settings の名前空間にあります。HasAnalysisSpecificSettings プロパティを使用すれば、解析に設定インターフェイスがあるかどうか確認できます。
my_analysis.HasAnalysisSpecificSettings
コマンドが「0」を返した場合、その解析には完全に実装された設定インターフェイスがないことを示しています。この場合、解析設定をZOS-API を介して編集することはできませんが、解析の設定ファイル( .cfg ファイル)を直接変更するIAS_ModifySettings コマンドを使用して書き換えるという、2番目のオプションを使用して設定の変更する必要があります。
ModifySettings コマンドは、ZPL のMODIFYSETTINGS キーワードと非常によく似た働きをします。解析を開いて設定を調整したら、解析を再実行して結果を取得する必要があります。これは、次のコマンドを使用して実行できます。
my_analysis.ApplyAndWaitForCompletion()
my_analysis.GetResults()
ModifySettings()が使用された場合は、LoadFrom()への呼び出しも必要になります(完全なデモについては、ZOS-API 構文のサンプルファイル 11 を参照してください)。GetResults()メソッドによって返されるオブジェクトに関しては、解析関数には次のタイプの結果が1つ以上含まれている場合があります。
GetResults()を使用すると、考えられるすべてのパブリック メンバー の関数がリストされたオブジェクトが返されますが、解析に対応するものだけが入力できます。解析に使用できるデータタイプが不明で、事前に知りたい場合は、ナレッジベースの記事「ZOS-API での各解析の出力データタイプのリストの生成」をご覧ください。
テキスト出力をサポートする解析タイプの場合、GetTextFile()コマンドを使用して、ユーザーがデータを保存して手動で解析できるようにすることもできます。
ZOS-API の詳細については、ナレッジベースの記事「ZOS-API .NET:An Overview」(英語版)を参照してください。
また、ZOS-API Syntax ヘルプにはZOS-API を使用してシステムの解析を実行する方法を示すサンプル ファイル も含まれています。
たとえば、サンプルコード 11 および15 は、IAS_ModifySettings を使用して解析の設定を変更する例になります。
- サンプルコード11 ではユニバーサル プロット の設定を変更しています。
- サンプルコード15 ではシェーデット モデル の設定を変更しています。
サンプルコード10 および24 では完全に光線データとして変換した後のデータに対する解析の設定の例です。
サンプルコードに対するより詳しい情報については「Sample code for ZOS-API users 」(英語版)の記事を参照してください。
KA-01899
コメント
記事コメントは受け付けていません。