{"id":1595,"date":"2016-08-30T10:14:28","date_gmt":"2016-08-30T17:14:28","guid":{"rendered":"https:\/\/live-optics-wp.pantheonsite.io\/milster\/?page_id=1595"},"modified":"2016-09-19T11:02:54","modified_gmt":"2016-09-19T18:02:54","slug":"fields-panel","status":"publish","type":"page","link":"https:\/\/wp.optics.arizona.edu\/milster\/resources\/optiscan-simulation-program\/optiscan-help-desk\/index\/fields-panel\/","title":{"rendered":"Fields Panel"},"content":{"rendered":"<p>The <em>Fields Panel<\/em> allows the user to select the fields which should be saved and restored.<\/p>\n<p>The<em> field matrices<\/em> which are saved\/restored to a file are:<\/p>\n<p><strong>Matrix\u00a0|\u00a0Name Description<\/strong><\/p>\n<ul>\n<li><span style=\"color: #ff0000;\">Ext\u00a0<\/span>|\u00a0Transmitted X field<\/li>\n<li><span style=\"color: #ff0000;\">Eyt<\/span>\u00a0|\u00a0Transmitted Y field<\/li>\n<li><span style=\"color: #ff0000;\">Ezt\u00a0<\/span>|\u00a0Transmitted Z field<\/li>\n<li><span style=\"color: #ff0000;\">Exr\u00a0<\/span>|\u00a0Reflected X field<\/li>\n<li><span style=\"color: #ff0000;\">Eyr\u00a0<\/span>|\u00a0Reflected Y field<\/li>\n<li><span style=\"color: #ff0000;\">Ezr\u00a0<\/span>|\u00a0Reflected Z field<\/li>\n<\/ul>\n<p>Additionally, there are two coordinate vectors:<\/p>\n<p><strong>Vector Name\u00a0|\u00a0Description<\/strong><\/p>\n<ul>\n<li><span style=\"color: #ff0000;\">sysxvec\u00a0<\/span>|\u00a0coordinate vector for the columns.<\/li>\n<li><span style=\"color: #ff0000;\">sysyvec\u00a0<\/span>|\u00a0coordinate vector for the rows.<\/li>\n<\/ul>\n<p><span style=\"color: #0000ff;\"><strong>The Rule:<\/strong><\/span> Each <em>field matrix<\/em> must have the same matrix dimensions.<strong> The Exception:<\/strong> A <em>field matrix<\/em> may be a scalar, such as <strong>0<\/strong>. By using a scalar\u00a0<strong>0<\/strong>, when appropriate, (instead of a <em>n x m<\/em> matrix of zeros) memory is saved and the simulation&#8217;s calculation time is reduced.<\/p>\n<hr \/>\n<h3>Specifying which fields to Save\/Restore:<\/h3>\n<p>The &#8220;Use Which Fields&#8221; portion of the <em>Fields Panel<\/em> allows the user to specify which fields are saved or restored.<\/p>\n<p>If fields are being restored, the file must contain the <em>sysxvec<\/em> and <em>sysyvec<\/em> coordinate vectors. If fields are being saved, then the simulator will save its <em>sysxvec<\/em> and <em>sysyvec<\/em> coordinate vectors along with the specified fields.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-1172\" src=\"http:\/\/wp.optics.arizona.edu\/milster\/wp-content\/uploads\/sites\/48\/2016\/08\/fields_panel.use_which_fields.gif\" alt=\"fields_panel.use_which_fields\" width=\"403\" height=\"199\" data-id=\"1172\" \/>i<\/p>\n<hr \/>\n<h3>Specifying which files to Save\/Restore:<\/h3>\n<p>The &#8220;Use Which File&#8221; portion of the<em> Fields Panel<\/em> allows the user to specify which fields are saved or restored.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-1173\" src=\"http:\/\/wp.optics.arizona.edu\/milster\/wp-content\/uploads\/sites\/48\/2016\/08\/fields_panel.use_which_file.gif\" alt=\"fields_panel.use_which_file\" width=\"611\" height=\"123\" data-id=\"1173\" \/><\/p>\n<p><strong>Path<\/strong> &#8211; Specifies which path the data should be written\/read from.<\/p>\n<p style=\"padding-left: 30px;\">The Save and Restore objects support two special tokens:&lt;project&gt; \u00a0and &lt;userdata&gt;. During the simulation,&lt;project&gt; is replaced with the project&#8217;s root directory and\u00a0&lt;userdata&gt; is replaced with the name of the userdata folder in the project&#8217;s root directory.<\/p>\n<p style=\"padding-left: 30px;\"><em>Optiscan<\/em> asks the user to specify the &lt;userdata&gt;\u00a0 folder just before the simulation begins. At this time, <em>Optiscan<\/em> will create that folder before it starts the simulation.<\/p>\n<p style=\"padding-left: 30px;\">The user may set the <em>Path<\/em> to any desired Path as long as that <em>Path<\/em> exists. Otherwise, the data files cannot be saved or restored. Hence, an error message concerning this will be presented to the user.<\/p>\n<p><strong>File<\/strong> &#8211; <em>Coherent Field Files:<\/em><\/p>\n<p style=\"padding-left: 30px;\">Specifies which file contains the specified <em>field matrices<\/em> (for Restoring) or which file will contain the specified<em> field matrices<\/em> (for Saving).<\/p>\n<p style=\"padding-left: 30px;\">The Save and Restore Fields objects support automatic filename enumeration. For example, the filename:<\/p>\n<p style=\"padding-left: 30px;\"><em>flds.%v.mat\u00a0<\/em><\/p>\n<p style=\"padding-left: 30px;\">will be replaced with:<\/p>\n<p style=\"padding-left: 30px;\"><em>flds1.mat, flds2.mat, flds3.mat,&#8230;<\/em><\/p>\n<p style=\"padding-left: 30px;\">The &#8220;%v&#8221; is replaced with the visit count. The <em>visit count,<\/em> in this case, is the number of times that the field matrices have been saved or restored by the<em> Save<\/em> or<em> Restore Fields<\/em> objects. The &#8220;%v&#8221; may lie anywhere within the filename specification.<\/p>\n<p style=\"padding-left: 30px;\">See: Base Index.<\/p>\n<p><strong>File<\/strong><em> &#8211; Incoherent Field Files:<\/em><\/p>\n<p style=\"padding-left: 30px;\">Specifies which file contains the specified<em> incoherent field matrices<\/em> (for Restoring) or which file will contain the specified <em>field matrices<\/em> (for Saving).<\/p>\n<p style=\"padding-left: 30px;\">The <em>Save<\/em> and <em>Restore Fields<\/em> objects support automatic incoherent filename enumeration. For example, the filename:<\/p>\n<p style=\"padding-left: 30px;\"><em>source_point.%i.mat<\/em><\/p>\n<p style=\"padding-left: 30px;\">will be replaced with:<\/p>\n<p style=\"padding-left: 30px;\"><em>source_point.0.mat, source_point.1.mat, source_point.3.mat,&#8230;<\/em><\/p>\n<p style=\"padding-left: 30px;\">The &#8220;%i&#8221; is replaced with:<\/p>\n<p style=\"padding-left: 30px;\">%i = (PointNumber) + ( IncoherentBaseIndex)<\/p>\n<p style=\"padding-left: 30px;\">In this formula, <em>PointIndex<\/em> = 1:(<strong>N<\/strong>-1). <strong>N<\/strong> is the number of source points. Hence, if <strong>N<\/strong> = 50, then the <em>Save Fields<\/em> object will save 50 s<em>ource point files<\/em> and the <em>Restore Fields object<\/em> will load 50 <em>source point<\/em> files. The &#8220;%i&#8221; may lie anywhere within the filename specification.<\/p>\n<p style=\"padding-left: 30px;\">See: Incoherent Base Index.<\/p>\n<p><strong>Base Index &#8211;<\/strong> <em>Coherent Field Files :<\/em><\/p>\n<p style=\"padding-left: 30px;\">Specifies the base index for the filename enumeration<\/p>\n<p style=\"padding-left: 30px;\">If <em>Base Index<\/em> = 1000, then<\/p>\n<p style=\"padding-left: 30px;\">flds%v.mat<\/p>\n<p style=\"padding-left: 30px;\">will be replaced with:<\/p>\n<p style=\"padding-left: 30px;\">flds1001.mat, flds1002.mat, flds1003.mat,&#8230;<\/p>\n<p style=\"padding-left: 30px;\">Hence, the value of &#8220;%v&#8221; is the<em> visit count<\/em> plus the <em>base index<\/em>. This makes working with parallel data sets easy.<\/p>\n<p><strong>Base Index &#8211;<\/strong> <em>Incoherent Field Files<\/em> :<\/p>\n<p style=\"padding-left: 30px;\">The <em>Save Fields<\/em> object uses the <a href=\"http:\/\/wp.optics.arizona.edu\/milster\/resources\/optiscan-simulation-program\/optiscan-help-desk\/index\/source-type-panel\/\">Incoherent Base Index<\/a> that was specified for either the Source object or the Restore Fields object.<\/p>\n<p>See: File.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The Fields Panel allows the user to select the fields which should be saved and restored. The field matrices which are saved\/restored to a file are: Matrix\u00a0|\u00a0Name Description Ext\u00a0|\u00a0Transmitted X field Eyt\u00a0|\u00a0Transmitted Y field Ezt\u00a0|\u00a0Transmitted Z field Exr\u00a0|\u00a0Reflected X field Eyr\u00a0|\u00a0Reflected Y field Ezr\u00a0|\u00a0Reflected Z field Additionally, there are two coordinate vectors: Vector Name\u00a0|\u00a0Description sysxvec\u00a0|\u00a0coordinate vector for the columns. sysyvec\u00a0|\u00a0coordinate<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":894,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-1595","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/pages\/1595","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/comments?post=1595"}],"version-history":[{"count":3,"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/pages\/1595\/revisions"}],"predecessor-version":[{"id":1926,"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/pages\/1595\/revisions\/1926"}],"up":[{"embeddable":true,"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/pages\/894"}],"wp:attachment":[{"href":"https:\/\/wp.optics.arizona.edu\/milster\/wp-json\/wp\/v2\/media?parent=1595"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}