.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXfiber.nxdl.xml -- DO NOT EDIT .. index:: ! NXfiber (base class) ! fiber (base class) see: fiber (base class); NXfiber .. _NXfiber: ======= NXfiber ======= **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: An optical fiber, e.g. glass fiber. ... An optical fiber, e.g. glass fiber. Specify the quantities that define the fiber. Fiber optics are described in detail [here](https://www.photonics.com/Article.aspx?AID=25151&PID=4), for example. **Symbols**: **N_spectrum_core**: Length of the spectrum vector (e.g. wavelength or energy) for which the refractive index of the core material is given. **N_spectrum_clad**: Length of the spectrum vector (e.g. wavelength or energy) for which the refractive index of the cladding material is given. **N_spectrum_attenuation**: Length of the spectrum vector (e.g. wavelength or energy) for which the attenuation curve is given. **Groups cited**: :ref:`NXsample` .. index:: NXsample (base class); used in base class **Structure**: .. _/NXfiber/description-field: .. index:: description (field) **description**: (recommended) :ref:`NX_CHAR ` .. collapse:: Descriptive name or brief description of the fiber, e.g. by stating its ... Descriptive name or brief description of the fiber, e.g. by stating its dimension. The dimension of a fiber can be given as 60/100/200 which refers to a core diameter of 60 micron, a clad diameter of 100 micron, and a coating diameter of 200 micron. .. _/NXfiber/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` .. collapse:: Type/mode of the fiber. Modes of fiber transmission are shown in ... Type/mode of the fiber. Modes of fiber transmission are shown in Fig. 5 [here](https://www.photonics.com/Article.aspx?AID=25151&PID=4). Any of these values: * ``single mode`` * ``multimode graded index`` * ``multimode step index`` .. _/NXfiber/dispersion_type-field: .. index:: dispersion_type (field) **dispersion_type**: (optional) :ref:`NX_CHAR ` .. collapse:: Type of dispersion. ... Type of dispersion. Any of these values: ``modal`` | ``material`` | ``chromatic`` .. _/NXfiber/dispersion-field: .. index:: dispersion (field) **dispersion**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [N_spectrum_core]) {units=\ :ref:`NX_TIME `} .. collapse:: Spectrum-dependent (or refractive index-dependent) dispersion of the ... Spectrum-dependent (or refractive index-dependent) dispersion of the fiber. Specify in ps/nm*km. .. _/NXfiber/length-field: .. index:: length (field) **length**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Length of the fiber. .. _/NXfiber/spectral_range-field: .. index:: spectral_range (field) **spectral_range**: (recommended) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_ANY `} .. collapse:: Spectral range for which the fiber is designed. Enter the minimum and ... Spectral range for which the fiber is designed. Enter the minimum and maximum values (lower and upper limit) of the wavelength range. .. _/NXfiber/spectral_range@units-attribute: .. index:: units (field attribute) **@units**: (optional) :ref:`NX_CHAR ` .. collapse:: Unit of spectral array (e.g. nanometer or angstrom for wavelength, or ... Unit of spectral array (e.g. nanometer or angstrom for wavelength, or electronvolt for energy etc.). .. _/NXfiber/transfer_rate-field: .. index:: transfer_rate (field) **transfer_rate**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Transfer rate of the fiber (in GB per second). .. _/NXfiber/transfer_rate@units-attribute: .. index:: units (field attribute) **@units**: (optional) :ref:`NX_CHAR ` GB/s .. _/NXfiber/numerical_aperture-field: .. index:: numerical_aperture (field) **numerical_aperture**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} Numerical aperture (NA) of the fiber. .. _/NXfiber/attenuation-field: .. index:: attenuation (field) **attenuation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [N_spectrum_attenuation]) {units=\ :ref:`NX_ANY `} Wavelength-dependent attenuation of the fiber (specify in dB/km). .. _/NXfiber/attenuation@units-attribute: .. index:: units (field attribute) **@units**: (optional) :ref:`NX_CHAR ` .. collapse:: Use dB/km. ... Use dB/km. Obligatory value: ``dB/km`` .. _/NXfiber/power_loss-field: .. index:: power_loss (field) **power_loss**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} Power loss of the fiber in percentage. .. _/NXfiber/acceptance_angle-field: .. index:: acceptance_angle (field) **acceptance_angle**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Acceptance angle of the fiber. .. _/NXfiber/core-group: **core**: (optional) :ref:`NXsample` Core of the fiber, i.e. the part of the fiber which transmits the light. .. _/NXfiber/core/core_material-field: .. index:: core_material (field) **core_material**: (optional) :ref:`NX_CHAR ` Specify the material of the core of the fiber. .. _/NXfiber/core/core_diameter-field: .. index:: core_diameter (field) **core_diameter**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Core diameter of the fiber (e.g. given in micrometer). .. _/NXfiber/core/core_index_of_refraction-field: .. index:: core_index_of_refraction (field) **core_index_of_refraction**: (optional) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [2, N_spectrum_core]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: Complex index of refraction of the fiber. Specify at given wavelength ... Complex index of refraction of the fiber. Specify at given wavelength (or energy, wavenumber etc.) values. .. _/NXfiber/cladding-group: **cladding**: (optional) :ref:`NXsample` Core of the fiber, i.e. the part of the fiber which transmits the light. .. _/NXfiber/cladding/clad_material-field: .. index:: clad_material (field) **clad_material**: (optional) :ref:`NX_CHAR ` Specify the material of the core of the fiber. .. _/NXfiber/cladding/clad_diameter-field: .. index:: clad_diameter (field) **clad_diameter**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Clad diameter of the fiber (e.g. given in micrometer). .. _/NXfiber/cladding/clad_index_of_refraction-field: .. index:: clad_index_of_refraction (field) **clad_index_of_refraction**: (optional) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [2, N_spectrum_clad]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: Complex index of refraction of the fiber. Specify at given wavelength ... Complex index of refraction of the fiber. Specify at given wavelength (or energy, wavenumber etc.) values. .. _/NXfiber/coating-group: **coating**: (optional) :ref:`NXsample` Coating of the fiber. .. _/NXfiber/coating/coating_material-field: .. index:: coating_material (field) **coating_material**: (optional) :ref:`NX_CHAR ` Specify the material of the coating of the fiber. .. _/NXfiber/coating/coating_diameter-field: .. index:: coating_diameter (field) **coating_diameter**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Outer diameter of the fiber (e.g. given in micrometer). Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXfiber/acceptance_angle-field ` * :ref:`/NXfiber/attenuation-field ` * :ref:`/NXfiber/attenuation@units-attribute ` * :ref:`/NXfiber/cladding-group ` * :ref:`/NXfiber/cladding/clad_diameter-field ` * :ref:`/NXfiber/cladding/clad_index_of_refraction-field ` * :ref:`/NXfiber/cladding/clad_material-field ` * :ref:`/NXfiber/coating-group ` * :ref:`/NXfiber/coating/coating_diameter-field ` * :ref:`/NXfiber/coating/coating_material-field ` * :ref:`/NXfiber/core-group ` * :ref:`/NXfiber/core/core_diameter-field ` * :ref:`/NXfiber/core/core_index_of_refraction-field ` * :ref:`/NXfiber/core/core_material-field ` * :ref:`/NXfiber/description-field ` * :ref:`/NXfiber/dispersion-field ` * :ref:`/NXfiber/dispersion_type-field ` * :ref:`/NXfiber/length-field ` * :ref:`/NXfiber/numerical_aperture-field ` * :ref:`/NXfiber/power_loss-field ` * :ref:`/NXfiber/spectral_range-field ` * :ref:`/NXfiber/spectral_range@units-attribute ` * :ref:`/NXfiber/transfer_rate-field ` * :ref:`/NXfiber/transfer_rate@units-attribute ` * :ref:`/NXfiber/type-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXfiber.nxdl.xml