.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXcircuit.nxdl.xml -- DO NOT EDIT .. index:: ! NXcircuit (base class) ! circuit (base class) see: circuit (base class); NXcircuit .. _NXcircuit: ========= NXcircuit ========= **Status**: base class, extends :ref:`NXcomponent` **Description**: .. collapse:: Base class for documenting circuit devices. ... Base class for documenting circuit devices. Electronic circuits are hardware components that connect several electronic components to achieve specific functionality, e.g. amplifying a voltage or convert a voltage to binary numbers, etc. **Symbols**: No symbol table **Groups cited**: :ref:`NXcalibration`, :ref:`NXfabrication` .. index:: NXfabrication (base class); used in base class, NXcalibration (base class); used in base class **Structure**: .. _/NXcircuit/components-field: .. index:: components (field) **components**: (optional) :ref:`NX_CHAR ` .. collapse:: List of components used in the circuit, e.g., resistors, capacitors, transisto ... List of components used in the circuit, e.g., resistors, capacitors, transistors or any other complex components. .. _/NXcircuit/connections-field: .. index:: connections (field) **connections**: (optional) :ref:`NX_CHAR ` .. collapse:: Description of how components are interconnected, including connection points ... Description of how components are interconnected, including connection points and wiring. .. _/NXcircuit/power_source-field: .. index:: power_source (field) **power_source**: (optional) :ref:`NX_CHAR ` .. collapse:: Details of the power source for the circuit, including voltage and current ... Details of the power source for the circuit, including voltage and current ratings. .. _/NXcircuit/signal_type-field: .. index:: signal_type (field) **signal_type**: (optional) :ref:`NX_CHAR ` .. collapse:: Type of signal (input signal) the circuit is designed to handle, e.g., analog, ... Type of signal (input signal) the circuit is designed to handle, e.g., analog, digital, mixed-signal. .. _/NXcircuit/operating_frequency-field: .. index:: operating_frequency (field) **operating_frequency**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_FREQUENCY `} .. collapse:: The operating frequency of the circuit, see also bandwidth, which is possibly ... The operating frequency of the circuit, see also bandwidth, which is possibly but not necessarily centered around this frequency (e.g. running a 100 kHz bandwidth amplifier at low, audio frequencies 1 - 20,000 Hz). .. _/NXcircuit/bandwidth-field: .. index:: bandwidth (field) **bandwidth**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_FREQUENCY `} The bandwidth of the frequency response of the circuit. .. _/NXcircuit/input_impedance-field: .. index:: input_impedance (field) **input_impedance**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Input impedance of the circuit. .. _/NXcircuit/output_impedance-field: .. index:: output_impedance (field) **output_impedance**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Output impedance of the circuit. .. _/NXcircuit/gain-field: .. index:: gain (field) **gain**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} .. collapse:: Gain of the circuit, if applicable, usually all instruments have a gain ... Gain of the circuit, if applicable, usually all instruments have a gain which might be important or not. .. _/NXcircuit/noise_level-field: .. index:: noise_level (field) **noise_level**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} .. collapse:: Root-mean-square (RMS) noise level (in current or voltage) ... Root-mean-square (RMS) noise level (in current or voltage) in the circuit in voltage or current. .. _/NXcircuit/temperature_range-field: .. index:: temperature_range (field) **temperature_range**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Operating temperature range of the circuit. .. _/NXcircuit/offset-field: .. index:: offset (field) **offset**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Offset value for current or voltage. .. _/NXcircuit/output_channels-field: .. index:: output_channels (field) **output_channels**: (optional) :ref:`NX_NUMBER ` Number of output channels connected to this circuit. Most probably N_channel. .. _/NXcircuit/output_signal-field: .. index:: output_signal (field) **output_signal**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Type of output signal, e.g., voltage, current, digital. .. _/NXcircuit/power_consumption-field: .. index:: power_consumption (field) **power_consumption**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Power consumption of the circuit per unit time. .. _/NXcircuit/status_indicators-field: .. index:: status_indicators (field) **status_indicators**: (optional) :ref:`NX_CHAR ` Status indicators for the circuit, e.g., LEDs, display readouts. .. _/NXcircuit/protection_features-field: .. index:: protection_features (field) **protection_features**: (optional) :ref:`NX_CHAR ` .. collapse:: Protection features built into the circuit, e.g., overvoltage protection, ... Protection features built into the circuit, e.g., overvoltage protection, thermal shutdown. .. _/NXcircuit/acquisition_time-field: .. index:: acquisition_time (field) **acquisition_time**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} .. collapse:: Updated rate for several processes using the input signal, e.g., History Graph ... Updated rate for several processes using the input signal, e.g., History Graph, the circuit uses for any such process. .. _/NXcircuit/output_slew_rate-field: .. index:: output_slew_rate (field) **output_slew_rate**: (optional) :ref:`NX_CHAR ` .. collapse:: The rate at which the signal changes when ramping from the starting ... The rate at which the signal changes when ramping from the starting value. .. _/NXcircuit/hardware-group: **hardware**: (optional) :ref:`NXfabrication` :ref:`⤆ ` .. collapse:: Hardware where the circuit is implanted; includes information about the ... Hardware where the circuit is implanted; includes information about the hardware manufacturers and type (e.g. part number) All the elements below may be single numbers of an array of values with length N_channel describing multiple input and output channels. .. _/NXcircuit/calibration-group: **calibration**: (optional) :ref:`NXcalibration` Calibration data for the circuit. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXcircuit/acquisition_time-field ` * :ref:`/NXcircuit/bandwidth-field ` * :ref:`/NXcircuit/calibration-group ` * :ref:`/NXcircuit/components-field ` * :ref:`/NXcircuit/connections-field ` * :ref:`/NXcircuit/gain-field ` * :ref:`/NXcircuit/hardware-group ` * :ref:`/NXcircuit/input_impedance-field ` * :ref:`/NXcircuit/noise_level-field ` * :ref:`/NXcircuit/offset-field ` * :ref:`/NXcircuit/operating_frequency-field ` * :ref:`/NXcircuit/output_channels-field ` * :ref:`/NXcircuit/output_impedance-field ` * :ref:`/NXcircuit/output_signal-field ` * :ref:`/NXcircuit/output_slew_rate-field ` * :ref:`/NXcircuit/power_consumption-field ` * :ref:`/NXcircuit/power_source-field ` * :ref:`/NXcircuit/protection_features-field ` * :ref:`/NXcircuit/signal_type-field ` * :ref:`/NXcircuit/status_indicators-field ` * :ref:`/NXcircuit/temperature_range-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXcircuit.nxdl.xml