.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXwaveplate.nxdl.xml -- DO NOT EDIT .. index:: ! NXwaveplate (base class) ! waveplate (base class) see: waveplate (base class); NXwaveplate .. _NXwaveplate: =========== NXwaveplate =========== **Status**: base class, extends :ref:`NXcomponent` **Description**: A waveplate or retarder. **Symbols**: **N_spectrum**: Size of the wavelength array for which the refractive index of the material and/or coating is given. **N_wavelengths**: Number of discrete wavelengths for which the waveplate is designed. If it operates for a range of wavelengths then N_wavelengths = 2 and the minimum and maximum values of the range should be provided. **Groups cited**: :ref:`NXdata`, :ref:`NXsample` .. index:: NXdata (base class); used in base class, NXsample (base class); used in base class **Structure**: .. _/NXwaveplate/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` .. collapse:: Type of waveplate (e.g. achromatic or zero-order). ... Type of waveplate (e.g. achromatic or zero-order). Any of these values or a custom value (if you use a custom value, also set @custom=True): * ``zero-order`` * ``achromatic`` * ``multiple-order`` * ``dual-wavelength`` .. _/NXwaveplate/retardance-field: .. index:: retardance (field) **retardance**: (optional) :ref:`NX_CHAR ` .. collapse:: Specify the retardance of the waveplate (e.g. full-wave, half-wave ... Specify the retardance of the waveplate (e.g. full-wave, half-wave (lambda/2), quarter-wave (lambda/4)). Any of these values: ``full-wave`` | ``half-wave`` | ``quarter-wave`` .. _/NXwaveplate/wavelengths-field: .. index:: wavelengths (field) **wavelengths**: (recommended) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [N_wavelengths]) .. collapse:: Discrete wavelengths for which the waveplate is designed. If the ... Discrete wavelengths for which the waveplate is designed. If the waveplate operates over an entire range of wavelengths, enter the minimum and maximum values of the wavelength range (in this case N_wavelengths = 2). In this case, also use type="achromatic". .. _/NXwaveplate/diameter-field: .. index:: diameter (field) **diameter**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Diameter of the waveplate (if the waveplate is circular). .. _/NXwaveplate/clear_aperture-field: .. index:: clear_aperture (field) **clear_aperture**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} .. collapse:: Clear aperture of the device (e.g. 90% of diameter for a disc or 90% of ... Clear aperture of the device (e.g. 90% of diameter for a disc or 90% of length/height for square geometry). .. _/NXwaveplate/reflectance-field: .. index:: reflectance (field) **reflectance**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} Average reflectance of the waveplate in percentage. .. _/NXwaveplate/retardance_distribution-group: **retardance_distribution**: (optional) :ref:`NXdata` :ref:`⤆ ` Wavelength resolved retardance of the waveplate. .. _/NXwaveplate/substrate-group: **substrate**: (optional) :ref:`NXsample` .. collapse:: Describe the material of the substrate of the waveplate in ... Describe the material of the substrate of the waveplate in substrate/substrate_material and provide its index of refraction in substrate/index_of_refraction_substrate, if known. .. _/NXwaveplate/substrate/substrate_material-field: .. index:: substrate_material (field) **substrate_material**: (optional) :ref:`NX_CHAR ` .. collapse:: Specify the material of the waveplate. If the device has a ... Specify the material of the waveplate. If the device has a coating it should be described in coating/coating_material. .. _/NXwaveplate/substrate/substrate_thickness-field: .. index:: substrate_thickness (field) **substrate_thickness**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} Thickness of the waveplate substrate. .. _/NXwaveplate/substrate/index_of_refraction_substrate-field: .. index:: index_of_refraction_substrate (field) **index_of_refraction_substrate**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [2, N_spectrum]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: Complex index of refraction of the waveplate substrate. Specify at ... Complex index of refraction of the waveplate substrate. Specify at given wavelength (or energy, wavenumber etc.) values. .. _/NXwaveplate/coating-group: **coating**: (optional) :ref:`NXsample` .. collapse:: Is the waveplate coated? If yes, specify the type and material of the ... Is the waveplate coated? If yes, specify the type and material of the coating and the wavelength range for which it is designed. If known, you may also provide its index of refraction. .. _/NXwaveplate/coating/coating_type-field: .. index:: coating_type (field) **coating_type**: (optional) :ref:`NX_CHAR ` .. collapse:: Specify the coating type (e.g. dielectric, anti-reflection (AR), ... Specify the coating type (e.g. dielectric, anti-reflection (AR), multilayer coating etc.). .. _/NXwaveplate/coating/coating_material-field: .. index:: coating_material (field) **coating_material**: (optional) :ref:`NX_CHAR ` Specify the coating material. .. _/NXwaveplate/coating/coating_thickness-field: .. index:: coating_thickness (field) **coating_thickness**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} Thickness of the coating. .. _/NXwaveplate/coating/wavelength_range_coating-field: .. index:: wavelength_range_coating (field) **wavelength_range_coating**: (recommended) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [2]) .. collapse:: Wavelength range for which the coating is designed. Enter the minimum ... Wavelength range for which the coating is designed. Enter the minimum and maximum values of the wavelength range. .. _/NXwaveplate/coating/index_of_refraction_coating-field: .. index:: index_of_refraction_coating (field) **index_of_refraction_coating**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [2, N_spectrum]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: Complex index of refraction of the coating. Specify at given spectral ... Complex index of refraction of the coating. Specify at given spectral values (wavelength, energy, wavenumber etc.). Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXwaveplate/clear_aperture-field ` * :ref:`/NXwaveplate/coating-group ` * :ref:`/NXwaveplate/coating/coating_material-field ` * :ref:`/NXwaveplate/coating/coating_thickness-field ` * :ref:`/NXwaveplate/coating/coating_type-field ` * :ref:`/NXwaveplate/coating/index_of_refraction_coating-field ` * :ref:`/NXwaveplate/coating/wavelength_range_coating-field ` * :ref:`/NXwaveplate/diameter-field ` * :ref:`/NXwaveplate/reflectance-field ` * :ref:`/NXwaveplate/retardance-field ` * :ref:`/NXwaveplate/retardance_distribution-group ` * :ref:`/NXwaveplate/substrate-group ` * :ref:`/NXwaveplate/substrate/index_of_refraction_substrate-field ` * :ref:`/NXwaveplate/substrate/substrate_material-field ` * :ref:`/NXwaveplate/substrate/substrate_thickness-field ` * :ref:`/NXwaveplate/type-field ` * :ref:`/NXwaveplate/wavelengths-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXwaveplate.nxdl.xml