Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FAIRmat 2024: small additions to NXsource #1407

Merged
merged 20 commits into from
Dec 10, 2024
Merged

FAIRmat 2024: small additions to NXsource #1407

Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
3210f34
Readds mpes relevant changes from 4b064d9
domna Aug 15, 2023
eae8fb7
Regeneration of the nexus file for fixing the changes coming from old…
RubelMozumder Aug 24, 2023
7a58238
Add NXfabrication to all MPES instrument-related base classes
lukaspie Sep 27, 2023
3d03755
Create nxdls
domna Oct 18, 2023
a41a47e
Make NXDLs
lukaspie Oct 25, 2023
80ee17b
review MPES-related docstrings
lukaspie Jan 12, 2024
d2b4afc
remove center_wavelength, bunch_numbers
lukaspie Feb 9, 2024
7f1e226
remove photon energy, add wavelength
lukaspie Feb 9, 2024
57cd626
readd NXsource/pulse_energy
lukaspie Feb 29, 2024
103fbf9
remake NXsource.nxdl.xml
lukaspie Mar 4, 2024
c8c4100
additions to NXsource and NXdeflector
lukaspie Apr 2, 2024
330e20c
add unit categories to new fields in NXsource
lukaspie Apr 10, 2024
5976080
format base classes and applications in accordance to existing NIAC v…
lukaspie Sep 16, 2024
9a0437a
revert unintentional changes from cherry-pick
lukaspie Sep 23, 2024
9107180
fix copyright in NXsource
lukaspie Sep 23, 2024
05f3513
update type in NXsource
lukaspie Sep 24, 2024
6720925
Apply suggestions from code review
lukaspie Oct 1, 2024
de3cbe5
changes to NXsource type
lukaspie Oct 1, 2024
274d658
move attribute type_other
lukaspie Oct 16, 2024
8ff781d
remove type=other and NXlens_em from NXsource
lukaspie Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 121 additions & 48 deletions base_classes/NXsource.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,13 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
name="NXsource"
type="group" extends="NXobject">
<doc>The neutron or x-ray storage ring/facility.</doc>
type="group" extends="NXobject">
<doc>
Radiation source emitting a beam.

Examples include particle sources (electrons, neutrons, protons) or sources for electromagnetic radiation (photons).
This base class can also be used to describe neutron or x-ray storage ring/facilities.
</doc>
<field name="distance" type="NX_FLOAT" units="NX_LENGTH">
<doc>
Effective distance from sample
Expand Down Expand Up @@ -56,12 +61,22 @@
<item value="Ion Source" />
<item value="UV Plasma Source" />
<item value="Metal Jet X-ray" />
</enumeration>
<item value="Laser"/>
<item value="Dye Laser"/>
<item value="Broadband Tunable Light Source"/>
<item value="Halogen Lamp"/>
<item value="LED"/>
<item value="Mercury Cadmium Telluride Lamp"/>
<item value="Deuterium Lamp"/>
<item value="Xenon Lamp"/>
<item value="Globar"/>
</enumeration>
</field>
<field name="probe">
<doc>type of radiation probe (pick one from the enumerated list and spell exactly)</doc>
<enumeration>
<item value="neutron" />
<item value="photon" />
<item value="x-ray" />
<item value="muon" />
<item value="electron" />
Expand Down Expand Up @@ -91,9 +106,9 @@
</field>
<field name="energy" type="NX_FLOAT" units="NX_ENERGY">
<doc>
Source energy.
For storage rings, this would be the particle beam energy.
For X-ray tubes, this would be the excitation voltage.
Source energy. Typically, this would be the energy of
the emitted beam. For storage rings, this would be
the particle beam energy.
</doc>
</field>
<field name="current" type="NX_FLOAT" units="NX_CURRENT">
Expand Down Expand Up @@ -163,55 +178,113 @@
<doc>For storage rings, the current at the end of the most recent injection.</doc>
<attribute name="time" type="NX_DATE_TIME"><doc>date and time of the most recent injection.</doc></attribute>
</field>
<group name="geometry" type="NXgeometry" deprecated="Use the field `depends_on` and :ref:`NXtransformations` to position the source and NXoff_geometry to describe its shape instead">
<field name="wavelength" type="NX_FLOAT" units="NX_WAVELENGTH">
<doc>
The wavelength of the radiation emitted by the source.
</doc>
</field>
<field name="pulse_energy" type="NX_FLOAT" units="NX_ENERGY">
<doc>
For pulsed sources, the energy of a single pulse.
</doc>
</field>
<field name="peak_power" type="NX_FLOAT" units="NX_POWER">
<doc>
For pulsed sources, the pulse energy divided
by the pulse duration
</doc>
</field>
<field name="anode_material">
<doc>
Material of the anode (for X-ray tubes).
</doc>
</field>
<field name="filament_current" type="NX_FLOAT" units="NX_CURRENT">
<doc>
Filament current (for X-ray tubes).
</doc>
</field>
<field name="emission_current" type="NX_FLOAT" units="NX_CURRENT">
<doc>
Emission current of the generated beam.
</doc>
</field>
<field name="gas_pressure" type="NX_FLOAT" units="NX_PRESSURE">
<doc>
Gas pressure inside ionization source.
</doc>
</field>
<field name="previous_source" type="NX_CHAR">
<doc>
Single instance or list of instances of NXsource pointing to the sources from which a beam originated to reach this source.
This can be used, for example, for secondary sources to describe which other source(s) they are derived from.

An example is the white light source in transient absorption spectroscopy, which is a supercontinuum crystal that is pumped by a
another laser.

In case of a primary source, this field should not be filled.
</doc>
</field>
<group name="geometry" type="NXgeometry" deprecated="Use the field `depends_on` and :ref:`NXtransformations` to position the source and NXoff_geometry to describe its shape instead">
<doc>
"Engineering" location of source.
</doc>
</group>
<group type="NXoff_geometry" minOccurs="0">
<doc>
This group describes the shape of the beam line component
</doc>
</group>
<group type="NXaperture">
<doc>
The size and position of an aperture inside the source.
</doc>
</group>
<group type="NXdeflector">
<doc>
Deflectors inside the source.
</doc>
</group>
<group type="NXfabrication"/>
<group type="NXoff_geometry" minOccurs="0">
<doc>
This group describes the shape of the beam line component
</doc>
</group>
<group type="NXdata" name="distribution">
<doc>The wavelength or energy distribution of the source</doc>
</group>
<attribute name="default">
<doc>
.. index:: plotting
Declares which child group contains a path leading
to a :ref:`NXdata` group.
It is recommended (as of NIAC2014) to use this attribute
to help define the path to the default dataset to be plotted.
See https://www.nexusformat.org/2014_How_to_find_default_data.html
for a summary of the discussion.
</doc>
</attribute>
<field name="depends_on" type="NX_CHAR">
<doc>
NeXus positions components by applying a set of translations and rotations
to apply to the component starting from 0, 0, 0. The order of these operations
is critical and forms what NeXus calls a dependency chain. The depends_on
field defines the path to the top most operation of the dependency chain or the
string "." if located in the origin. Usually these operations are stored in a
NXtransformations group. But NeXus allows them to be stored anywhere.
<attribute name="default">
<doc>
.. index:: plotting
Declares which child group contains a path leading
to a :ref:`NXdata` group.
It is recommended (as of NIAC2014) to use this attribute
to help define the path to the default dataset to be plotted.
See https://www.nexusformat.org/2014_How_to_find_default_data.html
for a summary of the discussion.
</doc>
</attribute>
<field name="depends_on" type="NX_CHAR">
<doc>
NeXus positions components by applying a set of translations and rotations
to apply to the component starting from 0, 0, 0. The order of these operations
is critical and forms what NeXus calls a dependency chain. The depends_on
field defines the path to the top most operation of the dependency chain or the
string "." if located in the origin. Usually these operations are stored in a
NXtransformations group. But NeXus allows them to be stored anywhere.

The reference point of the source plane is its center in the x and y axis. The source is considered infinitely thin in the
z axis.
The reference point of the source plane is its center in the x and y axis. The source is considered infinitely thin in the
z axis.

.. image:: source/source.png
:width: 40%
.. image:: source/source.png
:width: 40%

</doc>
</field>
<group type="NXtransformations">
<doc>
This is the group recommended for holding the chain of translation
and rotation operations necessary to position the component within
the instrument. The dependency chain may however traverse similar groups in
other component groups.
</doc>
</group>
</definition>
</doc>
</field>
<group type="NXtransformations">
<doc>
This is the group recommended for holding the chain of translation
and rotation operations necessary to position the component within
the instrument. The dependency chain may however traverse similar groups in
other component groups.
</doc>
</group>
</definition>
Loading