Analysis Results Folder

Navigation: Analysis Results

Analysis Results

Page Contents

Description

The Analysis Results folder ( ) on the object tree provides access to Analysis Results Nodes (ARNs), which are the encapsulation of analysis calculations stored as nodes on the object tree. ARNs allow for management, organization and display of calculation results, help facilitate data manipulation, and allow export of the ARN data to a variety of output formats. Additionally, a collection of related ARN scripting commands make customization of calculations and data processing straightforward through the scripting language.

Analysis Results Nodes (ARNs) contain a header structure that logs information such as the calculation type, FRED model that generated the result, data units, data grid resolution, etc. and also allows additional customized information to be added to the header via the scripting language. The header information serves as a record that describes all of the essential information for understanding the context of the associated data array and can be reported by right mouse clicking on an ARN and selecting the Detailed Report option (or by querying header items explicitly using the scripting language).

The most common type of ARN is one that represents a single calculation whose data is computed on a 2D grid, such as an Irradiance or Coherent Scalar Wave Field. The structure of the 2D grid type ARN is shown below, where the ARN contains a set of header information followed by the 2D grid of data values. Note that depending on the type of calculation that was performed, the 2D grid of data may have multiple values per grid cell. For example, an Irradiance calculation has one value per cell, the power/area for that cell, while a Coherent Scalar Wave field has two values per cell, the real and imaginary field components at that cell position.

Multi-slice ARNs

It is also possible to create a multi-slice ARN, which may happen automatically as the result of an analysis such as the Geometric OPD Map, or may be the result of a user request to combine multiple ARNs into a single multi-slice ARN. A multi-slice ARN is simply a layering of multiple 2D ARNs together in a single node on the object tree and is indicated by the icon. The number of slices in an ARN can be found by inspecting the node tooltip (hover your mouse over the graphic icon of the ARN) or by calling the Detailed Report option on the ARN of interest.

A multi-slice ARN is depicted below in which there are three slices. There is only one "active slice" in a multi-slice ARN and data manipulation and display options will operate on the active slice. There is no requirement that the slices of a multi-slice ARN exhibit similarity with regard to calculation type or grid sizes; the user may place any collection of 2D ARNs together into a single multi-slice ARN. Tools for creating, destroying, and manipulating the layers of a multi-slice ARN can be found on the right mouse click context menu of the ARNs.

Why use multi-slice ARNs? A common scenario would be a calculation that produces N results of interest, such as determining the stray light distribution on a focal plane as a function of source illumination angle. Rather than saving each of the N results to N output files on disk, the N results can be combined to a single multi-slice ARN and then written out to disk as a single file. The single output file can be read back into FRED at a later date and "exploded" back into a collection of single ARNs if desired. In this way, multi-slice ARNs can help facilitate the management and organization of calculation results.

3D ARNs

A special 3D ARN may be created as the result of a volumetric analysis performed using the 3D Box Detector Entity.

Navigation

The Analysis Results folder is displayed on the object tree and cannot be deleted.

Controls

The following options are available by right mouse clicking on the Analysis Results folder:

Create New ARN From a File	Selecting this option will open a file browser dialog from which one or more .fgd or .dat files can be selected (use CTRL+A to select all files in a directory). The selected files will be imported into the FRED document as individual Analysis Results Nodes (ARNs).
Delete (all highlighted items)	When called on the Analysis Results Folder, all Analysis Results Nodes (ARNs) are deleted from the document.
Copy Find-Name Command to Clipboard	This option supports interfacing with FRED's scripting language by copying the FindFullName command to the clipboard for use when writing scripts.
Summary Report	Prints summary information to the output window itemizing the node number, ARN type, data type, name and description for each ARN.
Detailed Report	Prints detailed information to the output window for each ARN containing additional details such as number of slices, active slice index, physical meaning, grid shape, grid size, grid location and any additional customized information strings.