Differences

This shows you the differences between two versions of the page.

--- inspect3d:documentation:files:e3d_export_setting_file [2024/06/19 12:44] – sgranger
+++ inspect3d:documentation:files:e3d_export_setting_file [2024/07/12 13:26] (current) – removed sgranger
@@ Line 1: / Line 1: @@
-{{the .e3d file format is an method of storing inspect3d export settings as xml, ensuring that they are both human- and machine-readable. inspect3d allows users to save export settings from the i3dexportpcaresults.png **[[inspect3d:documentation:dialogs:export_results|export results]]** dialog. previously-saved export settings can also be loaded and used from this dialog.
-===== format =====
-as an xml document, an .e3d file is made up of hierarchical elements that are demarcated by tags, indicated by the < and > characters. an element consists of a start tag, <//elementname//>, and end tag, <///elementname//>, and all of the characters in between. alternatively, an element can be defined by a single tag, <//elementname ///>.
-tags can also contain attributes in the //name="value"// format, further describing the associated element.
-. the top-level element in an .e3d file is //exportfiles//. it contains one //folderpath// element, one or more //exportfile//elements, and one //i3d_info// element.
-. the //folderpath// element has a single attribute, //path// which is the path to the folder to which all of the exported files will be saved.
-. the //exportfile// elements each describe a single exported file. these have a single attribute, //name//, which is the name of exported file. these also contain two elements: //exportdata// and //settings//.
-. the //exportdata// element records the position of the active plot, whether all groups and workspaces were selected, and provides a list of selected groups and a list of selected workspaces. this element is not read in when applying export settings again, but it provides a potentially useful record of the original export.
-. the //settings// element records the specific settings from the export results dialog. only those settings from the active export_type will be included.
-. the //i3d_info// element has a single attribute, //version// which is the version of inspect3d used to create the .e3d file. this can be used for troubleshooting if the format of an .e3d file changes in the future.
-===== dtd =====
-formally, an .e3d file respects the document type definition (dtd):
-<code>
-<!doctype exportfiles [
-  <!element exportfiles (folderpath,exportfile+,i3d_info)>
-  <!element folderpath ()>
-  <!attlist folderpath path cdata #required>
-  <!element exportfile (exportdata,settings)>
-  <!element exportdata ()>
-  <!attlist exportdata col  cdata #required
-    exportdata row cdata #required
-    exportdata selallgrp cdata #required
-    exportdata selallwrkspc cdata #required
-    exportdata selgrps cdata #required
-    exportdata selwrspcs cdata #required
-  >
-  <!element settings ()>
-  <!attlist settings export_type cdata #required
-    settings export_data cdata #required
-    settings group_mean cdata #implied
-    settings group_stddev cdata #implied
-    settings wrksp_mean cdata #implied
-    settings wrkspc_stddev cdata #implied
-    settings normalized_sequences cdata #implied
-    settings timebased_sequences cdata #implied
-    settings normalized_events cdata #implied
-    settings original_events cdata #implied
-    settings normalized_points cdata #implied
-    settings wrkspc_scores cdata #implied
-    settings group_scores cdata #implied
-    settings group_scores_stddev cdata #implied
-    settings variance_explained cdata #implied
-    settings eigenvectors cdata #implied
-    settings mean_1sd cdata #implied
-    settings mean_5_and_95 cdata #implied
-    settings calculate_metrics_for cdata #implied
-    settings mean cdata #implied
-    settings stddev cdata #implied
-    settings min cdata #implied
-    settings min_stddev cdata #implied
-    settings min_event cdata #implied
-    settings max cdata #implied
-    settings max_stddev cdata #implied
-    settings max_event cdata #implied
-    settings add_metrics_column cdata #implied
-    settings use_normalized_data cdata #implied
-    settings precision cdata #required
-    settings export_format cdata #required
-  >
-  <!element i3d_info ()>
-  <!attlist i3d_info version cdata #required>
-]>
-</code>
-}}