NeXus Contributed Classes

NeXus Contributed Classes
Prev	Chapter 3. NeXus classes	Next

A description of each NeXus contributed definition is given. NXDL files in the NeXus contributed definitions include propositions from the community for NeXus base classes or application definitions, as well as other NXDL files for long-term archival by NeXus. Consider the contributed definitions as either in incubation or a special case not for general use. The NIAC is charged to review any new contributed definitions and provide feedback to the authors before ratification and acceptance as either a base class or application definition.

NXarpes
NXbeamline
NXelectrostatic_kicker
NXmagnetic_kicker
NXquadrupole_magnet
NXsai_controller
NXseparator
NXsnsevent
NXsnshisto
NXsolenoid_magnet
NXspin_rotator
NXtechnical_data

NXarpes

category

application(application definition)

NXDL source:

NXarpes

(http://svn.nexusformat.org/definitions/trunk/applications/NXarpes.nxdl.xml)

version

1.0

SVN Id

extends class:

NXobject

other classes included:

NXdata, NXdetector, NXentry, NXinstrument, NXmonochromator, NXsample, NXsource

symbol list

No symbol table.

documentation

This is an application definition for angular resolved photo electron spectroscopy. It has been drawn up with hemispherical electron analysers in mind.

Example 3.78. Basic structure of NXarpes

        NXarpes (application definition, version 1.0)
  (overlays NXentry)
  NXentry
    @entry
    definition:NX_CHAR
    start_time:NX_DATE_TIME
    title:NX_CHAR
    NXdata
    NXinstrument
      analyser:NXdetector
        acquisition_mode:NX_CHAR
        angles:NX_CHAR
        data:NX_CHAR
        energies:NX_CHAR
        entrance_slit_setting:NX_CHAR
        entrance_slit_shape:NX_CHAR
        entrance_slit_size:NX_CHAR
        lens_mode:NX_CHAR
        number_of_sweeps:NX_CHAR
        pass_energy:NX_CHAR
        time_per_channel:NX_CHAR
      monochromator:NXmonochromator
        energy:NX_CHAR
      NXsource
        name:NX_CHAR
        probe:NX_CHAR
        type:NX_CHAR
    NXsample
      name:NX_CHAR
      temperature:NX_CHAR

Table 3.265. NXarpes

Name and Attributes	Type	Units	Description (and Occurrences)
	NXentry		See table: NXarpes: NXarpes/NXentry
`@entry`	NX_CHAR		NeXus convention is to use "entry1", "entry2", ... for analysis software to locate each entry

Table 3.266. NXarpes: NXarpes/NXentry

Name and Attributes	Type	Description (and Occurrences)
`title`	NX_CHAR
`start_time`	NX_DATE_TIME
`definition`	NXarpes	Official NeXus NXDL schema to which this file conforms
	NXinstrument	See table: NXarpes: NXentry/NXinstrument
	NXsample	See table: NXarpes: NXentry/NXsample
	NXdata

Table 3.267. NXarpes: NXentry/NXinstrument

Name and Attributes	Type	Description (and Occurrences)
	NXsource	See table: NXarpes: NXinstrument/NXsource
`monochromator`	NXmonochromator	See table: NXarpes: NXinstrument/monochromator:NXmonochromator
`analyser`	NXdetector	See table: NXarpes: NXinstrument/analyser:NXdetector

Table 3.268. NXarpes: NXinstrument/NXsource

Name and Attributes	Type	Units	Description (and Occurrences)
`type`	NX_CHAR
`name`	NX_CHAR
`probe`	x-ray

Table 3.269. NXarpes: NXinstrument/monochromator:NXmonochromator

Name and Attributes	Type	Units	Description (and Occurrences)
`energy`	NX_CHAR

Table 3.270. NXarpes: NXinstrument/analyser:NXdetector

Name and Attributes	Type	Units	Description (and Occurrences)
`data`	NX_CHAR		mark this field with attribute signal="1"
`lens_mode`	NX_CHAR		setting for the electron analyser lens
`acquisition_mode`	swept \| fixed
`entrance_slit_shape`	curved \| straight
`entrance_slit_setting`	NX_CHAR		dial setting of the entrance slit
`entrance_slit_size`	NX_CHAR	NX_LENGTH	size of the entrance slit
`pass_energy`	NX_CHAR	NX_ENERGY	energy of the electrons on the mean path of the analyser
`number_of_sweeps`	NX_CHAR
`time_per_channel`	NX_CHAR	NX_TIME
`angles`	NX_CHAR		angular axis of the analyser data
`energies`	NX_CHAR		energy axis of the analyser data

Table 3.271. NXarpes: NXentry/NXsample

Name and Attributes	Type	Units	Description (and Occurrences)
`name`	NX_CHAR		Descriptive name of sample
`temperature`	NX_CHAR	NX_TEMPERATURE

NXbeamline

category

contributed(contributed definition)

NXDL source:

NXbeamline

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXbeamline.nxdl.xml)

version

1.0

SVN Id

Id: NXbeamline.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXaperture, NXbending_magnet, NXcollection, NXelectrostatic_kicker, NXmagnetic_kicker, NXquadrupole_magnet, NXseparator, NXsolenoid_magnet, NXspin_rotator

symbol list

No symbol table.

documentation

container for elements describing beamline.

Example 3.79. Basic structure of NXbeamline

        NXbeamline (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline:NX_CHAR
  NXaperture
  NXbending_magnet
  diagnostics:NXcollection
  NXelectrostatic_kicker
  NXmagnetic_kicker
  NXquadrupole_magnet
  NXseparator
  NXsolenoid_magnet
  NXspin_rotator

Table 3.272. NXbeamline

Name and Attributes	Type	Description (and Occurrences)
`beamline`	NX_CHAR	name of beamline.
`diagnostics`	NXcollection	Occurences: 0 : 1
	NXbending_magnet	Occurences: 0 : unbounded
	NXquadrupole_magnet	Occurences: 0 : unbounded
	NXsolenoid_magnet	Occurences: 0 : unbounded
	NXseparator	Occurences: 0 : unbounded
	NXspin_rotator	Occurences: 0 : unbounded
	NXelectrostatic_kicker	Occurences: 0 : unbounded
	NXmagnetic_kicker	Occurences: 0 : unbounded
	NXaperture	Occurences: 0 : unbounded

NXelectrostatic_kicker

category

contributed(contributed definition)

NXDL source:

NXelectrostatic_kicker

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXelectrostatic_kicker.nxdl.xml)

version

1.0

SVN Id

Id: NXelectrostatic_kicker.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXlog

symbol list

No symbol table.

documentation

definition for a electrostatic kicker.

Example 3.80. Basic structure of NXelectrostatic_kicker

        NXelectrostatic_kicker (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline_distance:NX_FLOAT
  description:NX_CHAR
  set_current:NX_FLOAT
  set_voltage:NX_FLOAT
  timing:NX_FLOAT
    @description
  read_current:NXlog
    value:NX_CHAR
  read_voltage:NXlog
    value:NX_CHAR

Table 3.273. NXelectrostatic_kicker

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR		extended description of the kicker.
`beamline_distance`	NX_FLOAT	NX_LENGTH	define position of beamline element relative to production target Occurences: 0 : 1
`timing`	NX_FLOAT	NX_TIME	kicker timing as defined by ‘description’ attribute Occurences: 0 : 1
`@description`	NX_CHAR
`set_current`	NX_FLOAT	NX_CURRENT	current set on supply. Occurences: 0 : 1
`read_current`	NXlog		current read from supply. Occurences: 0 : 1 See table: NXelectrostatic_kicker: NXelectrostatic_kicker/read_current:NXlog
`set_voltage`	NX_FLOAT	NX_VOLTAGE	volage set on supply. Occurences: 0 : 1
`read_voltage`	NXlog		voltage read from supply. Occurences: 0 : 1 See table: NXelectrostatic_kicker: NXelectrostatic_kicker/read_voltage:NXlog

Table 3.274. NXelectrostatic_kicker: NXelectrostatic_kicker/read_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.275. NXelectrostatic_kicker: NXelectrostatic_kicker/read_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

NXmagnetic_kicker

category

contributed(contributed definition)

NXDL source:

NXmagnetic_kicker

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXmagnetic_kicker.nxdl.xml)

version

1.0

SVN Id

Id: NXmagnetic_kicker.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXlog

symbol list

No symbol table.

documentation

definition for a magnetic kicker.volage set on supply.

Example 3.81. Basic structure of NXmagnetic_kicker

        NXmagnetic_kicker (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline_distance:NX_FLOAT
  description:NX_CHAR
  set_current:NX_FLOAT
  set_voltage:NX_FLOAT
  timing:NX_FLOAT
    @description
  read_current:NXlog
    value:NX_CHAR
  read_voltage:NXlog
    value:NX_CHAR

Table 3.276. NXmagnetic_kicker

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR		extended description of the kicker.
`beamline_distance`	NX_FLOAT	NX_LENGTH	define position of beamline element relative to production target Occurences: 0 : 1
`timing`	NX_FLOAT	NX_TIME	kicker timing as defined by ‘description’ attribute Occurences: 0 : 1
`@description`	NX_CHAR
`set_current`	NX_FLOAT	NX_CURRENT	current set on supply. Occurences: 0 : 1
`read_current`	NXlog		current read from supply. Occurences: 0 : 1 See table: NXmagnetic_kicker: NXmagnetic_kicker/read_current:NXlog
`set_voltage`	NX_FLOAT	NX_VOLTAGE	Occurences: 0 : 1
`read_voltage`	NXlog		voltage read from supply. Occurences: 0 : 1 See table: NXmagnetic_kicker: NXmagnetic_kicker/read_voltage:NXlog

Table 3.277. NXmagnetic_kicker: NXmagnetic_kicker/read_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.278. NXmagnetic_kicker: NXmagnetic_kicker/read_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

NXquadrupole_magnet

category

contributed(contributed definition)

NXDL source:

NXquadrupole_magnet

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXquadrupole_magnet.nxdl.xml)

version

1.0

SVN Id

Id: NXquadrupole_magnet.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXlog

symbol list

No symbol table.

documentation

definition for a quadrupole magnet.

Example 3.82. Basic structure of NXquadrupole_magnet

        NXquadrupole_magnet (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline_distance:NX_FLOAT
  description:NX_CHAR
  set_current:NX_FLOAT
  read_current:NXlog
    value:NX_CHAR
  read_voltage:NXlog
    value:NX_CHAR

Table 3.279. NXquadrupole_magnet

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR		extended description of the magnet.
`beamline_distance`	NX_FLOAT	NX_LENGTH	define position of beamline element relative to production target Occurences: 0 : 1
`set_current`	NX_FLOAT	NX_CURRENT	current set on supply. Occurences: 0 : 1
`read_current`	NXlog		current read from supply. Occurences: 0 : 1 See table: NXquadrupole_magnet: NXquadrupole_magnet/read_current:NXlog
`read_voltage`	NXlog		voltage read from supply. Occurences: 0 : 1 See table: NXquadrupole_magnet: NXquadrupole_magnet/read_voltage:NXlog

Table 3.280. NXquadrupole_magnet: NXquadrupole_magnet/read_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.281. NXquadrupole_magnet: NXquadrupole_magnet/read_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

NXsai_controller

category

contributed(contributed definition)

NXDL source:

NXsai_controller

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXsai_controller.nxdl.xml)

version

1.0

SVN Id

Id: NXsai_controller.nxdl.xml 1045 2012-02-13 00:10:56Z Freddie Akeroyd

extends class:

NXobject

other classes included:

NXtechnical_data

symbol list

No symbol table.

documentation

(definition implied by usage) Subclass of NXinstrument used by Soleil. This class appears in the example data files provided from Soleil. This class should be considered as a base class (and relocated there, once approved by the NIAC).

Example 3.83. Basic structure of NXsai_controller

        NXsai_controller (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  Frequency:NXtechnical_data
  IntegrationTime:NXtechnical_data
  TriggerNumber:NXtechnical_data

Table 3.282. NXsai_controller

Name and Attributes	Type	Description (and Occurrences)
`Frequency`	NXtechnical_data	DAQ board sampling frequency
`IntegrationTime`	NXtechnical_data	buffer integration time
`TriggerNumber`	NXtechnical_data	set to 0 at init, means that extern trigger mode disabled. if triggerNumber > 0, means extern trigger mode enabled. read part is the current trigger

NXseparator

category

contributed(contributed definition)

NXDL source:

NXseparator

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXseparator.nxdl.xml)

version

1.0

SVN Id

Id: NXseparator.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXlog

symbol list

No symbol table.

documentation

definition for an electrostatic separator.

Example 3.84. Basic structure of NXseparator

        NXseparator (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline_distance:NX_FLOAT
  description:NX_CHAR
  set_Bfield_current:NX_FLOAT
  set_Efield_voltage:NX_FLOAT
  read_Bfield_current:NXlog
    value:NX_CHAR
  read_Bfield_voltage:NXlog
    value:NX_CHAR
  read_Efield_current:NXlog
    value:NX_CHAR
  read_Efield_voltage:NXlog
    value:NX_CHAR

Table 3.283. NXseparator

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR		extended description of the separator.
`beamline_distance`	NX_FLOAT	NX_LENGTH	define position of beamline element relative to production target Occurences: 0 : 1
`set_Bfield_current`	NX_FLOAT	NX_CURRENT	current set on magnet supply. Occurences: 0 : 1
`read_Bfield_current`	NXlog		current read from magnet supply. Occurences: 0 : 1 See table: NXseparator: NXseparator/read_Bfield_current:NXlog
`read_Bfield_voltage`	NXlog		voltage read from magnet supply. Occurences: 0 : 1 See table: NXseparator: NXseparator/read_Bfield_voltage:NXlog
`set_Efield_voltage`	NX_FLOAT	NX_VOLTAGE	current set on HT supply. Occurences: 0 : 1
`read_Efield_current`	NXlog		current read from HT supply. Occurences: 0 : 1 See table: NXseparator: NXseparator/read_Efield_current:NXlog
`read_Efield_voltage`	NXlog		voltage read from HT supply. Occurences: 0 : 1 See table: NXseparator: NXseparator/read_Efield_voltage:NXlog

Table 3.284. NXseparator: NXseparator/read_Bfield_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.285. NXseparator: NXseparator/read_Bfield_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

Table 3.286. NXseparator: NXseparator/read_Efield_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.287. NXseparator: NXseparator/read_Efield_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

NXsnsevent

category

contributed(contributed definition)

NXDL source:

NXsnsevent

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXsnsevent.nxdl.xml)

version

1.0

SVN Id

Id: NXsnsevent.nxdl.xml 1045 2012-02-13 00:10:56Z Freddie Akeroyd

extends class:

NXobject

other classes included:

NXaperture, NXattenuator, NXcollection, NXcrystal, NXdata, NXdetector, NXdisk_chopper, NXentry, NXevent_data, NXgeometry, NXinstrument, NXlog, NXmoderator, NXmonitor, NXnote, NXorientation, NXpolarizer, NXpositioner, NXsample, NXshape, NXsource, NXtranslation, NXuser

symbol list

No symbol table.

documentation

This is a definition for event data from Spallation Neutron Source (SNS) at ORNL.

Example 3.85. Basic structure of NXsnsevent

        NXsnsevent (contributed definition, version 1.0)
  (overlays NXentry)
  NXentry
    collection_identifier:NX_CHAR
    collection_title:NX_CHAR
    definition:NX_CHAR
    duration:NX_FLOAT
    end_time:NX_DATE_TIME
    entry_identifier:NX_CHAR
    experiment_identifier:NX_CHAR
    notes:NX_CHAR
    proton_charge:NX_FLOAT
    raw_frames:NX_INT
    run_number:NX_CHAR
    start_time:NX_DATE_TIME
    title:NX_CHAR
    total_counts:NX_UINT
    total_uncounted_counts:NX_UINT
    DASlogs:NXcollection
      NXlog
        average_value:NX_FLOAT
        average_value_error:NX_FLOAT
        description:NX_CHAR
        duration:NX_FLOAT
        maximum_value:NX_FLOAT
        minimum_value:NX_FLOAT
        time:NX_FLOAT[nvalue]
        value:NX_FLOAT[nvalue]
      NXpositioner
        average_value:NX_FLOAT
        average_value_error:NX_FLOAT
        description:NX_CHAR
        duration:NX_FLOAT
        maximum_value:NX_FLOAT
        minimum_value:NX_FLOAT
        time:NX_FLOAT[numvalue]
        value:NX_FLOAT[numvalue]
    NXdata
      data_x_y --> /NXentry/NXinstrument/NXdetector/data_x_y
      x_pixel_offset --> /NXentry/NXinstrument/NXdetector/x_pixel_offset
      y_pixel_offset --> /NXentry/NXinstrument/NXdetector/y_pixel_offset
    NXevent_data
      event_index --> /NXentry/NXinstrument/NXdetector/event_index
      event_pixel_id --> /NXentry/NXinstrument/NXdetector/event_pixel_id
      event_time_of_flight --> /NXentry/NXinstrument/NXdetector/event_time_of_flight
      pulse_time --> /NXentry/NXinstrument/NXdetector/pulse_time
    instrument:NXinstrument
      SNSdetector_calibration_id:NX_CHAR
      SNSgeometry_file_name:NX_CHAR
      SNStranslation_service:NX_CHAR
      beamline:NX_CHAR
      name:NX_CHAR
      NXaperture
        x_pixel_offset:NX_FLOAT
        origin:NXgeometry
          orientation:NXorientation
            value:NX_FLOAT[6]
          shape:NXshape
            description:NX_CHAR
            shape:NX_CHAR
            size:NX_FLOAT[3]
          translation:NXtranslation
            distance:NX_FLOAT[3]
      NXattenuator
        distance:NX_FLOAT
      NXcrystal
        type:NX_CHAR
        wavelength:NX_FLOAT
        origin:NXgeometry
          description:NX_CHAR
          orientation:NXorientation
            value:NX_FLOAT[6]
          shape:NXshape
            description:NX_CHAR
            shape:NX_CHAR
            size:NX_FLOAT
          translation:NXtranslation
            distance:NX_FLOAT[3]
      NXdetector
        azimuthal_angle:NX_FLOAT[numx,numy]
        data_x_y:NX_UINT[numx,numy]
        distance:NX_FLOAT[numx,numy]
        event_index:NX_UINT[numpulses]
        event_pixel_id:NX_UINT[numevents]
        event_time_of_flight:NX_FLOAT[numevents]
        pixel_id:NX_UINT[numx,numy]
        polar_angle:NX_FLOAT[numx,numy]
        pulse_time:NX_FLOAT[numpulses]
        total_counts:NX_UINT
        x_pixel_offset:NX_FLOAT[numx]
        y_pixel_offset:NX_FLOAT[numy]
        origin:NXgeometry
          orientation:NXorientation
            value:NX_FLOAT[6]
          shape:NXshape
            description:NX_CHAR
            shape:NX_CHAR
            size:NX_FLOAT[3]
          translation:NXtranslation
            distance:NX_FLOAT[3]
      NXdisk_chopper
        distance:NX_FLOAT
      moderator:NXmoderator
        coupling_material:NX_CHAR
        distance:NX_FLOAT
        temperature:NX_FLOAT
        type:NX_CHAR
      NXpolarizer
      SNS:NXsource
        frequency:NX_FLOAT
        name:NX_CHAR
        probe:NX_CHAR
        type:NX_CHAR
    NXmonitor
      data:NX_UINT[numtimechannels]
      distance:NX_FLOAT
      mode:NX_CHAR
      time_of_flight:NX_FLOAT[numtimechannels + 1]
    SNSHistoTool:NXnote
      SNSbanking_file_name:NX_CHAR
      SNSmapping_file_name:NX_CHAR
      author:NX_CHAR
      command1:NX_CHAR
      date:NX_CHAR
      description:NX_CHAR
      version:NX_CHAR
    sample:NXsample
      changer_position:NX_CHAR
      holder:NX_CHAR
      identifier:NX_CHAR
      name:NX_CHAR
      nature:NX_CHAR
    NXuser
      facility_user_id:NX_CHAR
      name:NX_CHAR
      role:NX_CHAR

Table 3.288. NXsnsevent

Name and Attributes	Type	Units	Description (and Occurrences)
	NXentry		Occurences: 1 : default See table: NXsnsevent: NXsnsevent/NXentry

Name and Attributes

Type

Units

Description (and Occurrences)

NXentry

Occurences: 1 : default

See table: NXsnsevent: NXsnsevent/NXentry

Table 3.289. NXsnsevent: NXsnsevent/NXentry

Name and Attributes	Type	Units	Description (and Occurrences)
`DASlogs`	NXcollection		Details of all logs, both from cvinfo file and from HistoTool (frequency and proton_charge). See table: NXsnsevent: NXentry/DASlogs:NXcollection
`SNSHistoTool`	NXnote		See table: NXsnsevent: NXentry/SNSHistoTool:NXnote
	NXdata		Occurences: 1 : default List of links: `data_x_y` `/NXentry/NXinstrument/NXdetector/data_x_y` `x_pixel_offset` `/NXentry/NXinstrument/NXdetector/x_pixel_offset` `y_pixel_offset` `/NXentry/NXinstrument/NXdetector/y_pixel_offset`
	NXevent_data		Occurences: 1 : default List of links: `event_index` `/NXentry/NXinstrument/NXdetector/event_index` `event_pixel_id` `/NXentry/NXinstrument/NXdetector/event_pixel_id` `event_time_of_flight` `/NXentry/NXinstrument/NXdetector/event_time_of_flight` `pulse_time` `/NXentry/NXinstrument/NXdetector/pulse_time`
`collection_identifier`	NX_CHAR
`collection_title`	NX_CHAR
`definition`	NXsnsevent		Official NXDL schema after this file goes to applications.
`duration`	NX_FLOAT	NX_TIME
`end_time`	NX_DATE_TIME
`entry_identifier`	NX_CHAR
`experiment_identifier`	NX_CHAR
`instrument`	NXinstrument		See table: NXsnsevent: NXentry/instrument:NXinstrument
	NXmonitor		Occurences: 0 : default See table: NXsnsevent: NXentry/NXmonitor
`notes`	NX_CHAR
`proton_charge`	NX_FLOAT	NX_CHARGE
`raw_frames`	NX_INT
`run_number`	NX_CHAR
`sample`	NXsample		See table: NXsnsevent: NXentry/sample:NXsample
`start_time`	NX_DATE_TIME
`title`	NX_CHAR
`total_counts`	NX_UINT	NX_UNITLESS
`total_uncounted_counts`	NX_UINT	NX_UNITLESS
	NXuser		Occurences: 1 : default See table: NXsnsevent: NXentry/NXuser

Table 3.290. NXsnsevent: NXentry/DASlogs:NXcollection

Name and Attributes	Type	Units	Description (and Occurrences)
	NXlog		Occurences: 1 : default See table: NXsnsevent: DASlogs:NXcollection/NXlog
	NXpositioner		Motor logs from cvinfo file. Occurences: 0 : default See table: NXsnsevent: DASlogs:NXcollection/NXpositioner

Name and Attributes

Type

Units

Description (and Occurrences)

NXlog

Occurences: 1 : default

See table: NXsnsevent: DASlogs:NXcollection/NXlog

NXpositioner

Motor logs from cvinfo file.

Occurences: 0 : default

See table: NXsnsevent: DASlogs:NXcollection/NXpositioner

Table 3.291. NXsnsevent: DASlogs:NXcollection/NXlog

Name and Attributes	Type	Description (and Occurrences)
`average_value`	NX_FLOAT
`average_value_error`	NX_FLOAT
`description`	NX_CHAR
`duration`	NX_FLOAT
`maximum_value`	NX_FLOAT
`minimum_value`	NX_FLOAT
`time`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="nvalue"`
`value`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="nvalue"`

Table 3.292. NXsnsevent: DASlogs:NXcollection/NXpositioner

Name and Attributes	Type	Description (and Occurrences)
`average_value`	NX_FLOAT
`average_value_error`	NX_FLOAT
`description`	NX_CHAR
`duration`	NX_FLOAT
`maximum_value`	NX_FLOAT
`minimum_value`	NX_FLOAT
`time`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="numvalue"`
`value`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="numvalue"`

Table 3.293. NXsnsevent: NXentry/SNSHistoTool:NXnote

Name and Attributes	Type	Description (and Occurrences)
`SNSbanking_file_name`	NX_CHAR
`SNSmapping_file_name`	NX_CHAR
`author`	NX_CHAR
`command1`	NX_CHAR	Command string for event2nxl.
`date`	NX_CHAR
`description`	NX_CHAR
`version`	NX_CHAR

Table 3.294. NXsnsevent: NXentry/instrument:NXinstrument

Name and Attributes	Type	Description (and Occurrences)
`SNS`	NXsource	See table: NXsnsevent: instrument:NXinstrument/SNS:NXsource
`SNSdetector_calibration_id`	NX_CHAR	Detector calibration id from DAS.
`SNSgeometry_file_name`	NX_CHAR
`SNStranslation_service`	NX_CHAR
	NXdetector	Occurences: 1 : default See table: NXsnsevent: instrument:NXinstrument/NXdetector
`beamline`	NX_CHAR
	NXdisk_chopper	Occurences: 0 : default See table: NXsnsevent: instrument:NXinstrument/NXdisk_chopper
`moderator`	NXmoderator	See table: NXsnsevent: instrument:NXinstrument/moderator:NXmoderator
`name`	NX_CHAR
	NXaperture	Occurences: 0 : default See table: NXsnsevent: instrument:NXinstrument/NXaperture
	NXattenuator	Occurences: 0 : default See table: NXsnsevent: instrument:NXinstrument/NXattenuator
	NXpolarizer	Occurences: 0 : default
	NXcrystal	Occurences: 0 : default See table: NXsnsevent: instrument:NXinstrument/NXcrystal

Table 3.295. NXsnsevent: instrument:NXinstrument/SNS:NXsource

Name and Attributes	Type	Units
`frequency`	NX_FLOAT	NX_FREQUENCY
`name`	NX_CHAR
`probe`	NX_CHAR
`type`	NX_CHAR

Table 3.296. NXsnsevent: instrument:NXinstrument/NXdetector

Name and Attributes	Type	Units	Description (and Occurrences)
`azimuthal_angle`	NX_FLOAT	NX_ANGLE	Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`data_x_y`	NX_UINT		expect signal="2" axes="x_pixel_offset,y_pixel_offset" Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`event_index`	NX_UINT		Dimensions: rank="1" dim: `index="1"value="numpulses"`
`event_pixel_id`	NX_UINT		Dimensions: rank="1" dim: `index="1"value="numevents"`
`event_time_of_flight`	NX_FLOAT	NX_TIME_OF_FLIGHT	Dimensions: rank="1" dim: `index="1"value="numevents"`
`origin`	NXgeometry		See table: NXsnsevent: NXdetector/origin:NXgeometry
`pixel_id`	NX_UINT		Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`polar_angle`	NX_FLOAT	NX_ANGLE	Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`pulse_time`	NX_FLOAT	NX_TIME	Dimensions: rank="1" dim: `index="1"value="numpulses"`
`total_counts`	NX_UINT
`x_pixel_offset`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="numx"`
`y_pixel_offset`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="numy"`

Table 3.297. NXsnsevent: NXdetector/origin:NXgeometry

Name and Attributes	Type	Description (and Occurrences)
`orientation`	NXorientation	See table: NXsnsevent: origin:NXgeometry/orientation:NXorientation
`shape`	NXshape	See table: NXsnsevent: origin:NXgeometry/shape:NXshape
`translation`	NXtranslation	See table: NXsnsevent: origin:NXgeometry/translation:NXtranslation

Table 3.298. NXsnsevent: origin:NXgeometry/orientation:NXorientation

Name and Attributes Type Units Description (and Occurrences)

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_FLOAT		Six out of nine rotation parameters. Dimensions: rank="1" dim: `index="1"value="6"`

value

NX_FLOAT

Six out of nine rotation parameters.

Dimensions: rank="1"

dim: index="1"value="6"

Table 3.299. NXsnsevent: origin:NXgeometry/shape:NXshape

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR
`shape`	NX_CHAR
`size`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.300. NXsnsevent: origin:NXgeometry/translation:NXtranslation

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.301. NXsnsevent: instrument:NXinstrument/NXdisk_chopper

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH

Table 3.302. NXsnsevent: instrument:NXinstrument/moderator:NXmoderator

Name and Attributes	Type	Units
`coupling_material`	NX_CHAR
`distance`	NX_FLOAT	NX_LENGTH
`temperature`	NX_FLOAT	NX_TEMPERATURE
`type`	NX_CHAR

Table 3.303. NXsnsevent: instrument:NXinstrument/NXaperture

Name and Attributes	Type	Units	Description (and Occurrences)
`origin`	NXgeometry		See table: NXsnsevent: NXaperture/origin:NXgeometry
`x_pixel_offset`	NX_FLOAT	NX_LENGTH

Table 3.304. NXsnsevent: NXaperture/origin:NXgeometry

Name and Attributes	Type	Description (and Occurrences)
`orientation`	NXorientation	See table: NXsnsevent: origin:NXgeometry/orientation:NXorientation
`shape`	NXshape	See table: NXsnsevent: origin:NXgeometry/shape:NXshape
`translation`	NXtranslation	See table: NXsnsevent: origin:NXgeometry/translation:NXtranslation

Table 3.305. NXsnsevent: origin:NXgeometry/orientation:NXorientation

Name and Attributes Type Units Description (and Occurrences)

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_FLOAT		Six out of nine rotation parameters. Dimensions: rank="1" dim: `index="1"value="6"`

value

NX_FLOAT

Six out of nine rotation parameters.

Dimensions: rank="1"

dim: index="1"value="6"

Table 3.306. NXsnsevent: origin:NXgeometry/shape:NXshape

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR
`shape`	NX_CHAR
`size`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.307. NXsnsevent: origin:NXgeometry/translation:NXtranslation

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.308. NXsnsevent: instrument:NXinstrument/NXattenuator

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH

Table 3.309. NXsnsevent: instrument:NXinstrument/NXcrystal

Name and Attributes	Type	Units	Description (and Occurrences)
`origin`	NXgeometry		See table: NXsnsevent: NXcrystal/origin:NXgeometry
`type`	NX_CHAR
`wavelength`	NX_FLOAT	NX_WAVELENGTH

Table 3.310. NXsnsevent: NXcrystal/origin:NXgeometry

Name and Attributes	Type	Description (and Occurrences)
`description`	NX_CHAR
`orientation`	NXorientation	See table: NXsnsevent: origin:NXgeometry/orientation:NXorientation
`shape`	NXshape	See table: NXsnsevent: origin:NXgeometry/shape:NXshape
`translation`	NXtranslation	See table: NXsnsevent: origin:NXgeometry/translation:NXtranslation

Table 3.311. NXsnsevent: origin:NXgeometry/orientation:NXorientation

Name and Attributes Type Units Description (and Occurrences)

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_FLOAT		Six out of nine rotation parameters. Dimensions: rank="1" dim: `index="1"value="6"`

value

NX_FLOAT

Six out of nine rotation parameters.

Dimensions: rank="1"

dim: index="1"value="6"

Table 3.312. NXsnsevent: origin:NXgeometry/shape:NXshape

Name and Attributes	Type	Units
`description`	NX_CHAR
`shape`	NX_CHAR
`size`	NX_FLOAT	NX_LENGTH

Table 3.313. NXsnsevent: origin:NXgeometry/translation:NXtranslation

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.314. NXsnsevent: NXentry/NXmonitor

Name and Attributes	Type	Units	Description (and Occurrences)
`data`	NX_UINT		expect signal="1" axes="time_of_flight" Dimensions: rank="1" dim: `index="1"value="numtimechannels"`
`distance`	NX_FLOAT	NX_LENGTH
`mode`	NX_CHAR
`time_of_flight`	NX_FLOAT	NX_TIME	Dimensions: rank="1" dim: `index="1"value="numtimechannels + 1"`

Table 3.315. NXsnsevent: NXentry/sample:NXsample

Name and Attributes	Type	Description (and Occurrences)
`changer_position`	NX_CHAR
`holder`	NX_CHAR
`identifier`	NX_CHAR
`name`	NX_CHAR	Descriptive name of sample
`nature`	NX_CHAR

Table 3.316. NXsnsevent: NXentry/NXuser

Name and Attributes	Type	Units	Description (and Occurrences)
`facility_user_id`	NX_CHAR
`name`	NX_CHAR
`role`	NX_CHAR

NXsnshisto

category

contributed(contributed definition)

NXDL source:

NXsnshisto

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXsnshisto.nxdl.xml)

version

1.0

SVN Id

Id: NXsnshisto.nxdl.xml 1045 2012-02-13 00:10:56Z Freddie Akeroyd

extends class:

NXobject

other classes included:

NXaperture, NXattenuator, NXcollection, NXcrystal, NXdata, NXdetector, NXdisk_chopper, NXentry, NXfermi_chopper, NXgeometry, NXinstrument, NXlog, NXmoderator, NXmonitor, NXnote, NXorientation, NXpolarizer, NXpositioner, NXsample, NXshape, NXsource, NXtranslation, NXuser

symbol list

No symbol table.

documentation

This is a definition for histogram data from Spallation Neutron Source (SNS) at ORNL.

Example 3.86. Basic structure of NXsnshisto

        NXsnshisto (contributed definition, version 1.0)
  (overlays NXentry)
  NXentry
    collection_identifier:NX_CHAR
    collection_title:NX_CHAR
    definition:NX_CHAR
    duration:NX_FLOAT
    end_time:NX_DATE_TIME
    entry_identifier:NX_CHAR
    experiment_identifier:NX_CHAR
    notes:NX_CHAR
    proton_charge:NX_FLOAT
    raw_frames:NX_INT
    run_number:NX_CHAR
    start_time:NX_DATE_TIME
    title:NX_CHAR
    total_counts:NX_UINT
    total_uncounted_counts:NX_UINT
    DASlogs:NXcollection
      NXlog
        average_value:NX_FLOAT
        average_value_error:NX_FLOAT
        description:NX_CHAR
        duration:NX_FLOAT
        maximum_value:NX_FLOAT
        minimum_value:NX_FLOAT
        time:NX_FLOAT[nvalue]
        value:NX_FLOAT[nvalue]
      NXpositioner
        average_value:NX_FLOAT
        average_value_error:NX_FLOAT
        description:NX_CHAR
        duration:NX_FLOAT
        maximum_value:NX_FLOAT
        minimum_value:NX_FLOAT
        time:NX_FLOAT[numvalue]
        value:NX_FLOAT[numvalue]
    NXdata
      data --> /NXentry/NXinstrument/NXdetector/data
      data_x_time_of_flight --> /NXentry/NXinstrument/NXdetector/data_x_time_of_flight
      data_x_y --> /NXentry/NXinstrument/NXdetector/data_x_y
      data_y_time_of_flight --> /NXentry/NXinstrument/NXdetector/data_y_time_of_flight
      pixel_id --> /NXentry/NXinstrument/NXdetector/pixel_id
      time_of_flight --> /NXentry/NXinstrument/NXdetector/time_of_flight
      total_counts --> /NXentry/NXinstrument/NXdetector/total_counts
      x_pixel_offset --> /NXentry/NXinstrument/NXdetector/x_pixel_offset
      y_pixel_offset --> /NXentry/NXinstrument/NXdetector/y_pixel_offset
    instrument:NXinstrument
      SNSdetector_calibration_id:NX_CHAR
      SNSgeometry_file_name:NX_CHAR
      SNStranslation_service:NX_CHAR
      beamline:NX_CHAR
      name:NX_CHAR
      NXaperture
        x_pixel_offset:NX_FLOAT
        origin:NXgeometry
          orientation:NXorientation
            value:NX_FLOAT[6]
          shape:NXshape
            description:NX_CHAR
            shape:NX_CHAR
            size:NX_FLOAT[3]
          translation:NXtranslation
            distance:NX_FLOAT[3]
      NXattenuator
        distance:NX_FLOAT
      NXcrystal
        type:NX_CHAR
        wavelength:NX_FLOAT
        origin:NXgeometry
          description:NX_CHAR
          orientation:NXorientation
            value:NX_FLOAT[6]
          shape:NXshape
            description:NX_CHAR
            shape:NX_CHAR
            size:NX_FLOAT
          translation:NXtranslation
            distance:NX_FLOAT[3]
      NXdetector
        azimuthal_angle:NX_FLOAT[numx,numy]
        data:NX_UINT[numx,numy,numtof]
        data_x_time_of_flight:NX_UINT[numx,numtof]
        data_x_y:NX_UINT[numx,numy]
        data_y_time_of_flight:NX_UINT[numy,numtof]
        distance:NX_FLOAT[numx,numy]
        pixel_id:NX_UINT[numx,numy]
        polar_angle:NX_FLOAT[numx,numy]
        time_of_flight:NX_FLOAT[numtof + 1]
        total_counts:NX_UINT
        x_pixel_offset:NX_FLOAT[numx]
        y_pixel_offset:NX_FLOAT[numy]
        origin:NXgeometry
          orientation:NXorientation
            value:NX_FLOAT[6]
          shape:NXshape
            description:NX_CHAR
            shape:NX_CHAR
            size:NX_FLOAT[3]
          translation:NXtranslation
            distance:NX_FLOAT[3]
      NXdisk_chopper
        distance:NX_FLOAT
      NXfermi_chopper
        distance:NX_FLOAT
      moderator:NXmoderator
        coupling_material:NX_CHAR
        distance:NX_FLOAT
        temperature:NX_FLOAT
        type:NX_CHAR
      NXpolarizer
      SNS:NXsource
        frequency:NX_FLOAT
        name:NX_CHAR
        probe:NX_CHAR
        type:NX_CHAR
    NXmonitor
      data:NX_UINT[numtimechannels]
      distance:NX_FLOAT
      mode:NX_CHAR
      time_of_flight:NX_FLOAT[numtimechannels + 1]
    SNSHistoTool:NXnote
      SNSbanking_file_name:NX_CHAR
      SNSmapping_file_name:NX_CHAR
      author:NX_CHAR
      command1:NX_CHAR
      date:NX_CHAR
      description:NX_CHAR
      version:NX_CHAR
    sample:NXsample
      changer_position:NX_CHAR
      holder:NX_CHAR
      identifier:NX_CHAR
      name:NX_CHAR
      nature:NX_CHAR
    NXuser
      facility_user_id:NX_CHAR
      name:NX_CHAR
      role:NX_CHAR

Table 3.317. NXsnshisto

Name and Attributes

Type

Units

Description (and Occurrences)

NXentry

Occurences: 1 : default

See table: NXsnshisto: NXsnshisto/NXentry

Table 3.318. NXsnshisto: NXsnshisto/NXentry

Name and Attributes	Type	Units	Description (and Occurrences)
`DASlogs`	NXcollection		Details of all logs, both from cvinfo file and from HistoTool (frequency and proton_charge). See table: NXsnshisto: NXentry/DASlogs:NXcollection
`SNSHistoTool`	NXnote		See table: NXsnshisto: NXentry/SNSHistoTool:NXnote
	NXdata		Occurences: 1 : default List of links: `data` `/NXentry/NXinstrument/NXdetector/data` `data_x_time_of_flight` `/NXentry/NXinstrument/NXdetector/data_x_time_of_flight` `data_x_y` `/NXentry/NXinstrument/NXdetector/data_x_y` `data_y_time_of_flight` `/NXentry/NXinstrument/NXdetector/data_y_time_of_flight` `pixel_id` `/NXentry/NXinstrument/NXdetector/pixel_id` `time_of_flight` `/NXentry/NXinstrument/NXdetector/time_of_flight` `total_counts` `/NXentry/NXinstrument/NXdetector/total_counts` `x_pixel_offset` `/NXentry/NXinstrument/NXdetector/x_pixel_offset` `y_pixel_offset` `/NXentry/NXinstrument/NXdetector/y_pixel_offset`
`collection_identifier`	NX_CHAR
`collection_title`	NX_CHAR
`definition`	NXsnshisto		Official NXDL schema after this file goes to applications.
`duration`	NX_FLOAT	NX_TIME
`end_time`	NX_DATE_TIME
`entry_identifier`	NX_CHAR
`experiment_identifier`	NX_CHAR
`instrument`	NXinstrument		See table: NXsnshisto: NXentry/instrument:NXinstrument
	NXmonitor		Occurences: 0 : default See table: NXsnshisto: NXentry/NXmonitor
`notes`	NX_CHAR
`proton_charge`	NX_FLOAT	NX_CHARGE
`raw_frames`	NX_INT
`run_number`	NX_CHAR
`sample`	NXsample		See table: NXsnshisto: NXentry/sample:NXsample
`start_time`	NX_DATE_TIME
`title`	NX_CHAR
`total_counts`	NX_UINT	NX_UNITLESS
`total_uncounted_counts`	NX_UINT	NX_UNITLESS
	NXuser		Occurences: 1 : default See table: NXsnshisto: NXentry/NXuser

Table 3.319. NXsnshisto: NXentry/DASlogs:NXcollection

Name and Attributes

Type

Units

Description (and Occurrences)

NXlog

Occurences: 1 : default

See table: NXsnshisto: DASlogs:NXcollection/NXlog

NXpositioner

Motor logs from cvinfo file.

Occurences: 0 : default

See table: NXsnshisto: DASlogs:NXcollection/NXpositioner

Table 3.320. NXsnshisto: DASlogs:NXcollection/NXlog

Name and Attributes	Type	Description (and Occurrences)
`average_value`	NX_FLOAT
`average_value_error`	NX_FLOAT
`description`	NX_CHAR
`duration`	NX_FLOAT
`maximum_value`	NX_FLOAT
`minimum_value`	NX_FLOAT
`time`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="nvalue"`
`value`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="nvalue"`

Table 3.321. NXsnshisto: DASlogs:NXcollection/NXpositioner

Name and Attributes	Type	Description (and Occurrences)
`average_value`	NX_FLOAT
`average_value_error`	NX_FLOAT
`description`	NX_CHAR
`duration`	NX_FLOAT
`maximum_value`	NX_FLOAT
`minimum_value`	NX_FLOAT
`time`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="numvalue"`
`value`	NX_FLOAT	Dimensions: rank="1" dim: `index="1"value="numvalue"`

Table 3.322. NXsnshisto: NXentry/SNSHistoTool:NXnote

Name and Attributes	Type	Description (and Occurrences)
`SNSbanking_file_name`	NX_CHAR
`SNSmapping_file_name`	NX_CHAR
`author`	NX_CHAR
`command1`	NX_CHAR	Command string for event2histo_nxl.
`date`	NX_CHAR
`description`	NX_CHAR
`version`	NX_CHAR

Table 3.323. NXsnshisto: NXentry/instrument:NXinstrument

Name and Attributes	Type	Description (and Occurrences)
`SNS`	NXsource	See table: NXsnshisto: instrument:NXinstrument/SNS:NXsource
`SNSdetector_calibration_id`	NX_CHAR	Detector calibration id from DAS.
`SNSgeometry_file_name`	NX_CHAR
`SNStranslation_service`	NX_CHAR
	NXdetector	Occurences: 1 : default See table: NXsnshisto: instrument:NXinstrument/NXdetector
`beamline`	NX_CHAR
	NXdisk_chopper	Original specification called for NXchopper, which is not a valid NeXus base class. Select either NXdisk_chopper or NXfermi_chopper, as appropriate. Occurences: 0 : default See table: NXsnshisto: instrument:NXinstrument/NXdisk_chopper
	NXfermi_chopper	Original specification called for NXchopper, which is not a valid NeXus base class. Select either NXdisk_chopper or NXfermi_chopper, as appropriate. Occurences: 0 : default See table: NXsnshisto: instrument:NXinstrument/NXfermi_chopper
`moderator`	NXmoderator	See table: NXsnshisto: instrument:NXinstrument/moderator:NXmoderator
`name`	NX_CHAR
	NXaperture	Occurences: 0 : default See table: NXsnshisto: instrument:NXinstrument/NXaperture
	NXattenuator	Occurences: 0 : default See table: NXsnshisto: instrument:NXinstrument/NXattenuator
	NXpolarizer	Occurences: 0 : default
	NXcrystal	Occurences: 0 : default See table: NXsnshisto: instrument:NXinstrument/NXcrystal

Table 3.324. NXsnshisto: instrument:NXinstrument/SNS:NXsource

Name and Attributes	Type	Units
`frequency`	NX_FLOAT	NX_FREQUENCY
`name`	NX_CHAR
`probe`	NX_CHAR
`type`	NX_CHAR

Table 3.325. NXsnshisto: instrument:NXinstrument/NXdetector

Name and Attributes	Type	Units	Description (and Occurrences)
`azimuthal_angle`	NX_FLOAT	NX_ANGLE	Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`data`	NX_UINT		Dimensions: rank="3" dim: `index="1"value="numx"` dim: `index="2"value="numy"` dim: `index="3"value="numtof"`
`data_x_time_of_flight`	NX_UINT		Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numtof"`
`data_x_y`	NX_UINT		Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`data_y_time_of_flight`	NX_UINT		Dimensions: rank="2" dim: `index="1"value="numy"` dim: `index="2"value="numtof"`
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`origin`	NXgeometry		See table: NXsnshisto: NXdetector/origin:NXgeometry
`pixel_id`	NX_UINT		Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`polar_angle`	NX_FLOAT	NX_ANGLE	Dimensions: rank="2" dim: `index="1"value="numx"` dim: `index="2"value="numy"`
`time_of_flight`	NX_FLOAT	NX_TIME_OF_FLIGHT	Dimensions: rank="1" dim: `index="1"value="numtof + 1"`
`total_counts`	NX_UINT
`x_pixel_offset`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="numx"`
`y_pixel_offset`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="numy"`

Table 3.326. NXsnshisto: NXdetector/origin:NXgeometry

Name and Attributes	Type	Description (and Occurrences)
`orientation`	NXorientation	See table: NXsnshisto: origin:NXgeometry/orientation:NXorientation
`shape`	NXshape	See table: NXsnshisto: origin:NXgeometry/shape:NXshape
`translation`	NXtranslation	See table: NXsnshisto: origin:NXgeometry/translation:NXtranslation

Table 3.327. NXsnshisto: origin:NXgeometry/orientation:NXorientation

Name and Attributes Type Units Description (and Occurrences)

value

NX_FLOAT

Six out of nine rotation parameters.

Dimensions: rank="1"

dim: index="1"value="6"

Table 3.328. NXsnshisto: origin:NXgeometry/shape:NXshape

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR
`shape`	NX_CHAR
`size`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.329. NXsnshisto: origin:NXgeometry/translation:NXtranslation

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.330. NXsnshisto: instrument:NXinstrument/NXdisk_chopper

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH

Table 3.331. NXsnshisto: instrument:NXinstrument/NXfermi_chopper

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH

Table 3.332. NXsnshisto: instrument:NXinstrument/moderator:NXmoderator

Name and Attributes	Type	Units
`coupling_material`	NX_CHAR
`distance`	NX_FLOAT	NX_LENGTH
`temperature`	NX_FLOAT	NX_TEMPERATURE
`type`	NX_CHAR

Table 3.333. NXsnshisto: instrument:NXinstrument/NXaperture

Name and Attributes	Type	Units	Description (and Occurrences)
`origin`	NXgeometry		See table: NXsnshisto: NXaperture/origin:NXgeometry
`x_pixel_offset`	NX_FLOAT	NX_LENGTH

Table 3.334. NXsnshisto: NXaperture/origin:NXgeometry

Name and Attributes	Type	Description (and Occurrences)
`orientation`	NXorientation	See table: NXsnshisto: origin:NXgeometry/orientation:NXorientation
`shape`	NXshape	See table: NXsnshisto: origin:NXgeometry/shape:NXshape
`translation`	NXtranslation	See table: NXsnshisto: origin:NXgeometry/translation:NXtranslation

Table 3.335. NXsnshisto: origin:NXgeometry/orientation:NXorientation

Name and Attributes Type Units Description (and Occurrences)

value

NX_FLOAT

Six out of nine rotation parameters.

Dimensions: rank="1"

dim: index="1"value="6"

Table 3.336. NXsnshisto: origin:NXgeometry/shape:NXshape

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR
`shape`	NX_CHAR
`size`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.337. NXsnshisto: origin:NXgeometry/translation:NXtranslation

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.338. NXsnshisto: instrument:NXinstrument/NXattenuator

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH

Table 3.339. NXsnshisto: instrument:NXinstrument/NXcrystal

Name and Attributes	Type	Units	Description (and Occurrences)
`origin`	NXgeometry		See table: NXsnshisto: NXcrystal/origin:NXgeometry
`type`	NX_CHAR
`wavelength`	NX_FLOAT	NX_WAVELENGTH

Table 3.340. NXsnshisto: NXcrystal/origin:NXgeometry

Name and Attributes	Type	Description (and Occurrences)
`description`	NX_CHAR
`orientation`	NXorientation	See table: NXsnshisto: origin:NXgeometry/orientation:NXorientation
`shape`	NXshape	See table: NXsnshisto: origin:NXgeometry/shape:NXshape
`translation`	NXtranslation	See table: NXsnshisto: origin:NXgeometry/translation:NXtranslation

Table 3.341. NXsnshisto: origin:NXgeometry/orientation:NXorientation

Name and Attributes Type Units Description (and Occurrences)

value

NX_FLOAT

Six out of nine rotation parameters.

Dimensions: rank="1"

dim: index="1"value="6"

Table 3.342. NXsnshisto: origin:NXgeometry/shape:NXshape

Name and Attributes	Type	Units
`description`	NX_CHAR
`shape`	NX_CHAR
`size`	NX_FLOAT	NX_LENGTH

Table 3.343. NXsnshisto: origin:NXgeometry/translation:NXtranslation

Name and Attributes	Type	Units	Description (and Occurrences)
`distance`	NX_FLOAT	NX_LENGTH	Dimensions: rank="1" dim: `index="1"value="3"`

Table 3.344. NXsnshisto: NXentry/NXmonitor

Name and Attributes	Type	Units	Description (and Occurrences)
`data`	NX_UINT		Dimensions: rank="1" dim: `index="1"value="numtimechannels"`
`distance`	NX_FLOAT	NX_LENGTH
`mode`	NX_CHAR
`time_of_flight`	NX_FLOAT	NX_TIME	Dimensions: rank="1" dim: `index="1"value="numtimechannels + 1"`

Table 3.345. NXsnshisto: NXentry/sample:NXsample

Name and Attributes	Type	Description (and Occurrences)
`changer_position`	NX_CHAR
`holder`	NX_CHAR
`identifier`	NX_CHAR
`name`	NX_CHAR	Descriptive name of sample
`nature`	NX_CHAR

Table 3.346. NXsnshisto: NXentry/NXuser

Name and Attributes	Type	Units	Description (and Occurrences)
`facility_user_id`	NX_CHAR
`name`	NX_CHAR
`role`	NX_CHAR

NXsolenoid_magnet

category

contributed(contributed definition)

NXDL source:

NXsolenoid_magnet

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXsolenoid_magnet.nxdl.xml)

version

1.0

SVN Id

Id: NXsolenoid_magnet.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXlog

symbol list

No symbol table.

documentation

definition for a solenoid magnet.

Example 3.87. Basic structure of NXsolenoid_magnet

        NXsolenoid_magnet (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline_distance:NX_FLOAT
  description:NX_CHAR
  set_current:NX_FLOAT
  read_current:NXlog
    value:NX_CHAR
  read_voltage:NXlog
    value:NX_CHAR

Table 3.347. NXsolenoid_magnet

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR		extended description of the magnet.
`beamline_distance`	NX_FLOAT	NX_LENGTH	define position of beamline element relative to production target Occurences: 0 : 1
`set_current`	NX_FLOAT	NX_CURRENT	current set on supply. Occurences: 0 : 1
`read_current`	NXlog		current read from supply. Occurences: 0 : 1 See table: NXsolenoid_magnet: NXsolenoid_magnet/read_current:NXlog
`read_voltage`	NXlog		voltage read from supply. Occurences: 0 : 1 See table: NXsolenoid_magnet: NXsolenoid_magnet/read_voltage:NXlog

Table 3.348. NXsolenoid_magnet: NXsolenoid_magnet/read_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.349. NXsolenoid_magnet: NXsolenoid_magnet/read_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

NXspin_rotator

category

contributed(contributed definition)

NXDL source:

NXspin_rotator

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXspin_rotator.nxdl.xml)

version

1.0

SVN Id

Id: NXspin_rotator.nxdl.xml 1060 2012-03-06 15:00:33Z Pete Jemian

extends class:

NXobject

other classes included:

NXlog

symbol list

No symbol table.

documentation

definition for a spin rotator.

Example 3.88. Basic structure of NXspin_rotator

        NXspin_rotator (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  beamline_distance:NX_FLOAT
  description:NX_CHAR
  set_Bfield_current:NX_FLOAT
  set_Efield_voltage:NX_FLOAT
  read_Bfield_current:NXlog
    value:NX_CHAR
  read_Bfield_voltage:NXlog
    value:NX_CHAR
  read_Efield_current:NXlog
    value:NX_CHAR
  read_Efield_voltage:NXlog
    value:NX_CHAR

Table 3.350. NXspin_rotator

Name and Attributes	Type	Units	Description (and Occurrences)
`description`	NX_CHAR		extended description of the spin rotator.
`beamline_distance`	NX_FLOAT	NX_LENGTH	define position of beamline element relative to production target Occurences: 0 : 1
`set_Bfield_current`	NX_FLOAT	NX_CURRENT	current set on magnet supply. Occurences: 0 : 1
`read_Bfield_current`	NXlog		current read from magnet supply. Occurences: 0 : 1 See table: NXspin_rotator: NXspin_rotator/read_Bfield_current:NXlog
`read_Bfield_voltage`	NXlog		voltage read from magnet supply. Occurences: 0 : 1 See table: NXspin_rotator: NXspin_rotator/read_Bfield_voltage:NXlog
`set_Efield_voltage`	NX_FLOAT	NX_VOLTAGE	current set on HT supply. Occurences: 0 : 1
`read_Efield_current`	NXlog		current read from HT supply. Occurences: 0 : 1 See table: NXspin_rotator: NXspin_rotator/read_Efield_current:NXlog
`read_Efield_voltage`	NXlog		voltage read from HT supply. Occurences: 0 : 1 See table: NXspin_rotator: NXspin_rotator/read_Efield_voltage:NXlog

Table 3.351. NXspin_rotator: NXspin_rotator/read_Bfield_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.352. NXspin_rotator: NXspin_rotator/read_Bfield_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

Table 3.353. NXspin_rotator: NXspin_rotator/read_Efield_current:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_CURRENT

Table 3.354. NXspin_rotator: NXspin_rotator/read_Efield_voltage:NXlog

Name and Attributes	Type	Units	Description (and Occurrences)
`value`	NX_CHAR	NX_VOLTAGE

NXtechnical_data

category

contributed(contributed definition)

NXDL source:

NXtechnical_data

(http://svn.nexusformat.org/definitions/trunk/contributed_definitions/NXtechnical_data.nxdl.xml)

version

1.0

SVN Id

Id: NXtechnical_data.nxdl.xml 1045 2012-02-13 00:10:56Z Freddie Akeroyd

extends class:

NXobject

other classes included:

no included classes

symbol list

No symbol table.

documentation

(definition implied by usage) Some measure of metadata not already considered by the other base classes. This class appears in the example data files provided from Soleil. This class should be considered as a base class (and relocated there, once approved by the NIAC). This class is used by Soleil as a child of (at least) these classes: NXsai_controller, NXdetector, NXsource

Example 3.89. Basic structure of NXtechnical_data

        NXtechnical_data (contributed definition, version 1.0)
  (base class definition, NXentry or NXsubentry not found)
  data:NX_NUMBER
    @units
    @timestamp
    @description
  description:NX_CHAR
    @description

Table 3.355. NXtechnical_data

Name and Attributes	Type	Units	Description (and Occurrences)
`data`	NX_NUMBER	NX_ANY	The value(s) of this class. Examples from Soleil show this used as float (64-bit or 32-bit), integer, or unsigned 8-bit char
`@units`	NX_CHAR		Engineering units
`@timestamp`	NX_DATE_TIME		date and time when this value was obtained.
`@description`	NX_CHAR		something useful about this data field
`description`	NX_CHAR		{documentation for this instance of NXtechnical_data}
`@description`	NX_CHAR		something useful about this decription field

Prev	Up	Next
NeXus Application Classes	Home	Chapter 4. Examples of writing and reading NeXus data files