forked from nexusformat/definitions
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #220 from FAIRmat-NFDI/NXopt_overhaul
Overhaul of NXopt
- Loading branch information
Showing
12 changed files
with
2,988 additions
and
1,316 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
<?xml version='1.0' encoding='UTF-8'?> | ||
<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?> | ||
<!-- | ||
# NeXus - Neutron and X-ray Common Data Format | ||
# | ||
# Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC) | ||
# | ||
# This library is free software; you can redistribute it and/or | ||
# modify it under the terms of the GNU Lesser General Public | ||
# License as published by the Free Software Foundation; either | ||
# version 3 of the License, or (at your option) any later version. | ||
# | ||
# This library is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
# Lesser General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU Lesser General Public | ||
# License along with this library; if not, write to the Free Software | ||
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | ||
# | ||
# For further information, see http://www.nexusformat.org | ||
--> | ||
<!-- | ||
A draft of a new base class to describe a window in a optical setup or device--> | ||
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXopt_window" extends="NXaperture" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"> | ||
<doc> | ||
A window of a cryostat, heater, vacuum chamber or a simple glass slide. | ||
|
||
This first verion originates from NXopt to describe cryostate windows | ||
and possible influences for ellipsometry measurements. | ||
|
||
For environmental measurements, the environment (liquid, vapor | ||
etc.) is enclosed in a cell, which has windows both in the | ||
direction of the source (entry window) and the detector (exit | ||
window) (looking from the sample). In case that the entry and exit | ||
windows are not the same type and do not have the same properties, | ||
use a second 'WINDOW(NXaperture)' field. | ||
|
||
The windows also add a phase shift to the light altering the | ||
measured signal. This shift has to be corrected based on measuring | ||
a known sample (reference sample) or the actual sample of interest | ||
in the environmental cell. State if a window correction has been | ||
performed in 'window_effects_corrected'. Reference data should be | ||
considered as a separate experiment, and a link to the NeXus file | ||
should be added in reference_data_link in measured_data. | ||
|
||
The window is considered to be a part of the sample stage but also | ||
beam path. Hence, its position within the beam path should be | ||
defined by the 'depends_on' field. | ||
</doc> | ||
<group type="NXentry"> | ||
<field name="window_effects_corrected" type="NX_BOOLEAN"> | ||
<doc> | ||
Was a window correction performed? If 'True' describe the window | ||
correction procedure in 'window_correction/procedure'. | ||
</doc> | ||
</field> | ||
<group name="window_correction" type="NXprocess"> | ||
<doc> | ||
Was a window correction performed? If 'True' describe the | ||
window correction procedure in '' | ||
</doc> | ||
<field name="procedure"> | ||
<doc> | ||
Describe when (before or after the main measurement + time | ||
stamp in 'date') and how the window effects have been | ||
corrected, i.e. either mathematically or by performing a | ||
reference measurement. In the latter case, provide the link to | ||
to the reference data in 'reference_data_link'. | ||
</doc> | ||
</field> | ||
<field name="reference_data_link"> | ||
<doc> | ||
Link to the NeXus file which describes the reference data if a | ||
reference measurement for window correction was performed. | ||
Ideally, the reference measurement was performed on a reference | ||
sample and on the same sample, and using the same conditions as | ||
for the actual measurement with and without windows. It should | ||
have been conducted as close in time to the actual measurement | ||
as possible. | ||
</doc> | ||
</field> | ||
</group> | ||
<field name="material" type="NX_CHAR"> | ||
<doc> | ||
The material of the window. | ||
</doc> | ||
<enumeration> | ||
<item value="quartz"/> | ||
<item value="diamond"/> | ||
<item value="calcium fluoride"/> | ||
<item value="zinc selenide"/> | ||
<item value="thallium bromoiodide"/> | ||
<item value="alkali halide compound"/> | ||
<item value="Mylar"/> | ||
<item value="other"/> | ||
</enumeration> | ||
</field> | ||
<field name="material_other" type="NX_CHAR"> | ||
<doc> | ||
If you specified 'other' as material, decsribe here what it is. | ||
</doc> | ||
</field> | ||
<field name="thickness" type="NX_FLOAT" units="NX_LENGTH"> | ||
<doc> | ||
Thickness of the window. | ||
</doc> | ||
</field> | ||
<field name="orientation_angle" type="NX_FLOAT" units="NX_ANGLE"> | ||
<doc> | ||
Angle of the window normal (outer) vs. the substrate normal | ||
(similar to the angle of incidence). | ||
</doc> | ||
</field> | ||
</group> | ||
</definition> |
Oops, something went wrong.