Skip to content

Commit

Permalink
Add a reference to NXmpes from NXarpes (#153)
Browse files Browse the repository at this point in the history 
* Add a reference to NXmpes to NXarpes

* Make reference an actual rst link

* Refer to `NXmpes_arpes`

* modify reference to NXmpes_arpes

---------

Co-authored-by: Lukas Pielsticker <[email protected]>
# Conflicts:
#	applications/NXarpes.nxdl.xml
#	applications/nyaml/NXarpes.yaml
  • Loading branch information
@domna @lukaspie
domna authored and lukaspie committed Oct 16, 2024
1 parent 1dcc838 commit ccfb659
Showing 1 changed file with 133 additions and 113 deletions.
246 changes: 133 additions & 113 deletions applications/NXarpes.nxdl.xml
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl" ?>
<?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) 2012-2024 NeXus International Advisory Committee (NIAC)
#
#
# 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
Expand All @@ -21,114 +21,134 @@
#
# For further information, see http://www.nexusformat.org
-->
<definition name="NXarpes" extends="NXobject" type="group"
category="application"
xmlns="http://definition.nexusformat.org/nxdl/3.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
>
<doc>
This is an application definition for angular resolved photo electron spectroscopy.

It has been drawn up with hemispherical electron analysers in mind.
</doc>
<group type="NXentry">
<attribute name="entry">
<doc>
NeXus convention is to use "entry1", "entry2", ...
for analysis software to locate each entry.
</doc>
</attribute>
<field name="title" type="NX_CHAR"/>
<field name="start_time" type="NX_DATE_TIME"/>
<field name="definition">
<doc>Official NeXus NXDL schema to which this file conforms.</doc>
<enumeration>
<item value="NXarpes"></item>
</enumeration>
</field>
<group type="NXinstrument">
<group type="NXsource">
<field name="type" type="NX_CHAR"/>
<field name="name" type="NX_CHAR"/>
<field name="probe">
<enumeration>
<item value="x-ray"/>
</enumeration>
</field>
</group>
<group type="NXmonochromator" name="monochromator">
<field name="energy" type="NX_NUMBER" units="NX_ENERGY"/>
</group>
<group type="NXdetector" name="analyser">
<field name="data" type="NX_NUMBER" />
<field name="lens_mode" type="NX_CHAR">
<doc>setting for the electron analyser lens</doc>
</field>
<field name="acquisition_mode">
<enumeration>
<item value="swept"/>
<item value="fixed"/>
</enumeration>
</field>
<field name="entrance_slit_shape">
<enumeration>
<item value="curved"/>
<item value="straight"/>
</enumeration>
</field>
<field name="entrance_slit_setting" type="NX_NUMBER" units="NX_ANY">
<doc>dial setting of the entrance slit</doc>
</field>
<field name="entrance_slit_size" type="NX_NUMBER" units="NX_LENGTH">
<doc>size of the entrance slit</doc>
</field>
<field name="pass_energy" type="NX_NUMBER" units="NX_ENERGY">
<doc>energy of the electrons on the mean path of the analyser</doc>
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" type="group" name="NXarpes" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<doc>
This is an application definition for angular resolved photo electron spectroscopy.

It has been drawn up with hemispherical electron analysers in mind.

This definition is a legacy support for older NXarpes experiments.
There is, however, a newer definition to collect data &amp; metadata
for general photoemission experiments, called :ref:NXmpes,
as well as a specialization for ARPES experiments, called :ref:NXmpes_arpes."
</doc>
<group type="NXentry">
<attribute name="entry">
<doc>
NeXus convention is to use "entry1", "entry2", ...
for analysis software to locate each entry.
</doc>
</attribute>
<field name="title" type="NX_CHAR"/>
<field name="start_time" type="NX_DATE_TIME"/>
<field name="definition">
<doc>
Official NeXus NXDL schema to which this file conforms.
</doc>
<enumeration>
<item value="NXarpes"/>
</enumeration>
</field>
<field name="time_per_channel" type="NX_NUMBER" units="NX_TIME">
<doc>todo: define more clearly</doc>
</field>
<field name="angles" type="NX_NUMBER" units="NX_ANGLE">
<doc>
Angular axis of the analyser data
which dimension the axis applies to is defined
using the normal NXdata methods.
</doc>
</field>
<field name="energies" type="NX_NUMBER" units="NX_ENERGY">
<doc>
Energy axis of the analyser data
which dimension the axis applies to is defined
using the normal NXdata methods.
</doc>
</field>
<field name="sensor_size" type="NX_INT">
<doc>number of raw active elements in each dimension</doc>
<dimensions rank="1">
<dim index="1" value="2" />
</dimensions>
</field>
<field name="region_origin" type="NX_INT">
<doc>origin of rectangular region selected for readout</doc>
<dimensions rank="1">
<dim index="1" value="2" />
</dimensions>
</field>
<field name="region_size" type="NX_INT">
<doc>size of rectangular region selected for readout</doc>
<dimensions rank="1" >
<dim index="1" value="2" />
</dimensions>
</field>
</group>
</group>
<group type="NXsample">
<field name="name" type="NX_CHAR">
<doc>Descriptive name of sample</doc>
</field>
<field name="temperature" type="NX_NUMBER" units="NX_TEMPERATURE"/>
<group type="NXinstrument">
<group type="NXsource">
<field name="type" type="NX_CHAR"/>
<field name="name" type="NX_CHAR"/>
<field name="probe">
<enumeration>
<item value="x-ray"/>
</enumeration>
</field>
</group>
<group type="NXmonochromator" name="monochromator">
<field name="energy" type="NX_NUMBER" units="NX_ENERGY"/>
</group>
<group type="NXdetector" name="analyser">
<field name="data" type="NX_NUMBER"/>
<field name="lens_mode" type="NX_CHAR">
<doc>
setting for the electron analyser lens
</doc>
</field>
<field name="acquisition_mode">
<enumeration>
<item value="swept"/>
<item value="fixed"/>
</enumeration>
</field>
<field name="entrance_slit_shape">
<enumeration>
<item value="curved"/>
<item value="straight"/>
</enumeration>
</field>
<field name="entrance_slit_setting" type="NX_NUMBER" units="NX_ANY">
<doc>
dial setting of the entrance slit
</doc>
</field>
<field name="entrance_slit_size" type="NX_NUMBER" units="NX_LENGTH">
<doc>
size of the entrance slit
</doc>
</field>
<field name="pass_energy" type="NX_NUMBER" units="NX_ENERGY">
<doc>
energy of the electrons on the mean path of the analyser
</doc>
</field>
<field name="time_per_channel" type="NX_NUMBER" units="NX_TIME">
<doc>
todo: define more clearly
</doc>
</field>
<field name="angles" type="NX_NUMBER" units="NX_ANGLE">
<doc>
Angular axis of the analyser data
which dimension the axis applies to is defined
using the normal NXdata methods.
</doc>
</field>
<field name="energies" type="NX_NUMBER" units="NX_ENERGY">
<doc>
Energy axis of the analyser data
which dimension the axis applies to is defined
using the normal NXdata methods.
</doc>
</field>
<field name="sensor_size" type="NX_INT">
<doc>
number of raw active elements in each dimension
</doc>
<dimensions rank="1">
<dim index="1" value="2"/>
</dimensions>
</field>
<field name="region_origin" type="NX_INT">
<doc>
origin of rectangular region selected for readout
</doc>
<dimensions rank="1">
<dim index="1" value="2"/>
</dimensions>
</field>
<field name="region_size" type="NX_INT">
<doc>
size of rectangular region selected for readout
</doc>
<dimensions rank="1">
<dim index="1" value="2"/>
</dimensions>
</field>
</group>
</group>
<group type="NXsample">
<field name="name" type="NX_CHAR">
<doc>
Descriptive name of sample
</doc>
</field>
<field name="temperature" type="NX_NUMBER" units="NX_TEMPERATURE"/>
</group>
<group type="NXdata"/>
</group>
<group type="NXdata"/>
</group>
</definition>

0 comments on commit ccfb659

Please sign in to comment.