2.3.3.3.90. NXem

Status:

application definition (contribution), extends NXobject

Description:

Application definition for normalized representation of electron microscopy rese ...

Application definition for normalized representation of electron microscopy research.

This application definition is a comprehensive example for a general description with which to normalize specific (meta)data collected from the research field of electron microscopy

NXem is designed to be used for documenting experiments or computer simulations in which controlled electron beams are used for studying electron-beam matter interaction to explore physical mechanisms and phenomena or to characterize materials with an electron microscope.

Symbols:

No symbol table

Groups cited:

NXaberration, NXactuator, NXaperture, NXatom, NXbeam, NXcite, NXcomponent, NXcoordinate_system, NXcorrector_cs, NXcs_profiling, NXdata, NXdeflector, NXdetector, NXebeam_column, NXem_ebsd, NXem_eds, NXem_eels, NXem_img, NXentry, NXevent_data_em, NXfabrication, NXibeam_column, NXimage, NXinstrument_em, NXlens_em, NXmanipulator, NXmicrostructure_ipf, NXmicrostructure_odf, NXmicrostructure_pf, NXmicrostructure, NXmonochromator, NXnote, NXobject, NXoptical_system_em, NXphase, NXprocess, NXprogram, NXpump, NXsample, NXscanbox_em, NXsensor, NXsource, NXspectrum, NXunit_cell, NXuser

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR

Obligatory value: NXem

experiment_alias: (optional) NX_CHAR

Alias (short name) which scientists can use to refer to this experiment.

experiment_description: (optional) NX_CHAR

Free-text description about the experiment. ...

Free-text description about the experiment.

Users are strongly advised to parameterize the description of their experiment by using respective groups and fields and base classes instead of writing prose into the field. The reason is that such free-text field is difficult to machine-interpret. The motivation behind keeping this field for now is to learn in how far the current base classes need extension based on user feedback.

start_time: (required) NX_DATE_TIME

ISO 8601 time code with local time zone offset to UTC information included ...

ISO 8601 time code with local time zone offset to UTC information included when the microscope session started. If the application demands that time codes in this section of the application definition should only be used for specifying when the experiment was performed - and the exact duration is not relevant - use this start_time field.

Often though it is useful to specify a time interval via setting both a start_time and an end_time because this enables software tools and users to collect a more detailed bookkeeping of the experiment.

Users should be aware though that even using only start_time and end_time may not be sufficient to infer how long the experiment took or for how long data were acquired. To bookkeep more fine-grained timestamps over the course of the experiment is possible with start_time and end_time fields of respective NXevent_data_em instances.

end_time: (recommended) NX_DATE_TIME

ISO 8601 time code with local time zone offset to UTC included when ...

ISO 8601 time code with local time zone offset to UTC included when the microscope session ended.

See docstring of the start_time field to see how to use the start_time and end_time together.

profiling: (optional) NXcs_profiling

The configuration of the software that was used to generate this NeXus file.

PROGRAM: (optional) NXprogram

A collection of all programs and libraries that are considered as relevant ...

A collection of all programs and libraries that are considered as relevant to understand with which software tools this NeXus file instance was generated. Ideally, to enable a binary recreation from the input data.

Examples include the name and version of the libraries used to write the instance. Ideally, the software which writes these NXprogram instances also includes the version of the set of NeXus classes i.e. the specific set of base classes, application definitions, and contributed definitions with which the here described concepts can be resolved.

For the pynxtools library which is used by the NOMAD research data management system, it makes sense to store e.g. the GitHub repository commit and respective submodule references used.

Instances can also be used to document the modules and libraries that are offered by the computational environment such as those parsed from conda or python virtualenv environments.

program: (required) NX_CHAR

@version: (required) NX_CHAR

CITE: (optional) NXcite

NOTE: (optional) NXnote

Collection of serialized resources associated with the experiment. ...

Collection of serialized resources associated with the experiment.

An example how to use this set is to document from which files in formatting of technology partners, the (meta)data in an instance of NXem were filled with during parsing to NeXus.

type: (required) NX_CHAR

file_name: (required) NX_CHAR

checksum: (required) NX_CHAR

algorithm: (required) NX_CHAR

USER: (optional) NXuser

Information about persons who performed or were involved in the microscope ...

Information about persons who performed or were involved in the microscope session or simulation run.

Examples could be to put here the principle investigator who performed this experiment or students who performed simulations to name but a few. Adding multiple users if relevant is recommended.

The protection of personal data by laws is in different stages of development and strictness. Therefore, the existence of user data has not been made required.

Instances should use user as a name prefix.

identifierNAME: (recommended) NX_CHAR

@type: (required) NX_CHAR

name: (optional) NX_CHAR

Given (first) name and surname.

affiliation: (optional) NX_CHAR

Name of the affiliation at the point in time when the experiment was performed.

address: (optional) NX_CHAR

Postal address of the affiliation.

email: (optional) NX_CHAR

Email address at the point in time when the experiment was performed. ...

Email address at the point in time when the experiment was performed.

Writing the most permanently used email is recommended.

telephone_number: (optional) NX_CHAR

Telephone number at the point in time when the experiment was performed.

role: (optional) NX_CHAR

User role at the point in time when the experiment was performed. ...

User role at the point in time when the experiment was performed.

Examples are technician operating the microscope, student, postdoc, principle investigator, or guest.

SAMPLE: (required) NXsample

A physical entity which contains material intended to be investigated. ...

A physical entity which contains material intended to be investigated. Sample and specimen are treated as de facto synonyms. Samples can be real or virtual ones as annotated via is_simulation.

The suggested best practice is to call this group sample. In those cases when multiple samples need to be grouped inside one entry, these SAMPLE groups should be named using the prefix sample followed an index starting from 1, i.e. (sample1, sample2).

There are at least two strategies how to store (meta)data when one analyzes multiple samples - not different ROIs on a single sample though - in one session.

One strategy is to store each sample and its results under an own NXem/ENTRY. This is one of the most frequent use cases as during most sessions typically only a single sample is investigated. In this case the name of this group should be NXem/ENTRY/sample.

If multiple samples are investigated storing each of them in an own ENTRY group eventually will demand an unnecessary duplication though of many details about the instrument.

This can be avoided by using another strategy how to store all samples and their results. Namely, by using only one instance of NXem/ENTRY. That NXem/ENTRY should then be named, like in the previous case, NXem/entry1 and the samples should be named sample1, sample2, etc., i.e. instances should use sample as a name prefix.

In this case though the collection of events demands to use identifier_sample to state clearly for which of the samples loaded the (characterization) event was detected.

This concept is related to term Specimen of the EMglossary standard.

is_simulation: (required) NX_BOOLEAN

Qualifier whether the sample is a real (in which case is_simulation should ...

Qualifier whether the sample is a real (in which case is_simulation should be set to false) or a virtual one (in which case is_simulation should be set to true).

physical_form: (recommended) NX_CHAR

Any of these values or a custom value (if you use a custom value, also set @custom=True): bulk | foil | thin_film | powder

identifier_sample: (recommended) NX_CHAR

Ideally, (globally) unique persistent identifier which distinguishes this ...

Ideally, (globally) unique persistent identifier which distinguishes this sample from all others and especially the predecessor/origin from where that sample was cut. The terms sample and specimen are here considered as exact synonyms.

This field must not be used for an alias for the sample! Instead, use name.

In cases where multiple specimens were loaded into the microscope, the identifier has to resolve the specific sample, whose results are stored by this NXentry instance because a single NXentry should be used for the characterization of a single specimen.

Details about the specimen preparation should be stored in resources referring to identifier_parent.

@type: (required) NX_CHAR

identifier_parent: (recommended) NX_CHAR

Identifier of the sample from which the sample was cut or the string *None ...

Identifier of the sample from which the sample was cut or the string None, i.e. the parent to this sample.

The purpose of this field is to support functionalities for tracking sample provenance in a research data management system.

@type: (required) NX_CHAR

preparation_date: (required) NX_DATE_TIME

ISO 8601 time code with local time zone offset to UTC information ...

ISO 8601 time code with local time zone offset to UTC information when the specimen was prepared.

Ideally, report the end of the preparation, i.e. the last known timestamp when the measured specimen surface was actively prepared. Ideally, this matches the last timestamp that is mentioned in the digital resource pointed to by identifier_parent.

Knowing when the specimen was exposed to e.g. specific atmosphere is especially required for material that is sensitive to the environment such as specimens that were charged with fast diffusing elements or short-lived radioactive tracers.

Additional time stamps prior to preparation_date should better be placed in resources which describe but do not pollute the description here with prose. Resolving these connected metadata is considered as within the responsibility of the research data management system and not the a NeXus file.

name: (recommended) NX_CHAR

An alias used to refer to the specimen to please readability for humans.

atom_types: (required) NX_CHAR

List of comma-separated elements from the periodic table that are containe ...

List of comma-separated elements from the periodic table that are contained in the sample. If the sample substance has multiple components, all elements from each component must be included in atom_types.

The purpose of the field is to offer research data management systems an opportunity to parse the relevant elements without having to interpret these from the resources pointed to by identifier_parent or walk through eventually deeply nested groups in individual data instances.

thickness: (optional) NX_NUMBER {units=NX_LENGTH}

(Measured) sample thickness. ...

(Measured) sample thickness.

The information is recorded to qualify if the beam used was likely able to shine through the specimen. For scanning electron microscopy, in many cases the specimen is typically thicker than what is illuminatable by the electron beam.

In this case the value should be set to the actual thickness of the specimen viewed for an illumination situation where the nominal surface normal of the specimen is parallel to the optical axis.

density: (optional) NX_NUMBER {units=NX_ANY}

(Measured) density of the specimen. ...

(Measured) density of the specimen.

For multi-layered specimens this field should only be used to describe the density of the excited volume. For scanning electron microscopy the usage of this field is discouraged and instead an instance of a region-of-interest within connection to individual NXevent_data_em instances can provide a cleaner description of the relevant details why one may wish to store the density of the specimen.

description: (optional) NX_CHAR

Discouraged free-text field to provide further detail.

consistent_rotations: (recommended) NXobject

The conventions used when reporting crystal orientations. ...

The conventions used when reporting crystal orientations. We follow the best practices of the Material Science community that are defined in reference https://doi.org/10.1088/0965-0393/23/8/083501.

rotation_handedness: (required) NX_CHAR

Convention how a positive rotation angle is defined when viewing ...

Convention how a positive rotation angle is defined when viewing from the end of the rotation unit vector towards its origin. This is in accordance with convention 2 of reference https://doi.org/10.1088/0965-0393/23/8/083501.

Counter_clockwise is equivalent to a right-handed choice. Clockwise is equivalent to a left-handed choice.

Any of these values: counter_clockwise | clockwise

rotation_convention: (required) NX_CHAR

How are rotations interpreted into an orientation according to convention ...

How are rotations interpreted into an orientation according to convention 3 of reference https://doi.org/10.1088/0965-0393/23/8/083501.

Any of these values: passive | active

euler_angle_convention: (required) NX_CHAR

How are Euler angles interpreted given that there are several choices (e.g ...

How are Euler angles interpreted given that there are several choices (e.g. zxz, xyz) according to convention 4 of reference https://doi.org/10.1088/0965-0393/23/8/083501.

The most frequently used convention is zxz, which is based on the work of H.-J. Bunge but other conventions are possible. Apart from undefined, proper Euler angles are distinguished from (improper) Tait-Bryan angles.

Any of these values:

  • zxz

  • xyx

  • yzy

  • zyz

  • xzx

  • yxy

  • xyz

  • yzx

  • zxy

  • xzy

  • zyx

  • yxz

axis_angle_convention: (required) NX_CHAR

To which angular range is the rotation angle argument of an ...

To which angular range is the rotation angle argument of an axis-angle pair parameterization constrained according to convention 5 of reference https://doi.org/10.1088/0965-0393/23/8/083501.

Obligatory value: rotation_angle_on_interval_zero_to_pi

sign_convention: (required) NX_CHAR

Which sign convention is followed when converting orientations ...

Which sign convention is followed when converting orientations between different parametrizations/representations according to convention 6 of reference https://doi.org/10.1088/0965-0393/23/8/083501.

Any of these values: p_plus_one | p_minus_one

COORDINATE_SYSTEM: (required) NXcoordinate_system

alias: (optional) NX_CHAR

type: (required) NX_CHAR

handedness: (required) NX_CHAR

origin: (required) NX_CHAR

processing_reference_frame: (recommended) NXcoordinate_system

alias: (optional) NX_CHAR

type: (required) NX_CHAR

handedness: (required) NX_CHAR

origin: (recommended) NX_CHAR

Location of the origin of the processing_reference_frame. ...

Location of the origin of the processing_reference_frame.

It is assumed that regions-of-interest in this reference frame form a rectangle or cuboid. Edges are interpreted by inspecting the direction of their outer unit normals (which point either parallel or antiparallel) along respective base vector direction of the reference frame.

If any of these assumptions is not met, the user is required to explicitly state this.

Any of these values:

  • front_top_left

  • front_top_right

  • front_bottom_right

  • front_bottom_left

  • back_top_left

  • back_top_right

  • back_bottom_right

  • back_bottom_left

x_direction: (recommended) NX_CHAR

Direction of the positively pointing x-axis base vector of the ...

Direction of the positively pointing x-axis base vector of the processing_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

y_direction: (recommended) NX_CHAR

Direction of the positively pointing y-axis base vector of the ...

Direction of the positively pointing y-axis base vector of the processing_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

z_direction: (recommended) NX_CHAR

Direction of the positively pointing z-axis base vector of the ...

Direction of the positively pointing z-axis base vector of the processing_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

sample_reference_frame: (recommended) NXcoordinate_system

depends_on: (optional) NX_CHAR

Reference to the specifically named :ref:`NXsample` instance(s) for ...

Reference to the specifically named NXsample instance(s) for which these conventions apply (e.g. /entry1/sample1).

alias: (optional) NX_CHAR

type: (required) NX_CHAR

handedness: (required) NX_CHAR

origin: (recommended) NX_CHAR

Location of the origin of the sample_reference_frame. ...

Location of the origin of the sample_reference_frame.

It is assumed that regions-of-interest in this reference frame form a rectangle or cuboid. Edges are interpreted by inspecting the direction of their outer unit normals (which point either parallel or antiparallel) along respective base vector direction of the reference frame.

If any of these assumptions is not met, the user is required to explicitly state this.

Any of these values:

  • front_top_left

  • front_top_right

  • front_bottom_right

  • front_bottom_left

  • back_top_left

  • back_top_right

  • back_bottom_right

  • back_bottom_left

x_direction: (recommended) NX_CHAR

Direction of the positively pointing x-axis base vector of the ...

Direction of the positively pointing x-axis base vector of the sample_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

y_direction: (recommended) NX_CHAR

Direction of the positively pointing y-axis base vector of the ...

Direction of the positively pointing y-axis base vector of the sample_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

z_direction: (recommended) NX_CHAR

Direction of the positively pointing z-axis base vector of the ...

Direction of the positively pointing z-axis base vector of the sample_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

DETECTOR_REFERENCE_FRAME: (optional) NXcoordinate_system

Instances should use detector_reference_frame as a name prefix.

depends_on: (optional) NX_CHAR

Reference to the specifically named :ref:`NXdetector` instance for ...

Reference to the specifically named NXdetector instance for which these conventions apply (e.g. /entry1/instrument/detector1).

Instances should use detector_reference_frame as a name prefix.

alias: (optional) NX_CHAR

type: (required) NX_CHAR

handedness: (required) NX_CHAR

origin: (recommended) NX_CHAR

Location of the origin of the detector_reference_frame. ...

Location of the origin of the detector_reference_frame.

If the regions-of-interest forms a rectangle or cuboid, it is assumed that edges are interpreted by inspecting the direction of their outer unit normals (which point either parallel or antiparallel) along respective base vector direction of the reference frame.

If any of these assumptions is not met, the user is required to explicitly state this.

Any of these values:

  • front_top_left

  • front_top_right

  • front_bottom_right

  • front_bottom_left

  • back_top_left

  • back_top_right

  • back_bottom_right

  • back_bottom_left

x_direction: (recommended) NX_CHAR

Direction of the positively pointing x-axis base vector of the ...

Direction of the positively pointing x-axis base vector of the detector_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

y_direction: (recommended) NX_CHAR

Direction of the positively pointing y-axis base vector of the ...

Direction of the positively pointing y-axis base vector of the detector_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

z_direction: (recommended) NX_CHAR

Direction of the positively pointing z-axis base vector of the ...

Direction of the positively pointing z-axis base vector of the detector_reference_frame.

Any of these values:

  • north

  • east

  • south

  • west

  • in

  • out

measurement: (optional) NXobject

instrument: (required) NXinstrument_em

name: (recommended) NX_CHAR

location: (recommended) NX_CHAR

type: (recommended) NX_CHAR

fabrication: (required) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

PROGRAM: (recommended) NXprogram

Details about the control program used for operating the microscope. ...

Details about the control program used for operating the microscope.

Instances should use control_software as a name prefix.

program: (required) NX_CHAR

@version: (required) NX_CHAR

ebeam_column: (required) NXebeam_column

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

electron_source: (recommended) NXsource

emitter_type: (required) NX_CHAR

probe: (optional) NX_CHAR

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

LENS_EM: (optional) NXlens_em

Instances should use lens as a name prefix.

name: (required) NX_CHAR

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

APERTURE: (optional) NXaperture

Instances should use aperture as a name prefix.

name: (required) NX_CHAR

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

MONOCHROMATOR: (optional) NXmonochromator

Instances should use monochromator as a name prefix.

type: (required) NX_CHAR

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

corrector_cs: (optional) NXcorrector_cs

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

corrector_ax: (optional) NXcomponent

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

BIPRISM: (optional) NXcomponent

Instances should use biprism as a name prefix.

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

PHASEPLATE: (optional) NXcomponent

Instances should use phaseplate as a name prefix.

type: (required) NX_CHAR

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

SENSOR: (optional) NXsensor

Instances should use sensor as a name prefix.

ACTUATOR: (optional) NXactuator

Instances should use actuator as a name prefix.

BEAM: (optional) NXbeam

Instances should use beam as a name prefix.

DEFLECTOR: (optional) NXdeflector

Instances should use deflector as a name prefix.

ibeam_column: (optional) NXibeam_column

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

ion_source: (required) NXsource

emitter_type: (required) NX_CHAR

probe: (required) NXatom

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

LENS_EM: (optional) NXlens_em

Instances should use lens as a name prefix.

name: (required) NX_CHAR

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

APERTURE: (optional) NXaperture

Instances should use aperture as a name prefix.

name: (required) NX_CHAR

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

MONOCHROMATOR: (optional) NXmonochromator

Instances should use monochromator as a name prefix.

fabrication: (optional) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

SENSOR: (optional) NXsensor

Instances should use sensor as a name prefix.

ACTUATOR: (optional) NXactuator

Instances should use actuator as a name prefix.

BEAM: (optional) NXbeam

Instances should use beam as a name prefix.

DEFLECTOR: (optional) NXdeflector

Instances should use deflector as a name prefix.

DETECTOR: (optional) NXdetector

Instances should use detector as a name prefix.

name: (required) NX_CHAR

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

scan_controller: (optional) NXscanbox_em

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

stage: (optional) NXmanipulator

design: (recommended) NX_CHAR

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

nanoprobe: (optional) NXmanipulator

fabrication: (recommended) NXfabrication

vendor: (required) NX_CHAR

model: (required) NX_CHAR

serial_number: (recommended) NX_CHAR

PUMP: (optional) NXpump

Instances should use pump as a name prefix.

design: (required) NX_CHAR

SENSOR: (optional) NXsensor

Instances should use sensor as a name prefix.

ACTUATOR: (optional) NXactuator

Instances should use actuator as a name prefix.

events: (optional) NXobject

EVENT_DATA_EM: (optional) NXevent_data_em

Instances should use event as a name prefix.

start_time: (recommended) NX_DATE_TIME

end_time: (recommended) NX_DATE_TIME

identifier_sample: (recommended) NX_CHAR

IMAGE: (optional) NXimage

Instances should use image as a name prefix. ...

Instances should use image as a name prefix. Each NXimage instance must use only one image or stack instance.

PROCESS: (recommended) NXprocess

identifier_detector: (required) NX_CHAR

input: (recommended) NXnote

type: (required) NX_CHAR

file_name: (required) NX_CHAR

checksum: (required) NX_CHAR

algorithm: (required) NX_CHAR

context: (required) NX_CHAR

image_1d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

real: (required) NX_NUMBER

@long_name: (required) NX_CHAR

imag: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

magnitude: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

intensity: (optional) NX_COMPLEX

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

image_2d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

real: (required) NX_NUMBER

@long_name: (required) NX_CHAR

imag: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

magnitude: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

intensity: (optional) NX_COMPLEX

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

image_3d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

real: (required) NX_NUMBER

@long_name: (required) NX_CHAR

imag: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

magnitude: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

intensity: (optional) NX_COMPLEX

@long_name: (required) NX_CHAR

axis_k: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_1d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

real: (required) NX_NUMBER

@long_name: (required) NX_CHAR

imag: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

magnitude: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

intensity: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_group: (optional) NX_INT

@long_name: (required) NX_CHAR

identifier_image: (required) NX_INT

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_2d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

real: (required) NX_NUMBER

@long_name: (required) NX_CHAR

imag: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

magnitude: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

intensity: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_group: (optional) NX_INT

@long_name: (required) NX_CHAR

identifier_image: (required) NX_INT

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_3d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

real: (required) NX_NUMBER

@long_name: (required) NX_CHAR

imag: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

magnitude: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

intensity: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_group: (optional) NX_INT

@long_name: (required) NX_CHAR

identifier_image: (required) NX_INT

@long_name: (required) NX_CHAR

axis_k: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

SPECTRUM: (optional) NXspectrum

Instances should use spectrum as a name prefix. ...

Instances should use spectrum as a name prefix. Each NXspectrum instance must use only one spectrum or stack instance.

PROCESS: (recommended) NXprocess

identifier_detector: (required) NX_CHAR

input: (recommended) NXnote

type: (required) NX_CHAR

file_name: (required) NX_CHAR

checksum: (required) NX_CHAR

algorithm: (required) NX_CHAR

context: (required) NX_CHAR

spectrum_0d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

spectrum_1d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

spectrum_2d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

spectrum_3d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_k: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_0d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_spectrum: (required) NX_INT

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_1d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_spectrum: (required) NX_INT

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_2d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_spectrum: (required) NX_INT

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

stack_3d: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@long_name: (required) NX_CHAR

identifier_spectrum: (required) NX_INT

@long_name: (required) NX_CHAR

axis_k: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_energy: (required) NX_NUMBER

@long_name: (required) NX_CHAR

instrument: (recommended) NXinstrument_em

ebeam_column: (required) NXebeam_column

operation_mode: (required) NX_CHAR

electron_source: (optional) NXsource

voltage: (required) NX_NUMBER

extraction_voltage: (optional) NX_NUMBER

emission_current: (optional) NX_NUMBER

filament_current: (optional) NX_NUMBER

LENS_EM: (optional) NXlens_em

Instances should use lens as a name prefix.

power_setting: (required) NX_CHAR_OR_NUMBER

APERTURE: (optional) NXaperture

Instances should use aperture as a name prefix.

setting: (recommended) NX_CHAR_OR_NUMBER

Descriptor for the aperture setting when the exact technical det ...

Descriptor for the aperture setting when the exact technical details are unknown or not directly controllable as the control software of the microscope does not enable or was not configured to display these values for users.

MONOCHROMATOR: (optional) NXmonochromator

Instances should use monochromator as a name prefix.

applied: (required) NX_BOOLEAN

dispersion: (recommended) NX_NUMBER

voltage: (recommended) NX_NUMBER

corrector_cs: (optional) NXcorrector_cs

applied: (recommended) NX_BOOLEAN

TABLEAU: (required) NXprocess

Instances should use tableau as a name prefix.

c_1: (optional) NXaberration

magnitude: (required) NX_NUMBER

a_1: (optional) NXaberration

magnitude: (required) NX_NUMBER

b_2: (optional) NXaberration

magnitude: (required) NX_NUMBER

a_2: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_3: (optional) NXaberration

magnitude: (required) NX_NUMBER

s_3: (optional) NXaberration

magnitude: (required) NX_NUMBER

a_3: (optional) NXaberration

magnitude: (required) NX_NUMBER

b_4: (optional) NXaberration

magnitude: (required) NX_NUMBER

d_4: (optional) NXaberration

magnitude: (required) NX_NUMBER

a_4: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5: (optional) NXaberration

magnitude: (required) NX_NUMBER

s_5: (optional) NXaberration

magnitude: (required) NX_NUMBER

r_5: (optional) NXaberration

magnitude: (required) NX_NUMBER

a_6: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_1_0: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_1_2_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_1_2_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_2_1_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_2_1_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_2_3_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_2_3_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_3_0: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_3_2_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_3_2_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_3_4_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_3_4_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_4_1_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_4_1_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_4_3_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_4_3_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_4_5_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_4_5_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_0: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_2_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_2_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_4_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_4_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_6_a: (optional) NXaberration

magnitude: (required) NX_NUMBER

c_5_6_b: (optional) NXaberration

magnitude: (required) NX_NUMBER

corrector_ax: (optional) NXcomponent

applied: (required) NX_BOOLEAN

value_x: (required) NX_NUMBER

value_y: (required) NX_NUMBER

SENSOR: (optional) NXsensor

Instances should use sensor as a name prefix.

ACTUATOR: (optional) NXactuator

Instances should use actuator as a name prefix.

BEAM: (optional) NXbeam

Instances should use beam as a name prefix.

DEFLECTOR: (optional) NXdeflector

Instances should use deflector as a name prefix.

ibeam_column: (optional) NXibeam_column

ion_source: (required) NXsource

voltage: (required) NX_NUMBER

flux: (required) NX_NUMBER

probe: (required) NXatom

LENS_EM: (optional) NXlens_em

Instances should use lens as a name prefix.

power_setting: (required) NX_CHAR_OR_NUMBER

APERTURE: (optional) NXaperture

Instances should use aperture as a name prefix.

setting: (required) NX_CHAR_OR_NUMBER

Descriptor for the aperture setting when the exact technical det ...

Descriptor for the aperture setting when the exact technical details are unknown or not directly controllable as the control software of the microscope does not enable or was not configured to display these values for users.

MONOCHROMATOR: (optional) NXmonochromator

Instances should use monochromator as a name prefix.

applied: (required) NX_BOOLEAN

SENSOR: (optional) NXsensor

Instances should use sensor as a name prefix.

ACTUATOR: (optional) NXactuator

Instances should use actuator as a name prefix.

BEAM: (optional) NXbeam

Instances should use beam as a name prefix.

DEFLECTOR: (optional) NXdeflector

Instances should use deflector as a name prefix.

DETECTOR: (optional) NXdetector

Instances should use detector as a name prefix.

mode: (required) NX_CHAR

Operation mode of the detector as displayed by the control software.

scan_controller: (optional) NXscanbox_em

scan_schema: (required) NX_CHAR

dwell_time: (required) NX_NUMBER

SENSOR: (optional) NXsensor

Instances should use sensor as a name prefix.

ACTUATOR: (optional) NXactuator

Instances should use actuator as a name prefix.

stage: (optional) NXmanipulator

design: (recommended) NX_CHAR

tilt1: (required) NX_NUMBER

tilt2: (required) NX_NUMBER

rotation: (required) NX_NUMBER

position: (required) NX_NUMBER

sample_heater: (optional) NXactuator

physical_quantity: (required) NX_CHAR

heater_current: (optional) NX_NUMBER {units=NX_CURRENT}

Nominal current of the heater.

heater_voltage: (optional) NX_NUMBER {units=NX_VOLTAGE}

Nominal voltage of the heater.

heater_power: (required) NX_NUMBER {units=NX_POWER}

optics: (recommended) NXoptical_system_em

SIMULATION: (optional) NXobject

Possibility for documenting a set of simulations of electron beam matter int ...

Possibility for documenting a set of simulations of electron beam matter interaction.

Instances should use simulation as a name prefix.

PROGRAM: (recommended) NXprogram

The program with which the simulation was performed.

program: (required) NX_CHAR

@version: (required) NX_CHAR

environment: (recommended) NXobject

Programs and libraries representing the computational environment

PROGRAM: (required) NXprogram

program: (required) NX_CHAR

@version: (required) NX_CHAR

config: (optional) NXobject

Configuration of the simulation

results: (optional) NXobject

Results of the simulation

IMAGE: (optional) NXimage

SPECTRUM: (optional) NXspectrum

INTERACTION_VOLUME: (optional) NXobject

Description of the volume of interaction between of particle-matter inte ...

Description of the volume of interaction between of particle-matter interaction.

Computer models like Monte Carlo or molecular dynamics / electron- or ion-beam interaction simulations can be used to qualify and (or) quantify the shape of the interaction volume. Results of such simulations can be summary statistics or single-particle-resolved sets of trajectories.

Explicit or implicit descriptions of the geometry of this interaction volume are possible:

  • An implicit description is via a set of electron/specimen interactions represented ideally as trajectory data from the computer simulation.

  • An explicit description is via iso-contour surface using either a simulation grid or a triangulated surface mesh of the approximated iso-contour surface evaluated at specific threshold values. Iso-contours could be computed from electron or particle flux through an imaginary control surface (the iso-surface) or energy-levels (e.g. the case of X-rays). Details depend on the model.

  • Another explicit description is via theoretical models which may be relevant e.g. for X-ray spectroscopy

Further details on how the interaction volume can be quantified is available in the literature for example:

Instances should use interaction_volume as a name prefix.

DATA: (recommended) NXdata

PROCESS: (recommended) NXprocess

ROI: (optional) NXobject

A region-of-interest analyzed either during or after the session for which s ...

A region-of-interest analyzed either during or after the session for which specific processed data are available. Instances should use roi as a name prefix.

This concept is related to term Region Of Interest of the EMglossary standard.

img: (optional) NXem_img

IMAGE: (required) NXimage

Instances should use image as a name prefix. ...

Instances should use image as a name prefix. Each NXimage instance must use only one image or stack instance.

imaging_mode: (required) NX_CHAR

MICROSTRUCTURE: (optional) NXmicrostructure

ebsd: (optional) NXem_ebsd

gnomonic_reference_frame: (optional) NXcoordinate_system

alias: (optional) NX_CHAR

type: (required) NX_CHAR

handedness: (required) NX_CHAR

origin: (required) NX_CHAR

x_direction: (required) NX_CHAR

y_direction: (required) NX_CHAR

z_direction: (required) NX_CHAR

pattern_centre: (recommended) NXprocess

x_boundary_convention: (required) NX_CHAR

x_normalization_direction: (required) NX_CHAR

y_boundary_convention: (required) NX_CHAR

y_normalization_direction: (required) NX_CHAR

measurement: (optional) NXprocess

depends_on: (required) NX_CHAR

source: (required) NXnote

type: (required) NX_CHAR

file_name: (required) NX_CHAR

checksum: (required) NX_CHAR

algorithm: (required) NX_CHAR

simulation: (optional) NXprocess

depends_on: (required) NX_CHAR

source: (required) NXnote

type: (required) NX_CHAR

file_name: (required) NX_CHAR

checksum: (required) NX_CHAR

algorithm: (required) NX_CHAR

calibration: (recommended) NXprocess

indexing: (optional) NXprocess

number_of_scan_points: (required) NX_UINT

indexing_rate: (recommended) NX_NUMBER

source: (optional) NXnote

type: (required) NX_CHAR

file_name: (required) NX_CHAR

checksum: (required) NX_CHAR

algorithm: (required) NX_CHAR

PHASE: (optional) NXphase

Instances should use phase as a name prefix.

name: (recommended) NX_CHAR

number_of_scan_points: (required) NX_UINT

unit_cell: (required) NXunit_cell

a_b_c: (required) NX_NUMBER

alpha_beta_gamma: (required) NX_NUMBER

space_group: (required) NX_CHAR

IPF: (recommended) NXmicrostructure_ipf

projection_direction: (required) NX_NUMBER

map: (required) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

data: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_x: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_y: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

axis_z: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

legend: (required) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

data: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_x: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_y: (required) NX_NUMBER

@long_name: (required) NX_CHAR

ODF: (optional) NXmicrostructure_odf

PF: (optional) NXmicrostructure_pf

MICROSTRUCTURE: (optional) NXmicrostructure

roi: (recommended) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

descriptor: (required) NX_CHAR

data: (required) NX_NUMBER

axis_z: (optional) NX_NUMBER

@long_name: (required) NX_CHAR

axis_y: (required) NX_NUMBER

@long_name: (required) NX_CHAR

axis_x: (required) NX_NUMBER

@long_name: (required) NX_CHAR

eds: (optional) NXem_eds

indexing: (required) NXprocess

atom_types: (required) NX_CHAR

summary: (optional) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

axis_energy: (required) NX_CHAR

@long_name: (required) NX_CHAR

IMAGE: (optional) NXimage

iupac_line_candidates: (recommended) NX_CHAR

energy_range: (required) NX_NUMBER

image_2d: (required) NXdata

@signal: (required) NX_CHAR

@axes: (required) NX_CHAR

@AXISNAME_indices: (required) NX_UINT

title: (recommended) NX_CHAR

intensity: (required) NX_NUMBER

@units: (recommended) NX_CHAR

axis_i: (required) NX_NUMBER

@long_name: (required) NX_CHAR

@units: (required) NX_CHAR

axis_j: (required) NX_NUMBER

@long_name: (required) NX_CHAR

@units: (required) NX_CHAR

eels: (optional) NXem_eels

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXem.nxdl.xml