diff --git a/optical_spectroscopy/luminescence/NXbeam_path.yaml b/optical_spectroscopy/luminescence/NXbeam_path.yaml index 8ad9eea..115a8a2 100644 --- a/optical_spectroscopy/luminescence/NXbeam_path.yaml +++ b/optical_spectroscopy/luminescence/NXbeam_path.yaml @@ -33,6 +33,7 @@ doc: | (NXaperture): # NeXus manual: 'A beamline aperture. This group is deprecated, use NXslit # instead.' + # also, duplicates NXpinhole? (NXcrystal): # doc: "A crystal monochromator or analyzer." @@ -43,6 +44,7 @@ doc: | (NXattenuator): # doc: "A device that reduces the intensity of a beam by attenuation." + # another variant of NXfilter? i.e. neutral density filter (NXgrating): doc: "A diffraction grating. Define relevant parameters in the @@ -74,6 +76,7 @@ doc: | (NXbeam_splitter): doc: "A beam splitter splitting the light beam in two." + # could infer that two independent NXbeam_path follow (unless it is part of a confocal setup splitting the excitation and detection paths) (NXwaveplate): # or NXretarder? doc: "A device that changes the polarization state of a light beam." @@ -90,4 +93,4 @@ doc: | doc: "An optical fiber." # define: type/mode, material, refractive index, length, wavelength range, # bandwidth or transfer rate, numerical aperture (angle) - \ No newline at end of file + diff --git a/optical_spectroscopy/luminescence/NXluminescence.yaml b/optical_spectroscopy/luminescence/NXluminescence.yaml index 1e5f3b6..e6659f2 100644 --- a/optical_spectroscopy/luminescence/NXluminescence.yaml +++ b/optical_spectroscopy/luminescence/NXluminescence.yaml @@ -155,19 +155,26 @@ symbols: luminescence_type: enumeration: [photoluminescence, cathodoluminescence, electroluminescence, x-rays, sonoluminescence, chemiluminescence, bioluminescence] + # 'x-ray fluorescence' instead of 'x-rays'? - excitation(NXsubentry): + excitation(NXsubentry): # doc: "Properties of the excitation source. The user has to define at least one of the excitation sources, i.e. at least one of the subclasses describing various sources has to be filled out. The beam path between the excitation source and the sample should be described in beam_path_before." - + # 'beam_path_excitation' instead of 'beam_path_before'? + + # An alternative could be that 'beam_path_excitation' actually moves up in the hierarchy, + # and then the source is the first element in the beam path + type: doc: "Type of excitation source." enumeration: [laser, lamp, X-rays, silicon carbide globar, super continuum, chemical reaction, ultrasound, living organism, other] + # 'electron beam' - in that case, to really track all relevant metadata, probably the corresponding + # NXclass for a scanning or transmission electron microscope would need to be used, see below other_source: exists: optional doc: "If you specified 'other' as excitation source type, please @@ -201,7 +208,14 @@ symbols: doc: "Source for bioluminescence. Describe what organism was used and under what conditions." + electron_source(NXem): # use base class that is being developed for electron microscopy, so far only the vendor spedific NXem_nion + exists: optional + doc: "Source for cathodoluminescence. Describe the experimental + conditions under which the electron microscope is operated." + # sort sources alphabetically? + beam_path_before(NXbeam_path): + # 'beam_path_excitation' instead of 'beam_path_before'? exists: optional doc: "Description of the beam path between the excitation source and the sample ('before' the sample). Describe all relevant optical @@ -211,14 +225,20 @@ symbols: doc: "The detection unit usually consists of a spectrometer, dispersive element/monochromator, and a detector. Describe the beam path between the sample and the detection unit in beam_path_after." + # 'beam_path_detection' instead of 'beam_path_after'? + # optical elements can be before or after the spectrometer (which can also be left out + # when working with filters only -> so maybe move spectrometer to the beam path>) + # An alternative could be that 'beam_path_detection' actually moves up in the hierarchy, + # and then the detector is the last element in the beam path + beam_path_after(NXbeam_path): exists: optional doc: "Description of the beam path between the sample and the detector unit ('after' the sample). Describe all relevant optical elements and their parameters in the appropriate subclasses." - spectrometer(NXdetector): + spectrometer(NXdetector): # NXmonochromomator? The detector is the CCD, PMT, StreakCamera, ... doc: "Which type of spectrometer/detector and dispersive element." dispersive_element(NXmonochromator): # NXgrating? @@ -237,6 +257,7 @@ symbols: enumeration: [PMT, photodiode, avalanche diode, CCD camera, CCD spectrometer, bolometer, other] # x-ray detector? + # streak camera for time-resolved measurements? # which kind of CCD # base class for optical detectors: details about CCD, PMT etc. # detection mode (lock-in, etc.) @@ -301,6 +322,7 @@ symbols: dimensions: rank: 1 dim: [[1, N_wavelength]] + # even though wavelength may be recommended, signal axis could also be in energy or wavenumber and then calling it wavelength is confusing measured_data(NX_NUMBER): doc: "Resulting data from the measurement, described by data type." @@ -433,7 +455,7 @@ symbols: in a free-text description, e.g. 'center of sample, long edge parallel to plane of incidence'." - window(NXaperture): + window(NXaperture): # part of the beam path? exists: optional doc: "For environmental measurements, the environment (liquid, vapor etc.) is enclosed in a cell, which has windows both in the direction @@ -505,3 +527,4 @@ symbols: doc: "We recommend to use wavelength as a default attribute, but it can be replaced by any suitable parameter along the X-axis." # How to record excitation spectrum? + # Possibility for Maps and Linescans, i.e. additional navigation axes