Schema documentation

Last updated: February 25, 2020

This page contains the documentation automatically generated from the NexusLIMS Schema (nexus-experiment.xsd) that is used to validate experimental records upon insertion into the NexusLIMS CDCS instance. This documentation was generated using Oxygen’s XML Developer. 1

Main schema nexus-experiment.xsd

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A metadata schema for describing an experiment utilizing equipment from the Nexus Microscopy Lab. Properties attribute form default unqualified element form default unqualified version 0.02-26-2020

[ top ]

Element nx:Experiment

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations The root element for a document describing an Experiment Diagram Type nx:Experiment Properties content complex Model title{0,1} , id{0,1} , summary , sample* , project* , acquisitionActivity* , notes* Children acquisitionActivity, id, notes, project, sample, summary, title Instance <nx:Experiment xmlns:nx="https://data.nist.gov/od/dm/nexus/experiment/v1.0"> <title>{0,1}</title> <id>{0,1}</id> <summary>{1,1}</summary> <sample id="">{0,unbounded}</sample> <project>{0,unbounded}</project> <acquisitionActivity seqno="">{0,unbounded}</acquisitionActivity> <notes source="">{0,unbounded}</notes> </nx:Experiment> Source <xs:element name="Experiment" type="nx:Experiment"> <xs:annotation> <xs:appinfo> </xs:appinfo> <xs:documentation>The root element for a document describing an Experiment</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / title

	Namespace No namespace Annotations The title of this experiment Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="title" type="xs:token" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Title</label> </xs:appinfo> <xs:documentation>The title of this experiment</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / id

	Namespace No namespace Annotations A unique identifier assigned to this record. Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="id" type="xs:token" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Identifier</label> </xs:appinfo> <xs:documentation>A unique identifier assigned to this record.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / summary

	Namespace No namespace Annotations A collection of metadata that summarize the overall use and intent of the experiment. Diagram Type nx:Summary Properties content complex Model experimenter* , collaborator* , instrument* , reservationStart{0,1} , reservationEnd{0,1} , motivation{0,1} Children collaborator, experimenter, instrument, motivation, reservationEnd, reservationStart Instance <summary> <experimenter>{0,unbounded}</experimenter> <collaborator>{0,unbounded}</collaborator> <instrument pid="" ref="">{0,unbounded}</instrument> <reservationStart>{0,1}</reservationStart> <reservationEnd>{0,1}</reservationEnd> <motivation>{0,1}</motivation> </summary> Source <xs:element name="summary" type="nx:Summary"> <xs:annotation> <xs:appinfo> <label>Summary</label> </xs:appinfo> <xs:documentation>A collection of metadata that summarize the overall use and intent of the experiment.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Summary / experimenter

	Namespace No namespace Annotations The name of the user running this experiment. Diagram Type xs:token Properties content simple minOccurs 0 maxOccurs unbounded Source <xs:element name="experimenter" type="xs:token" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Experimenter</label> </xs:appinfo> <xs:documentation>The name of the user running this experiment.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Summary / collaborator

	Namespace No namespace Annotations The name of a notable collaborator in the experiment Diagram Type xs:token Properties content simple minOccurs 0 maxOccurs unbounded Source <xs:element name="collaborator" type="xs:token" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Collaborator</label> </xs:appinfo> <xs:documentation>The name of a notable collaborator in the experiment</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Summary / instrument

	Namespace No namespace Annotations The instrument used in this experiment Diagram Type nx:Instrument Type hierarchy xs:token nx:InstrumentName nx:Instrument Properties content complex minOccurs 0 maxOccurs unbounded Attributes QName Type Use Annotation pid nx:InstrumentPID optional An unique identifier that identifies the instrument within the NIST Electron Microscopy Nexus facility. ref xs:anyURI optional An (optional) link to this instrument in another database Source <xs:element name="instrument" type="nx:Instrument" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Instrument</label> </xs:appinfo> <xs:documentation>The instrument used in this experiment</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Summary / reservationStart

	Namespace No namespace Annotations The start time of this experiment Diagram Type xs:dateTime Properties content simple minOccurs 0 Source <xs:element name="reservationStart" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Reservation start time</label> </xs:appinfo> <xs:documentation>The start time of this experiment</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Summary / reservationEnd

	Namespace No namespace Annotations The end time of this experiment Diagram Type xs:dateTime Properties content simple minOccurs 0 Source <xs:element name="reservationEnd" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Reservation end time</label> </xs:appinfo> <xs:documentation>The end time of this experiment</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Summary / motivation

	Namespace No namespace Annotations A prose description of the motivation, purpose, or other intent behind this experiment. Diagram Type xs:string Properties content simple minOccurs 0 Source <xs:element name="motivation" type="xs:string" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Motivation</label> </xs:appinfo> <xs:documentation>A prose description of the motivation, purpose, or other intent behind this experiment.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / sample

	Namespace No namespace Annotations A description of a sample examined in this experiment. Diagram Type nx:Sample Properties content complex minOccurs 0 maxOccurs unbounded Model name{0,1} , description* , notes* Children description, name, notes Instance <sample id=""> <name>{0,1}</name> <description>{0,unbounded}</description> <notes source="">{0,unbounded}</notes> </sample> Attributes QName Type Use Annotation id xs:string optional An identifier (unique to this document) that identifies the current sample. This can be the sample name if it is unique. Source <xs:element name="sample" type="nx:Sample" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Sample</label> </xs:appinfo> <xs:documentation>A description of a sample examined in this experiment.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Sample / name

	Namespace No namespace Annotations A name for the sample (for display purposes) Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="name" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>A name for the sample (for display purposes)</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Sample / description

	Namespace No namespace Annotations A description of the sample (where each occurance can be thought of as a separate paragraph). Diagram Type xs:token Properties content simple minOccurs 0 maxOccurs unbounded Source <xs:element name="description" type="xs:token" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A description of the sample (where each occurance can be thought of as a separate paragraph).</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Sample / notes

	Namespace No namespace Annotations Largely unformatted notes taken regarding the current sample Diagram Type nx:Notes Properties content complex minOccurs 0 maxOccurs unbounded Model entry* Children entry Instance <notes source=""> <entry>{0,unbounded}</entry> </notes> Attributes QName Type Use Annotation source xs:string optional A label indicating where the notes were extracted from (e.g. "ELN") Source <xs:element name="notes" type="nx:Notes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Largely unformatted notes taken regarding the current sample</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Notes / entry

	Namespace No namespace Annotations A section of the notes. Each section can be of a different type with different structural content (e.g. for text, an image, a table, etc.) Diagram Type nx:Entry Properties content complex minOccurs 0 maxOccurs unbounded Model Source <xs:element name="entry" type="nx:Entry" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A section of the notes. Each section can be of a different type with different structural content (e.g. for text, an image, a table, etc.)</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / project

	Namespace No namespace Annotations A description of a project of which this Experiment is a part. Diagram Type nx:Project Properties content complex minOccurs 0 maxOccurs unbounded Model name{0,1} , division{0,1} , group{0,1} , project_id{0,1} , ref{0,1} Children division, group, name, project_id, ref Instance <project> <name>{0,1}</name> <division>{0,1}</division> <group>{0,1}</group> <project_id>{0,1}</project_id> <ref>{0,1}</ref> </project> Source <xs:element name="project" type="nx:Project" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Project</label> </xs:appinfo> <xs:documentation>A description of a project of which this Experiment is a part.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Project / name

	Namespace No namespace Annotations A name for the project (for display purposes) Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="name" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>A name for the project (for display purposes)</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Project / division

	Namespace No namespace Annotations The division ID to which this project belongs Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="division" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The division ID to which this project belongs</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Project / group

	Namespace No namespace Annotations The group ID within a division to which this project belongs Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="group" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The group ID within a division to which this project belongs</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Project / project_id

	Namespace No namespace Annotations The specific project ID within a research group/division Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="project_id" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The specific project ID within a research group/division</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Project / ref

	Namespace No namespace Annotations An (optional) link to this project in another database Diagram Type xs:anyURI Properties content simple minOccurs 0 Source <xs:element name="ref" type="xs:anyURI" minOccurs="0"> <xs:annotation> <xs:documentation>An (optional) link to this project in another database</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / acquisitionActivity

	Namespace No namespace Annotations A description of a specific group of data acqusition during this experimental session. Diagram Type nx:AcquisitionActivity Properties content complex minOccurs 0 maxOccurs unbounded Model startTime{0,1} , sampleID{0,1} , setup{0,1} , notes* , dataset* Children dataset, notes, sampleID, setup, startTime Instance <acquisitionActivity seqno=""> <startTime>{0,1}</startTime> <sampleID>{0,1}</sampleID> <setup>{0,1}</setup> <notes source="">{0,unbounded}</notes> <dataset role="" type="">{0,unbounded}</dataset> </acquisitionActivity> Attributes QName Type Use Annotation seqno xs:integer optional A number that indicates the order that this Acqusition Activity occurred within a sequence of Acqusition Activities. Source <xs:element name="acquisitionActivity" type="nx:AcquisitionActivity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Acquisition Activity</label> </xs:appinfo> <xs:documentation>A description of a specific group of data acqusition during this experimental session.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:AcquisitionActivity / startTime

	Namespace No namespace Annotations A date and time recorded as the start of this activity. This can be the time of the creation of the of the first dataset. Diagram Type xs:dateTime Properties content simple minOccurs 0 Source <xs:element name="startTime" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:documentation>A date and time recorded as the start of this activity. This can be the time of the creation of the of the first dataset.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:AcquisitionActivity / sampleID

	Namespace No namespace Annotations The identifier for the sample that was part of this acquisition activity. This should match a value of the id attribute for a sample element included in this document. Diagram Type xs:token Properties content simple minOccurs 0 Source <xs:element name="sampleID" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The identifier for the sample that was part of this acquisition activity. This should match a value of the id attribute for a sample element included in this document.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:AcquisitionActivity / setup

	Namespace No namespace Annotations Metadata describing the set-up of the instrument during the current Acqusition Activity. Diagram Type nx:Setup Properties content complex minOccurs 0 Model param* Children param Instance <setup> <param name="" unit="" warning="">{0,unbounded}</param> </setup> Source <xs:element name="setup" type="nx:Setup" minOccurs="0"> <xs:annotation> <xs:documentation>Metadata describing the set-up of the instrument during the current Acqusition Activity.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Setup / param

	Namespace No namespace Annotations An arbitrary setup parameter with a name and a value Diagram Type nx:Parameter Properties content complex minOccurs 0 maxOccurs unbounded Attributes QName Type Use Annotation name optional The name of the parameter unit optional A physical unit associated with the value of this parameter warning xs:boolean optional A marker to indicate that this parameter may not be reliable (an instrument may have not written it correctly, or it is commonly not filled out properly, etc.) Source <xs:element name="param" type="nx:Parameter" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>An arbitrary setup parameter with a name and a value</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:AcquisitionActivity / notes

	Namespace No namespace Annotations Largely unformatted notes taken regarding the current Acqusition Activity Diagram Type nx:Notes Properties content complex minOccurs 0 maxOccurs unbounded Model entry* Children entry Instance <notes source=""> <entry>{0,unbounded}</entry> </notes> Attributes QName Type Use Annotation source xs:string optional A label indicating where the notes were extracted from (e.g. "ELN") Source <xs:element name="notes" type="nx:Notes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Largely unformatted notes taken regarding the current Acqusition Activity</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:AcquisitionActivity / dataset

	Namespace No namespace Annotations A file or named set of files that was acquired during the current Acqusition Activity. Diagram Type nx:Dataset Properties content complex minOccurs 0 maxOccurs unbounded Model name , location , format{0,1} , description* , preview* , meta* Children description, format, location, meta, name, preview Instance <dataset role="" type=""> <name>{1,1}</name> <location>{1,1}</location> <format>{0,1}</format> <description>{0,unbounded}</description> <preview>{0,unbounded}</preview> <meta name="" unit="" warning="">{0,unbounded}</meta> </dataset> Attributes QName Type Use Annotation role nx:DatasetRole optional A label indicating the experimental role of this dataset (taken from a controlled list). type nx:DatasetType optional A label indicating the type of this dataset (taken from a controlled list). Source <xs:element name="dataset" type="nx:Dataset" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A file or named set of files that was acquired during the current Acqusition Activity.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Dataset / name

	Namespace No namespace Annotations The name given to the dataset Diagram Type xs:string Properties content simple Source <xs:element name="name" type="xs:string"> <xs:annotation> <xs:documentation>The name given to the dataset</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Dataset / location

	Namespace No namespace Annotations A directory path or URL indicating the location where the dataset is stored Diagram Type xs:string Properties content simple Source <xs:element name="location" type="xs:string"> <xs:annotation> <xs:documentation>A directory path or URL indicating the location where the dataset is stored</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Dataset / format

	Namespace No namespace Annotations A string (can be a MIME type) indicating the format of the dataset (e.g. TIFF, DICOM, Excel). Diagram Type xs:string Properties content simple minOccurs 0 Source <xs:element name="format" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>A string (can be a MIME type) indicating the format of the dataset (e.g. TIFF, DICOM, Excel).</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Dataset / description

	Namespace No namespace Annotations A description of the dataset (where each occurance can be thought of as a separate paragraph). Diagram Type xs:string Properties content simple minOccurs 0 maxOccurs unbounded Source <xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A description of the dataset (where each occurance can be thought of as a separate paragraph).</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Dataset / preview

	Namespace No namespace Annotations URL or string path to a preview rendering (thumbnail) of the data in the dataset. Diagram Type xs:string Properties content simple minOccurs 0 maxOccurs unbounded Source <xs:element name="preview" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>URL or string path to a preview rendering (thumbnail) of the data in the dataset.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Dataset / meta

	Namespace No namespace Annotations An arbitrary metadatum with a name and a value unique to this dataset Diagram Type nx:Parameter Properties content complex minOccurs 0 maxOccurs unbounded Attributes QName Type Use Annotation name optional The name of the parameter unit optional A physical unit associated with the value of this parameter warning xs:boolean optional A marker to indicate that this parameter may not be reliable (an instrument may have not written it correctly, or it is commonly not filled out properly, etc.) Source <xs:element name="meta" type="nx:Parameter" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>An arbitrary metadatum with a name and a value unique to this dataset</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Experiment / notes

	Namespace No namespace Annotations Largely unformatted notes taken regarding the current sample Diagram Type nx:Notes Properties content complex minOccurs 0 maxOccurs unbounded Model entry* Children entry Instance <notes source=""> <entry>{0,unbounded}</entry> </notes> Attributes QName Type Use Annotation source xs:string optional A label indicating where the notes were extracted from (e.g. "ELN") Source <xs:element name="notes" type="nx:Notes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Largely unformatted notes taken regarding the current sample</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:TextEntry / p

	Namespace No namespace Annotations Free text content Diagram Type xs:token Properties content simple minOccurs 1 maxOccurs unbounded Source <xs:element name="p" type="xs:token" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Free text content</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:ImageEntry / imageURL

	Namespace No namespace Annotations A link to an image inserted into the notes Diagram Type xs:anyURI Properties content simple minOccurs 1 maxOccurs unbounded Source <xs:element name="imageURL" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A link to an image inserted into the notes</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:TableEntry / table

	Namespace No namespace Annotations Tabular content inserted into the notes Diagram Type nx:Table Properties content complex minOccurs 1 maxOccurs unbounded Model title{0,1} , header , rows Children header, rows, title Instance <table> <title>{0,1}</title> <header>{1,1}</header> <rows>{1,1}</rows> </table> Source <xs:element name="table" type="nx:Table" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Tabular content inserted into the notes</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Table / title

	Namespace No namespace Annotations The title for the table Diagram Type xs:token Properties content simple minOccurs 0 maxOccurs 1 Source <xs:element name="title" type="xs:token" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The title for the table</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Table / header

	Namespace No namespace Annotations The description of the table's columns Diagram Type nx:TableHeader Properties content complex Model column* Children column Instance <header> <column id="">{0,unbounded}</column> </header> Source <xs:element name="header" type="nx:TableHeader"> <xs:annotation> <xs:documentation>The description of the table's columns</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:TableHeader / column

	Namespace No namespace Annotations A single column of data in the table Diagram Type nx:TableColumn Properties content complex minOccurs 0 maxOccurs unbounded Attributes QName Type Use Annotation id optional The identifier to assign to this column (for reference by cell elements). Source <xs:element name="column" type="nx:TableColumn" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A single column of data in the table</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:Table / rows

	Namespace No namespace Annotations The main data of the table, organized into rows Diagram Type nx:TableRows Properties content complex Model row* Children row Instance <rows> <row seqno="">{0,unbounded}</row> </rows> Source <xs:element name="rows" type="nx:TableRows"> <xs:annotation> <xs:documentation>The main data of the table, organized into rows</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:TableRows / row

	Namespace No namespace Annotations A single row of data in the table Diagram Type nx:TableRow Properties content complex minOccurs 0 maxOccurs unbounded Model cell* Children cell Instance <row seqno=""> <cell colid="">{0,unbounded}</cell> </row> Attributes QName Type Use Annotation seqno xs:integer optional A number that indicates the order that the row appears in the table. Source <xs:element name="row" type="nx:TableRow" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A single row of data in the table</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Element nx:TableRow / cell

	Namespace No namespace Annotations A single cell in a row of a table. Diagram Type nx:TableCell Properties content complex minOccurs 0 maxOccurs unbounded Attributes QName Type Use Annotation colid optional The identifier for the column that this cell corresponds to Source <xs:element name="cell" type="nx:TableCell" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A single cell in a row of a table.</xs:documentation> </xs:annotation> </xs:element>

[ top ]

Complex Type nx:Experiment

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A description of an experiment using an instrument in Nexus Microscopy Lab Diagram Used by Element nx:Experiment Model title{0,1} , id{0,1} , summary , sample* , project* , acquisitionActivity* , notes* Children acquisitionActivity, id, notes, project, sample, summary, title Source <xs:complexType name="Experiment"> <xs:annotation> <xs:documentation>A description of an experiment using an instrument in Nexus Microscopy Lab</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="title" type="xs:token" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Title</label> </xs:appinfo> <xs:documentation>The title of this experiment</xs:documentation> </xs:annotation> </xs:element> <xs:element name="id" type="xs:token" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Identifier</label> </xs:appinfo> <xs:documentation>A unique identifier assigned to this record.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="summary" type="nx:Summary"> <xs:annotation> <xs:appinfo> <label>Summary</label> </xs:appinfo> <xs:documentation>A collection of metadata that summarize the overall use and intent of the experiment.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="sample" type="nx:Sample" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Sample</label> </xs:appinfo> <xs:documentation>A description of a sample examined in this experiment.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="project" type="nx:Project" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Project</label> </xs:appinfo> <xs:documentation>A description of a project of which this Experiment is a part.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="acquisitionActivity" type="nx:AcquisitionActivity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Acquisition Activity</label> </xs:appinfo> <xs:documentation>A description of a specific group of data acqusition during this experimental session.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="notes" type="nx:Notes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Largely unformatted notes taken regarding the current sample</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:Summary

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A collection of metadata that summarize the overall use and intent of the experiment. Diagram Used by Element nx:Experiment/summary Model experimenter* , collaborator* , instrument* , reservationStart{0,1} , reservationEnd{0,1} , motivation{0,1} Children collaborator, experimenter, instrument, motivation, reservationEnd, reservationStart Source <xs:complexType name="Summary"> <xs:annotation> <xs:documentation>A collection of metadata that summarize the overall use and intent of the experiment.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="experimenter" type="xs:token" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Experimenter</label> </xs:appinfo> <xs:documentation>The name of the user running this experiment.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="collaborator" type="xs:token" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Collaborator</label> </xs:appinfo> <xs:documentation>The name of a notable collaborator in the experiment</xs:documentation> </xs:annotation> </xs:element> <xs:element name="instrument" type="nx:Instrument" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:appinfo> <label>Instrument</label> </xs:appinfo> <xs:documentation>The instrument used in this experiment</xs:documentation> </xs:annotation> </xs:element> <xs:element name="reservationStart" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Reservation start time</label> </xs:appinfo> <xs:documentation>The start time of this experiment</xs:documentation> </xs:annotation> </xs:element> <xs:element name="reservationEnd" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Reservation end time</label> </xs:appinfo> <xs:documentation>The end time of this experiment</xs:documentation> </xs:annotation> </xs:element> <xs:element name="motivation" type="xs:string" minOccurs="0"> <xs:annotation> <xs:appinfo> <label>Motivation</label> </xs:appinfo> <xs:documentation>A prose description of the motivation, purpose, or other intent behind this experiment.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:Instrument

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations The identification of an instrument in the NIST Electron Microscopy Nexus facility. Diagram Type extension of nx:InstrumentName Type hierarchy xs:token nx:InstrumentName nx:Instrument Used by Element nx:Summary/instrument Attributes QName Type Use Annotation pid nx:InstrumentPID optional An unique identifier that identifies the instrument within the NIST Electron Microscopy Nexus facility. ref xs:anyURI optional An (optional) link to this instrument in another database Source <xs:complexType name="Instrument"> <xs:annotation> <xs:documentation>The identification of an instrument in the NIST Electron Microscopy Nexus facility.</xs:documentation> </xs:annotation> <xs:simpleContent> <xs:extension base="nx:InstrumentName"> <xs:attribute name="pid" type="nx:InstrumentPID"> <xs:annotation> <xs:documentation>An unique identifier that identifies the instrument within the NIST Electron Microscopy Nexus facility.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ref" type="xs:anyURI"> <xs:annotation> <xs:documentation>An (optional) link to this instrument in another database</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:simpleContent> </xs:complexType>

[ top ]

Simple Type nx:InstrumentName

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations Controlled labels that identify available instruments in the NIST Electron Microscopy Nexus facility (as named in the SharePoint calendar resource). Diagram Type restriction of xs:token Facets enumeration FEI Titan TEM The FEI Titan transmission electron microscope in ***REMOVED*** enumeration FEI Titan STEM The FEI Titan scanning transmission electron microscope in ***REMOVED*** enumeration FEI Helios The FEI Helios dual beam FIB/SEM in ***REMOVED*** enumeration FEI Quanta200 The FEI Quanta 200 environmental scanning electron microscope in ***REMOVED*** enumeration Hitachi S4700 The Hitachi S4700 scanning electron microscope in ***REMOVED*** enumeration Hitachi S5500 The Hitachi S5500 scanning electron microscope in ***REMOVED*** enumeration JEOL JEM3010 The JEOL JEM3010 transmission electron microscope in ***REMOVED*** enumeration JEOL JSM7100 The JEOL JSM7100 scanning electron microscope in ***REMOVED*** enumeration Philips EM400 The Phillips EM400 transmission electron microscope in ***REMOVED*** enumeration Philips CM30 The Phillips CM30 transmission electron microscope Used by Complex Type nx:Instrument Source <xs:simpleType name="InstrumentName"> <xs:annotation> <xs:documentation>Controlled labels that identify available instruments in the NIST Electron Microscopy Nexus facility (as named in the SharePoint calendar resource).</xs:documentation> </xs:annotation> <xs:restriction base="xs:token"> <xs:enumeration value="FEI Titan TEM"> <xs:annotation> <xs:documentation>The FEI Titan transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="FEI Titan STEM"> <xs:annotation> <xs:documentation>The FEI Titan scanning transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="FEI Helios"> <xs:annotation> <xs:documentation>The FEI Helios dual beam FIB/SEM in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="FEI Quanta200"> <xs:annotation> <xs:documentation>The FEI Quanta 200 environmental scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Hitachi S4700"> <xs:annotation> <xs:documentation>The Hitachi S4700 scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Hitachi S5500"> <xs:annotation> <xs:documentation>The Hitachi S5500 scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="JEOL JEM3010"> <xs:annotation> <xs:documentation>The JEOL JEM3010 transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="JEOL JSM7100"> <xs:annotation> <xs:documentation>The JEOL JSM7100 scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Philips EM400"> <xs:annotation> <xs:documentation>The Phillips EM400 transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Philips CM30"> <xs:annotation> <xs:documentation>The Phillips CM30 transmission electron microscope</xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType>

[ top ]

Simple Type nx:InstrumentPID

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations Controlled unique IDs used to identify available instruments in the NIST Electron Microscopy Nexus facility. These are the same PID values used in the SharePoint calendar system. Diagram Type restriction of xs:token Facets enumeration FEI-Titan-TEM-635816 The FEI Titan transmission electron microscope in ***REMOVED*** enumeration FEI-Titan-STEM-630901 The FEI Titan scanning transmission electron microscope in ***REMOVED*** enumeration FEI-Helios-DB-636663 The FEI Helios dual beam FIB/SEM in ***REMOVED*** enumeration FEI-Quanta200-ESEM-633137 The FEI Quanta 200 environmental scanning electron microscope in ***REMOVED*** enumeration Hitachi-S4700-SEM-606559 The Hitachi S4700 scanning electron microscope in ***REMOVED*** enumeration Hitachi-S5500-SEM-635262 The Hitachi S5500 scanning electron microscope in ***REMOVED*** enumeration JEOL-JEM3010-TEM-565989 The JEOL JEM3010 transmission electron microscope in ***REMOVED*** enumeration JEOL-JSM7100-SEM-N102656 The JEOL JSM7100 scanning electron microscope in ***REMOVED*** enumeration Philips-EM400-TEM-599910 The Phillips EM400 transmission electron microscope in ***REMOVED*** enumeration Philips-CM30-TEM-540388 The Phillips CM30 transmission electron microscope Used by Attribute nx:Instrument/@pid Source <xs:simpleType name="InstrumentPID"> <xs:annotation> <xs:documentation>Controlled unique IDs used to identify available instruments in the NIST Electron Microscopy Nexus facility. These are the same PID values used in the SharePoint calendar system.</xs:documentation> </xs:annotation> <xs:restriction base="xs:token"> <xs:enumeration value="FEI-Titan-TEM-635816"> <xs:annotation> <xs:documentation>The FEI Titan transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="FEI-Titan-STEM-630901"> <xs:annotation> <xs:documentation>The FEI Titan scanning transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="FEI-Helios-DB-636663"> <xs:annotation> <xs:documentation>The FEI Helios dual beam FIB/SEM in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="FEI-Quanta200-ESEM-633137"> <xs:annotation> <xs:documentation>The FEI Quanta 200 environmental scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Hitachi-S4700-SEM-606559"> <xs:annotation> <xs:documentation>The Hitachi S4700 scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Hitachi-S5500-SEM-635262"> <xs:annotation> <xs:documentation>The Hitachi S5500 scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="JEOL-JEM3010-TEM-565989"> <xs:annotation> <xs:documentation>The JEOL JEM3010 transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="JEOL-JSM7100-SEM-N102656"> <xs:annotation> <xs:documentation>The JEOL JSM7100 scanning electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Philips-EM400-TEM-599910"> <xs:annotation> <xs:documentation>The Phillips EM400 transmission electron microscope in ***REMOVED***</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Philips-CM30-TEM-540388"> <xs:annotation> <xs:documentation>The Phillips CM30 transmission electron microscope</xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType>

[ top ]

Complex Type nx:Sample

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A collection of metadata that describe a sample examined during an experiment. Diagram Used by Element nx:Experiment/sample Model name{0,1} , description* , notes* Children description, name, notes Attributes QName Type Use Annotation id xs:string optional An identifier (unique to this document) that identifies the current sample. This can be the sample name if it is unique. Source <xs:complexType name="Sample"> <xs:annotation> <xs:documentation>A collection of metadata that describe a sample examined during an experiment.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="name" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>A name for the sample (for display purposes)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="description" type="xs:token" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A description of the sample (where each occurance can be thought of as a separate paragraph).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="notes" type="nx:Notes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Largely unformatted notes taken regarding the current sample</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="id" type="xs:string"> <xs:annotation> <xs:documentation>An identifier (unique to this document) that identifies the current sample. This can be the sample name if it is unique.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

[ top ]

Complex Type nx:Notes

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations Generic content pulled as notes (lightly structured). Diagram Used by Elements nx:AcquisitionActivity/notes, nx:Experiment/notes, nx:Sample/notes Model entry* Children entry Attributes QName Type Use Annotation source xs:string optional A label indicating where the notes were extracted from (e.g. "ELN") Source <xs:complexType name="Notes"> <xs:annotation> <xs:documentation>Generic content pulled as notes (lightly structured).</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="entry" type="nx:Entry" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A section of the notes. Each section can be of a different type with different structural content (e.g. for text, an image, a table, etc.)</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="source" type="xs:string"> <xs:annotation> <xs:documentation>A label indicating where the notes were extracted from (e.g. "ELN")</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

[ top ]

Complex Type nx:Entry

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations An entry into a set of notes. This type serves as a base type for different sub-types. Diagram Used by Element nx:Notes/entry Complex Types nx:ImageEntry, nx:TableEntry, nx:TextEntry Model Source <xs:complexType name="Entry"> <xs:annotation> <xs:documentation>An entry into a set of notes. This type serves as a base type for different sub-types.</xs:documentation> </xs:annotation> <xs:sequence> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:Project

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A collection of metadata that describes a project to which an Experiment can belong. Diagram Used by Element nx:Experiment/project Model name{0,1} , division{0,1} , group{0,1} , project_id{0,1} , ref{0,1} Children division, group, name, project_id, ref Source <xs:complexType name="Project"> <xs:annotation> <xs:documentation>A collection of metadata that describes a project to which an Experiment can belong.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="name" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>A name for the project (for display purposes)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="division" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The division ID to which this project belongs</xs:documentation> </xs:annotation> </xs:element> <xs:element name="group" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The group ID within a division to which this project belongs</xs:documentation> </xs:annotation> </xs:element> <xs:element name="project_id" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The specific project ID within a research group/division</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ref" type="xs:anyURI" minOccurs="0"> <xs:annotation> <xs:documentation>An (optional) link to this project in another database</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:AcquisitionActivity

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A collection of metadata that describe a specific group of acquired data during the Experiment. Diagram Used by Element nx:Experiment/acquisitionActivity Model startTime{0,1} , sampleID{0,1} , setup{0,1} , notes* , dataset* Children dataset, notes, sampleID, setup, startTime Attributes QName Type Use Annotation seqno xs:integer optional A number that indicates the order that this Acqusition Activity occurred within a sequence of Acqusition Activities. Source <xs:complexType name="AcquisitionActivity"> <xs:annotation> <xs:documentation>A collection of metadata that describe a specific group of acquired data during the Experiment.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="startTime" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:documentation>A date and time recorded as the start of this activity. This can be the time of the creation of the of the first dataset.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="sampleID" type="xs:token" minOccurs="0"> <xs:annotation> <xs:documentation>The identifier for the sample that was part of this acquisition activity. This should match a value of the id attribute for a sample element included in this document.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="setup" type="nx:Setup" minOccurs="0"> <xs:annotation> <xs:documentation>Metadata describing the set-up of the instrument during the current Acqusition Activity.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="notes" type="nx:Notes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Largely unformatted notes taken regarding the current Acqusition Activity</xs:documentation> </xs:annotation> </xs:element> <xs:element name="dataset" type="nx:Dataset" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A file or named set of files that was acquired during the current Acqusition Activity.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="seqno" type="xs:integer"> <xs:annotation> <xs:documentation>A number that indicates the order that this Acqusition Activity occurred within a sequence of Acqusition Activities.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

[ top ]

Complex Type nx:Setup

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations Metadata describing the set-up of an instrument (values common to all datasets within an Acqusition Activity). Diagram Used by Element nx:AcquisitionActivity/setup Model param* Children param Source <xs:complexType name="Setup"> <xs:annotation> <xs:documentation>Metadata describing the set-up of an instrument (values common to all datasets within an Acqusition Activity).</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="param" type="nx:Parameter" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>An arbitrary setup parameter with a name and a value</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:Parameter

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A piece of arbitrary metadata featuring a name and a value, unique to a dataset within an Acqusition Activity. Diagram Type extension of xs:token Used by Elements nx:Dataset/meta, nx:Setup/param Attributes QName Type Use Annotation name optional The name of the parameter unit optional A physical unit associated with the value of this parameter warning xs:boolean optional A marker to indicate that this parameter may not be reliable (an instrument may have not written it correctly, or it is commonly not filled out properly, etc.) Source <xs:complexType name="Parameter"> <xs:annotation> <xs:documentation>A piece of arbitrary metadata featuring a name and a value, unique to a dataset within an Acqusition Activity.</xs:documentation> </xs:annotation> <xs:simpleContent> <xs:extension base="xs:token"> <xs:attribute name="name"> <xs:annotation> <xs:documentation>The name of the parameter</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="unit"> <xs:annotation> <xs:documentation>A physical unit associated with the value of this parameter</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="warning" type="boolean"> <xs:annotation> <xs:documentation>A marker to indicate that this parameter may not be reliable (an instrument may have not written it correctly, or it is commonly not filled out properly, etc.)</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:simpleContent> </xs:complexType>

[ top ]

Complex Type nx:Dataset

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A description of a file or set of files. Diagram Used by Element nx:AcquisitionActivity/dataset Model name , location , format{0,1} , description* , preview* , meta* Children description, format, location, meta, name, preview Attributes QName Type Use Annotation role nx:DatasetRole optional A label indicating the experimental role of this dataset (taken from a controlled list). type nx:DatasetType optional A label indicating the type of this dataset (taken from a controlled list). Source <xs:complexType name="Dataset"> <xs:annotation> <xs:documentation>A description of a file or set of files.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="name" type="xs:string"> <xs:annotation> <xs:documentation>The name given to the dataset</xs:documentation> </xs:annotation> </xs:element> <xs:element name="location" type="xs:string"> <xs:annotation> <xs:documentation>A directory path or URL indicating the location where the dataset is stored</xs:documentation> </xs:annotation> </xs:element> <xs:element name="format" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>A string (can be a MIME type) indicating the format of the dataset (e.g. TIFF, DICOM, Excel).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A description of the dataset (where each occurance can be thought of as a separate paragraph).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="preview" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>URL or string path to a preview rendering (thumbnail) of the data in the dataset.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="meta" type="nx:Parameter" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>An arbitrary metadatum with a name and a value unique to this dataset</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="type" type="nx:DatasetType"> <xs:annotation> <xs:documentation>A label indicating the type of this dataset (taken from a controlled list).</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="role" type="nx:DatasetRole"> <xs:annotation> <xs:documentation>A label indicating the experimental role of this dataset (taken from a controlled list).</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

[ top ]

Simple Type nx:DatasetType

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations Controlled labels that identify a functional type data contained in a dataset. Diagram Type restriction of xs:token Facets enumeration Image A 2-D array of data where each value is typically an intensity measurement as function of regularly spaced position enumeration Spectrum A 1-D array of data where each value is typically an intensity measurement as a function of frequency or energy enumeration SpectrumImage A 3-D array of data where each value is typically an intensity measurement as a function of regularly space position along two axes and of frequency or energy along the third. enumeration Diffraction Data that measures a (usually electron) diffraction pattern enumeration Notes Arbitrary textual data that is typically manually created by the Experimenter. enumeration Misc A dataset that does not qualify as of any of the other defined types. Used by Attribute nx:Dataset/@type Source <xs:simpleType name="DatasetType"> <xs:annotation> <xs:documentation>Controlled labels that identify a functional type data contained in a dataset.</xs:documentation> </xs:annotation> <xs:restriction base="xs:token"> <xs:enumeration value="Image"> <xs:annotation> <xs:documentation>A 2-D array of data where each value is typically an intensity measurement as function of regularly spaced position</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Spectrum"> <xs:annotation> <xs:documentation>A 1-D array of data where each value is typically an intensity measurement as a function of frequency or energy</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="SpectrumImage"> <xs:annotation> <xs:documentation>A 3-D array of data where each value is typically an intensity measurement as a function of regularly space position along two axes and of frequency or energy along the third.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Diffraction"> <xs:annotation> <xs:documentation>Data that measures a (usually electron) diffraction pattern</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Notes"> <xs:annotation> <xs:documentation>Arbitrary textual data that is typically manually created by the Experimenter.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Misc"> <xs:annotation> <xs:documentation>A dataset that does not qualify as of any of the other defined types.</xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType>

[ top ]

Simple Type nx:DatasetRole

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations Controlled labels that identify the functional role of a dataset Diagram Type restriction of xs:token Facets enumeration Experimental "Normal" data collected during typical operation of an instrument for experimental purposes enumeration MasterCalibration Reference data collected for the purpose of instrument calibration during instrument service events or by allowed super users enumeration UserCalibration Data collected alongside "Experimental" Datasets by regular users for calibration purposes between service events or for a specific experiment enumeration Derived Data that is not collected form an instrument, but rather derived from raw and/or calibration data as the result of post-acquisition analysis processes Used by Attribute nx:Dataset/@role Source <xs:simpleType name="DatasetRole"> <xs:annotation> <xs:documentation>Controlled labels that identify the functional role of a dataset</xs:documentation> </xs:annotation> <xs:restriction base="xs:token"> <xs:enumeration value="Experimental"> <xs:annotation> <xs:documentation>"Normal" data collected during typical operation of an instrument for experimental purposes</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="MasterCalibration"> <xs:annotation> <xs:documentation>Reference data collected for the purpose of instrument calibration during instrument service events or by allowed super users</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="UserCalibration"> <xs:annotation> <xs:documentation>Data collected alongside "Experimental" Datasets by regular users for calibration purposes between service events or for a specific experiment</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="Derived"> <xs:annotation> <xs:documentation>Data that is not collected form an instrument, but rather derived from raw and/or calibration data as the result of post-acquisition analysis processes</xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType>

[ top ]

Complex Type nx:TextEntry

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A text entry into a set of notes. Diagram Type extension of nx:Entry Type hierarchy nx:Entry nx:TextEntry Model p+ Children p Source <xs:complexType name="TextEntry"> <xs:annotation> <xs:documentation>A text entry into a set of notes.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="nx:Entry"> <xs:sequence> <xs:element name="p" type="xs:token" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Free text content</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>

[ top ]

Complex Type nx:ImageEntry

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations An image entry into a set of notes. Diagram Type extension of nx:Entry Type hierarchy nx:Entry nx:ImageEntry Model imageURL+ Children imageURL Source <xs:complexType name="ImageEntry"> <xs:annotation> <xs:documentation>An image entry into a set of notes.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="nx:Entry"> <xs:sequence> <xs:sequence> <xs:element name="imageURL" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A link to an image inserted into the notes</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>

[ top ]

Complex Type nx:TableEntry

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A table entry into a set of notes. Diagram Type extension of nx:Entry Type hierarchy nx:Entry nx:TableEntry Model table+ Children table Source <xs:complexType name="TableEntry"> <xs:annotation> <xs:documentation>A table entry into a set of notes.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="nx:Entry"> <xs:sequence> <xs:sequence> <xs:element name="table" type="nx:Table" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Tabular content inserted into the notes</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>

[ top ]

Complex Type nx:Table

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A single grid of tabular information Diagram Used by Element nx:TableEntry/table Model title{0,1} , header , rows Children header, rows, title Source <xs:complexType name="Table"> <xs:annotation> <xs:documentation>A single grid of tabular information</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="title" type="xs:token" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The title for the table</xs:documentation> </xs:annotation> </xs:element> <xs:element name="header" type="nx:TableHeader"> <xs:annotation> <xs:documentation>The description of the table's columns</xs:documentation> </xs:annotation> </xs:element> <xs:element name="rows" type="nx:TableRows"> <xs:annotation> <xs:documentation>The main data of the table, organized into rows</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:TableHeader

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A description of a table's columns Diagram Used by Element nx:Table/header Model column* Children column Source <xs:complexType name="TableHeader"> <xs:annotation> <xs:documentation>A description of a table's columns</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="column" type="nx:TableColumn" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A single column of data in the table</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:TableColumn

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A description of one column in a table Diagram Type extension of xs:token Used by Element nx:TableHeader/column Attributes QName Type Use Annotation id optional The identifier to assign to this column (for reference by cell elements). Source <xs:complexType name="TableColumn"> <xs:annotation> <xs:documentation>A description of one column in a table</xs:documentation> </xs:annotation> <xs:simpleContent> <xs:extension base="xs:token"> <xs:attribute name="id"> <xs:annotation> <xs:documentation>The identifier to assign to this column (for reference by cell elements).</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:simpleContent> </xs:complexType>

[ top ]

Complex Type nx:TableRows

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations The main data body of a table, organized as a sequence of rows. Diagram Used by Element nx:Table/rows Model row* Children row Source <xs:complexType name="TableRows"> <xs:annotation> <xs:documentation>The main data body of a table, organized as a sequence of rows.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="row" type="nx:TableRow" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A single row of data in the table</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

[ top ]

Complex Type nx:TableRow

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A single row of a table Diagram Used by Element nx:TableRows/row Model cell* Children cell Attributes QName Type Use Annotation seqno xs:integer optional A number that indicates the order that the row appears in the table. Source <xs:complexType name="TableRow"> <xs:annotation> <xs:documentation>A single row of a table</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="cell" type="nx:TableCell" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A single cell in a row of a table.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="seqno" type="xs:integer"> <xs:annotation> <xs:documentation>A number that indicates the order that the row appears in the table.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

[ top ]

Complex Type nx:TableCell

	Namespace https://data.nist.gov/od/dm/nexus/experiment/v1.0 Annotations A container for data in one cell of the table. Diagram Type extension of xs:token Used by Element nx:TableRow/cell Attributes QName Type Use Annotation colid optional The identifier for the column that this cell corresponds to Source <xs:complexType name="TableCell"> <xs:annotation> <xs:documentation>A container for data in one cell of the table.</xs:documentation> </xs:annotation> <xs:simpleContent> <xs:extension base="xs:token"> <xs:attribute name="colid"> <xs:annotation> <xs:documentation>The identifier for the column that this cell corresponds to</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:simpleContent> </xs:complexType>

[ top ]

Attribute nx:Instrument / @pid

	Namespace No namespace Annotations An unique identifier that identifies the instrument within the NIST Electron Microscopy Nexus facility. Type nx:InstrumentPID Properties content simple Facets enumeration FEI-Titan-TEM-635816 The FEI Titan transmission electron microscope in ***REMOVED*** enumeration FEI-Titan-STEM-630901 The FEI Titan scanning transmission electron microscope in ***REMOVED*** enumeration FEI-Helios-DB-636663 The FEI Helios dual beam FIB/SEM in ***REMOVED*** enumeration FEI-Quanta200-ESEM-633137 The FEI Quanta 200 environmental scanning electron microscope in ***REMOVED*** enumeration Hitachi-S4700-SEM-606559 The Hitachi S4700 scanning electron microscope in ***REMOVED*** enumeration Hitachi-S5500-SEM-635262 The Hitachi S5500 scanning electron microscope in ***REMOVED*** enumeration JEOL-JEM3010-TEM-565989 The JEOL JEM3010 transmission electron microscope in ***REMOVED*** enumeration JEOL-JSM7100-SEM-N102656 The JEOL JSM7100 scanning electron microscope in ***REMOVED*** enumeration Philips-EM400-TEM-599910 The Phillips EM400 transmission electron microscope in ***REMOVED*** enumeration Philips-CM30-TEM-540388 The Phillips CM30 transmission electron microscope Used by Complex Type nx:Instrument Source <xs:attribute name="pid" type="nx:InstrumentPID"> <xs:annotation> <xs:documentation>An unique identifier that identifies the instrument within the NIST Electron Microscopy Nexus facility.</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Instrument / @ref

	Namespace No namespace Annotations An (optional) link to this instrument in another database Type xs:anyURI Properties content simple Used by Complex Type nx:Instrument Source <xs:attribute name="ref" type="xs:anyURI"> <xs:annotation> <xs:documentation>An (optional) link to this instrument in another database</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Notes / @source

	Namespace No namespace Annotations A label indicating where the notes were extracted from (e.g. "ELN") Type xs:string Properties content simple Used by Complex Type nx:Notes Source <xs:attribute name="source" type="xs:string"> <xs:annotation> <xs:documentation>A label indicating where the notes were extracted from (e.g. "ELN")</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Sample / @id

	Namespace No namespace Annotations An identifier (unique to this document) that identifies the current sample. This can be the sample name if it is unique. Type xs:string Properties content simple Used by Complex Type nx:Sample Source <xs:attribute name="id" type="xs:string"> <xs:annotation> <xs:documentation>An identifier (unique to this document) that identifies the current sample. This can be the sample name if it is unique.</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Parameter / @name

	Namespace No namespace Annotations The name of the parameter Used by Complex Type nx:Parameter Source <xs:attribute name="name"> <xs:annotation> <xs:documentation>The name of the parameter</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Parameter / @unit

	Namespace No namespace Annotations A physical unit associated with the value of this parameter Used by Complex Type nx:Parameter Source <xs:attribute name="unit"> <xs:annotation> <xs:documentation>A physical unit associated with the value of this parameter</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Parameter / @warning

	Namespace No namespace Annotations A marker to indicate that this parameter may not be reliable (an instrument may have not written it correctly, or it is commonly not filled out properly, etc.) Type xs:boolean Properties content simple Used by Complex Type nx:Parameter Source <xs:attribute name="warning" type="boolean"> <xs:annotation> <xs:documentation>A marker to indicate that this parameter may not be reliable (an instrument may have not written it correctly, or it is commonly not filled out properly, etc.)</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Dataset / @type

	Namespace No namespace Annotations A label indicating the type of this dataset (taken from a controlled list). Type nx:DatasetType Properties content simple Facets enumeration Image A 2-D array of data where each value is typically an intensity measurement as function of regularly spaced position enumeration Spectrum A 1-D array of data where each value is typically an intensity measurement as a function of frequency or energy enumeration SpectrumImage A 3-D array of data where each value is typically an intensity measurement as a function of regularly space position along two axes and of frequency or energy along the third. enumeration Diffraction Data that measures a (usually electron) diffraction pattern enumeration Notes Arbitrary textual data that is typically manually created by the Experimenter. enumeration Misc A dataset that does not qualify as of any of the other defined types. Used by Complex Type nx:Dataset Source <xs:attribute name="type" type="nx:DatasetType"> <xs:annotation> <xs:documentation>A label indicating the type of this dataset (taken from a controlled list).</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:Dataset / @role

	Namespace No namespace Annotations A label indicating the experimental role of this dataset (taken from a controlled list). Type nx:DatasetRole Properties content simple Facets enumeration Experimental "Normal" data collected during typical operation of an instrument for experimental purposes enumeration MasterCalibration Reference data collected for the purpose of instrument calibration during instrument service events or by allowed super users enumeration UserCalibration Data collected alongside "Experimental" Datasets by regular users for calibration purposes between service events or for a specific experiment enumeration Derived Data that is not collected form an instrument, but rather derived from raw and/or calibration data as the result of post-acquisition analysis processes Used by Complex Type nx:Dataset Source <xs:attribute name="role" type="nx:DatasetRole"> <xs:annotation> <xs:documentation>A label indicating the experimental role of this dataset (taken from a controlled list).</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:AcquisitionActivity / @seqno

	Namespace No namespace Annotations A number that indicates the order that this Acqusition Activity occurred within a sequence of Acqusition Activities. Type xs:integer Properties content simple Used by Complex Type nx:AcquisitionActivity Source <xs:attribute name="seqno" type="xs:integer"> <xs:annotation> <xs:documentation>A number that indicates the order that this Acqusition Activity occurred within a sequence of Acqusition Activities.</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:TableColumn / @id

	Namespace No namespace Annotations The identifier to assign to this column (for reference by cell elements). Used by Complex Type nx:TableColumn Source <xs:attribute name="id"> <xs:annotation> <xs:documentation>The identifier to assign to this column (for reference by cell elements).</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:TableCell / @colid

	Namespace No namespace Annotations The identifier for the column that this cell corresponds to Used by Complex Type nx:TableCell Source <xs:attribute name="colid"> <xs:annotation> <xs:documentation>The identifier for the column that this cell corresponds to</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

Attribute nx:TableRow / @seqno

	Namespace No namespace Annotations A number that indicates the order that the row appears in the table. Type xs:integer Properties content simple Used by Complex Type nx:TableRow Source <xs:attribute name="seqno" type="xs:integer"> <xs:annotation> <xs:documentation>A number that indicates the order that the row appears in the table.</xs:documentation> </xs:annotation> </xs:attribute>

[ top ]

---

XML Schema documentation generated by <oXygen/>^® XML Developer.

Building the Schema Documentation

To build the above documentation, the Oxygen XML Developer software is needed. The standard XSD -> HTML translator document has been customized to allow embedding within a Sphinx documentation page, and is included in the NexusLIMS repository as _schema_doc_gen/xsdDocHtml.xsl. Using the XML Developer software’s “Generate XML Schema Documentation” feature (available through the Tools -> Generate documenation menu), select the nexus-experiment.xsd schema file as the Schema URL, and select Custom in the Format menu. Under the options for Custom Format, select the _schema_doc_gen/xsdDocHtml.xsl stylesheet as the Custom XSL. Ensure that both check boxes are checked and the Resources field points to _schema_doc_gen/img. After clicking OK, ensure that the Output file is set to schema_doc/nexus-experiment.xsd.html, and click Generate. See the following images for details:

To include the resulting HTML in the main documentation, use a .. raw:: Sphinx directive to include the file directly in an .rst file, such as:

.. raw:: html
    :file: schema_doc/nexus-experiment.xsd.html

1

Certain commercial software is identified only to foster understanding. Such identification does not imply recommendation or endorsement by the National Institute of Standards and Technology, nor does it imply that the product identified is necessarily the best available for the purpose.