-
Notifications
You must be signed in to change notification settings - Fork 56
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.
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: actuators and sensors in NXenvironment #1414
Open
lukaspie
wants to merge
29
commits into
nexusformat:main
Choose a base branch
from
FAIRmat-NFDI:fairmat-2024-nxenvironment
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+136
−15
Open
Changes from 27 commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
669c018
Add NXactuator base class
lukaspie 02819a4
make NXenvironment.nxdl.xml
lukaspie 4c7d06e
change starting data in NXenvironment
lukaspie 5543e03
Regenerate nxdls
domna 32114f3
add generic NXactuator to NXenvironment
lukaspie e5e0380
add default attribute to MPES-related base classes
lukaspie 2bbf029
small modifications to clarify NXmpes
lukaspie 20c2153
format base classes and applications in accordance to existing NIAC v…
lukaspie 90ee8c9
revert unintentional changes from cherry-pick
lukaspie 5a8d6d6
6bf33c3
Add NXfabrication to all MPES instrument-related base classes
lukaspie 66f0edc
make nxdls
lukaspie ba029c0
Recompiled NXdata and NXsensor with nyaml==0.0.9 as they showed issue…
atomprobe-tc 36f1c46
Reverted unintentional change NXsensor.nxdl.xml
mkuehbach 70fae95
format base classes and applications in accordance to existing NIAC v…
lukaspie 2286702
revert unintentional changes from cherry-pick
lukaspie d814a87
move NXfabrication to base_classes
lukaspie ca0479a
bring in NXidentifier
lukaspie 8679407
Apply suggestions from NIAC review
lukaspie 838b858
reviewed changes to NXfabrication
lukaspie c038847
remove NXidentifier
lukaspie 05f5c72
move NXpid to base_classes
lukaspie 5a7f730
implement suggestions on NXactuator
lukaspie 2a26f2a
remove default from NXenvironment
lukaspie 1820ea0
remove default from NXactuator
lukaspie eed11b2
remove NXpid
lukaspie d2139be
restore NXpid in contributed
lukaspie 14532fa
Apply suggestions from code review
lukaspie f144570
actuation_target in NXactuator
lukaspie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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,87 @@ | ||
<?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 | ||
--> | ||
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXactuator" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"> | ||
<doc> | ||
An actuator used to control an external condition. | ||
|
||
The condition itself is described in :ref:`NXenvironment`. | ||
</doc> | ||
<field name="name"> | ||
<doc> | ||
Name of the actuator | ||
</doc> | ||
</field> | ||
<field name="short_name"> | ||
<doc> | ||
Short name of actuator used e.g. on monitor display program | ||
</doc> | ||
</field> | ||
<field name="attached_to"> | ||
<doc> | ||
Describe where the actuator is attached to. | ||
This could be an instance of NXsample or a device on NXinstrument. | ||
</doc> | ||
</field> | ||
<field name="physical_quantity"> | ||
<doc> | ||
Name for the physical quantity effected by the actuation | ||
|
||
Examples: | ||
temperature | pH | magnetic_field | electric_field | current | conductivity | resistance | voltage | | ||
pressure | flow | stress | strain | shear | surface_pressure | ||
</doc> | ||
</field> | ||
<field name="type"> | ||
<doc> | ||
The type of hardware used for the actuation. | ||
|
||
Examples (suggestions, but not restrictions): | ||
|
||
:Temperature: laser | gas lamp | filament | resistive | ||
:Pressure: anvil cell | ||
:Voltage: potentiostat | ||
</doc> | ||
</field> | ||
<field name="outputVALUE" type="NX_FLOAT" units="NX_ANY" nameType="partial"> | ||
lukaspie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<doc> | ||
Any output that the actuator produces. | ||
For example, a heater can have the field heater_power(NX_FLOAT). | ||
lukaspie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
</doc> | ||
</field> | ||
<field name="depends_on" type="NX_CHAR"> | ||
<doc> | ||
Refers to the last transformation specifying the position of the actuator | ||
in the NXtransformations chain. | ||
</doc> | ||
</field> | ||
<group type="NXtransformations"> | ||
<doc> | ||
This is the group recommended for holding the chain of translation | ||
and rotation operations necessary to position the actuator within | ||
the instrument. The dependency chain may however traverse similar groups in | ||
other component groups. | ||
</doc> | ||
</group> | ||
<group type="NXfabrication"/> | ||
</definition> |
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
attached_to --> actuation_target
Should be a NeXus path as opposed to a description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changed