This help topic discusses the actions that can be performed on Analysis Results Nodes (ARNs) using the GUI. For an overview of ARNs, please refer to the Analysis Results help topic.
Each ARN is assigned a unique node number upon creation, allowing access, manipulation, and display directly from FRED's object tree or the scripting language. Analysis Results Nodes are stored in the Analysis Results folder on the object tree (
•Select the "Create Analysis Results Node (ARN)" checkbox on an analysis dialog in the GUI. A base name for the resulting ARN can be supplied in this dialog as well. •Right mouse click on the Analysis Results folder and select "Create New ARN From a File" from the list menu to open a file browser dialog. Select one or more *.fgd or *.dat files (or use CTRL+A to select all files in the directory) to be imported as ARN. A limit of 5,000 data files may be imported as ARN using this file browser interface. The STOP button in FRED's status bar can be pressed to stop the data import. •Drag and drop one or more FGD or DAT files from a Windows File Explorer folder into a FRED document window. •Auto-generate or generate on request from a detector entity. •Auto-generated by a Directional Analysis Entity as part of a FREDmpc GPU raytrace. •In the scripting language, use the appropriate analysis-to-ARN command (IrradianceToARN, ScalarFieldToARN, etc.). •In the scripting language, use the generic ARN creation commands found in the FRED Commands By Usage help topic.
Analysis Results Nodes are not saved with the FRED document itself. If ARNs are intended to be preserved, they should be saved to file outside of the FRED document. This can be done by right mouse clicking on an ARN and selecting the "Save Data to File" option. The resulting file has an *.fgd extension (FRED Grid Data) and can loaded back into FRED at any point using the corresponding "Create New ARN From a File" command found by right mouse clicking on the Analysis Results folder. The FGD files saved to disk can be easily processed by other data analysis packages.
Exporting ARNs to Image and Video Formats Analysis Results Nodes can optionally be saved to several flavors of image and video files, which can help facilitate data review or reporting outside of FRED. The following rules apply when writing image and video files: •No axes or legend information is included in the export. •The orientation of the exported images matches the displayed image as seen in FRED's chart viewer. No data transposition is applied. •For multi-dimensional data values (complex scalar fields, complex vector fields, color image, etc.), the data quantity exported matches the default quantity displayed in FRED's chart viewer. For example, the exported image for a Scalar Field ARN would be the field energy.
To export an ARN to an image or video file, right mouse click on the selected ARN(s) and choose one of the following export options:
Displaying ARNs in a Chart View 2D Analysis Results Nodes can be displayed in the chart viewer by using one of the following options: •Double click on the ARN in the object tree to display the result in the chart •Right mouse click on the ARN in the object tree and select "Display in Chart"
The following behaviors apply when displaying ARNs in a chart view: •A statistical report for the ARN data will be printed to the output window automatically when either of these chart display options are selected. •If the selected ARN is multi-slice, the displayed data corresponds to the active slice. •When an ARN is displayed in the chart view, the chart style appropriate for its data type will be applied. •If multiple ARNs are selected on the tree at the time the chart display option is called, the resulting chart corresponds the first ARN in the selection.
Displaying ARNs in the 3D View (2D analysis results) 2D Analysis Results Nodes can be displayed directly in the 3D viewer by using one of the options below. This method of displaying ARNs provides the ability to display the data from one or more ARNs directly in the context of your 3D model view, which can be particularly useful for presentations and reports or for understanding the orientation of the data with respect to the model geometry. •Right mouse click on one or more selected ARNs in the object tree and choose the "Display in Visualization View" •Right mouse click on one or more selected ARNs in the object tree and choose the "Cancel Display in Visualization View" to remove the selected ARNs from being displayed in the 3D view
The following behaviors apply when displaying ARNs in the 3D view: •When the visualization view option is selected, the user will be prompted with a dialog containing display options specific to the selected ARN(s) data type. •The 3D view can be auto-focused on one or more ARNs by selecting the ARNs of interest on the object tree, right mouse clicking and selecting "Fit to View" from the context menu. •When multiple ARNs are selected, the Display in Visualization View option will be greyed out unless the selected ARNs are all (a) 2D results or all 3D results, (b) the same data type (ex. Irradiance, Scalar Field, etc.), and (c) the same grid resolution. •Pursuant to the requirements above, calling Display in Visualization view on multiple selected ARNs will display the selected ARNs in the 3D view using the same settings (including the data range color scaling). •The number of pixels that can be displayed as a texture map in the 3D view is limited by the graphics capabilities of each computer. In the event that the texture map display fails, a warning message will be printed in the output window. FRED uses the "Safe" pixel mode setting by default (Preferences) and texture maps up to 1024 x 1024 pixels will typically be properly displayed. Hardware accelerated modes should allow for proper display of texture maps with larger numbers of pixels.
The following controls are available when displaying ARN(s) in the 3D View:
Displaying ARNs in the 3D View (3D analysis results) 3D Analysis Results Nodes can be displayed in the visualization view using its display specific controls.
The data in an Analysis Results Node can be manipulated directly in the GUI by right mouse clicking on an Analysis Results Node and selecting Modify Data from the context menu. If the ARN is multi-slice, then the modification is applied to the active slice. The data manipulations which can be performed are: •Log10 with Relative Floor •Loc10 with Absolute Floor •Perform 2D FFT •Average along A axis •Average along B axis •Linear combination
This section describes the GUI tools available for manipulating and managing multi-slice ARNs.
Combining ARNs into a Multi-Slice ARN A multi-slice ARN can be created from 2 or more existing ARNs by first selecting the ARNs on the tree, right mouse clicking and choosing the Combine Into New Multi-Slice ARN option from the context menu. When the "Keep Selected ARNs" sub-menu option is used, the multi-slice ARN will be created and the original ARNs will be preserved. When the "Delete Selected ARNs" sub-menu option is used, the multi-slice ARN will be created and the original ARNs will be deleted from the Analysis Results folder.
Splitting a Multi-Slice ARN Into Individual ARNs A multi-slice ARN can be split into individual ARNs, with one ARN corresponding to each slice of the multi-slice ARN, by right mouse clicking on the multi-slice ARN and choosing the "Split Multi-Slice ARN Into Single-Slice ARNs". The original multi-slice ARN is preserved on the object tree and may be removed if desired.
Slice Management and Activation The individual slices of a multi-slice ARN can be re-ordered, made the active slice, or deleted from the multi-slice ARN by using the slice manager interface. To access the interface, right mouse click on a multi-slice ARN and choose "Manage Slices" from the context menu. Each row in the listing corresponds to one slice of the ARN and indicates the current index position of each slice in the ARN along with the corresponding slice name. The currently designated active slice is labeled as such in the interface.
By selecting one or more entries in the control, the selected slices can be re-arranged within the multi-slice ARN by using the Move Up and Move Down buttons, or they can be deleted from the multi-slice ARN entirely by using the Delete button. When a single slice is selected, the Set As Active Slice button will become active. Note that the modifications to the individual slices in the slice manager interface will not take effect in the FRED document until the OK or Apply buttons are pressed.
Copying or Moving Slices Between ARNs When two ARNs are selected (either single ARNs or multi-slice ARNs), the Copy/Move Slices option will become active on the context menu when right mouse clicking on the selected ARNs. Selecting this option will open the Copy/Move Slices interface, which allows for slices to be copied or moved between the two selected ARNs. Multiple slices can be selected simultaneously, but the Move option will only be active when at least one slice remains unselected in the interface. The names of the two ARNs are given above the slice listings in each column and the --> and <--- text indicates whether the selected slices on the left hand side will be moved/copied to the right hand side and visa versa. The modifications to the slices in each of the two ARNs will not take effect until the OK button is pressed on the dialog.
Extracting Components From ARN Data Certain analyses, such as Coherent Scalar Field, Coherent Vector Field, and Color Image, produce output data that contain multiple values per cell in the data grid. For example, a Scalar Field calculation performed on a 2D analysis grid contains two values per cell in the analysis grid; the real and imaginary values of the complex field at each position in the grid. From this "raw" data, which is stored in the ARN, various quantities can be computed and extracted from the raw data. Returning to the Scalar Field example, the quantities Energy, Amplitude, Signed Amplitude, and Phase can be derived from the real and imaginary components of the complex field in each cell in the data grid.
If an ARN contains multiple values per cell in the data grid, the "Extract Components to New ARN" option will be active on the context menu when right mouse clicking on an ARN. When selected, each component of the raw data and all derived component quantities will be extracted into a single multi-slice ARN. Each slice of the ARN contains a single-valued 2D grid of data corresponding to the individual raw data components and derived quantities. The multi-slice ARN can be further manipulated by using the multi-slice options available when right mouse clicking on the ARN. For example, the multi-slice ARN can be split into N single 2D ARNs (each individual ARN corresponding to one slice of the original multi-slice ARN) by right mouse clicking on the multi-slice ARN and selecting the "Split Multi-Slice ARN Into Single-Slice ARNs" option.
Note that if multiple ARNs are selected on the tree, the Extract Components to New ARN" will be available as long as all of the selected ARNs have data with multiple values per cell (otherwise the option will be unavailable). In this case, each of the selected ARNs will have their components extracted into corresponding multi-slice ARNs.
When components and associated quantities are extracted from an ARN with multiple values per cell, the association with the original raw data is lost (ex. extracted 2D Phase data is no longer linked to the original complex field data). A consequence of this dissociation is that when the extracted quantity is displayed in a chart window, certain data manipulation operations normally available in the chart context with the original dataset will not be available. If, for example, extracted Phase data is displayed in a chart window, the Decompose Wavefront option will not be available because the wavefront decomposition algorithm requires the underlying complex field data.
The procedure for extracting components and individual quantities from an ARN with multiple values per cell into a set of individual 2D ARNs is shown in the sequence below.
A statistical summary of the data contained in an ARN (total power, average irradiance, min/max values, etc.) can be reported to the output window by right mouse clicking on an ARN and selecting the Statistics Report option from the context menu. If multiple ARNs are selected, the Statistics Report is printed to the output window for each of the selected ARNs. If a selected ARN is multi-slice, the Statistics Report is only printed for the active slice.
The example below is shown for Irradiance but the specific statistical information reported will depend on the type of calculation that the ARN represents.
Note: The statistics data is a duplicate of the information that FRED prints to the output window when you use the GUI to request an analysis. Datasets which include multiple different quantities (ex. scalar field, vector field, etc.), will have statistics report output that corresponds to the quantity that would be shown by the GUI analysis call. For example, when the Scalar Field calculation is called in the GUI, the output window data corresponds to the Field Energy quantity (other quantities available for Scalar Field are amplitude, signed amplitude, real values, imaginary values, phase and wavefront). The statistics report for a Scalar Field type ARN would also report data for the Field Energy quantity.
The ARN Scripting Commands can be found in the FRED Commands by Usage help topic.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
.png)
.png)
.png)
.png)
.png)
.png)
.png)
.png)