ts_ids_components.chromatography.method module#
- Model MethodEvent[source]#
Bases:
IdsElementParameters describing when an event took place and who performed it.
Show JSON schema
{ "description": "Parameters describing when an event took place and who performed it.", "type": "object", "properties": { "computer": { "description": "Identifier of the computer.", "type": [ "string", "null" ] }, "comment": { "description": "Comments provided by user associated with the event.", "type": [ "string", "null" ] }, "time": { "$ref": "#/definitions/TimeWithRaw", "description": "Time that the event took place." }, "user": { "description": "User associated with the event.", "type": [ "string", "null" ] } }, "additionalProperties": false, "definitions": { "TimeWithRaw": { "additionalProperties": false, "properties": { "value": { "type": [ "string", "null" ] }, "raw_value": { "type": [ "string", "null" ] } }, "type": "object" } } }
- Validators:
- field time: TimeWithRaw#
Time that the event took place.
- Model Wash[source]#
Bases:
IdsElementParameters describing a wash step, e.g. of a loop or needle/syringe used for injection.
Show JSON schema
{ "description": "Parameters describing a wash step, e.g. of a loop or needle/syringe used for\ninjection.", "type": "object", "properties": { "repeat_count": { "description": "Number of times this step of the wash is repeated.", "type": [ "integer", "null" ] }, "timing": { "description": "Timing of this wash step in relation to the injection, e.g. before the injection, after the injection, or both.", "type": [ "string", "null" ] }, "solvent": { "description": "Solvent used for this wash step.", "type": [ "string", "null" ] }, "volume": { "$ref": "#/definitions/RawValueUnit", "description": "Volume of solvent used for this wash step." } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field timing: str | None#
Timing of this wash step in relation to the injection, e.g. before the injection, after the injection, or both.
- field volume: RawValueUnit#
Volume of solvent used for this wash step.
- Model Injection[source]#
Bases:
IdsElementParameters about the sample injection.
Show JSON schema
{ "description": "Parameters about the sample injection.", "type": "object", "properties": { "mode": { "description": "The injection mode, e.g. full loop or partial loop.", "type": [ "string", "null" ] }, "time": { "$ref": "#/definitions/TimeWithRaw", "description": "The time that the injection takes place." }, "volume": { "$ref": "#/definitions/RawValueUnit", "description": "Volume of sample to inject." }, "sample_temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature set point of the sample or sample tray." } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "TimeWithRaw": { "additionalProperties": false, "properties": { "value": { "type": [ "string", "null" ] }, "raw_value": { "type": [ "string", "null" ] } }, "type": "object" } } }
- Validators:
- field sample_temperature: RawValueUnit#
Temperature set point of the sample or sample tray.
- field time: TimeWithRaw#
The time that the injection takes place.
- field volume: RawValueUnit#
Volume of sample to inject.
- Model SampleIntroduction[source]#
Bases:
IdsElementThe sample introduction includes the sample and its associated quantities (volume, concentration, etc.) as well as the preparation steps (e.g. dilution), and autosampler methods.
Show JSON schema
{ "description": "The sample introduction includes the sample and its associated quantities (volume,\nconcentration, etc.) as well as the preparation steps (e.g. dilution), and\nautosampler methods.", "type": "object", "properties": { "washes": { "items": { "$ref": "#/definitions/Wash" }, "type": "array" }, "dilution_factor": { "$ref": "#/definitions/RawValueUnit", "description": "The dilution factor of the sample introduction." }, "injection": { "$ref": "#/definitions/Injection" }, "draw_speed": { "$ref": "#/definitions/RawValueUnit", "description": "The rate at which a sample is drawn." }, "dispense_speed": { "$ref": "#/definitions/RawValueUnit", "description": "The rate at which a sample is dispensed." } }, "additionalProperties": false, "definitions": { "Injection": { "additionalProperties": false, "description": "Parameters about the sample injection.", "properties": { "mode": { "description": "The injection mode, e.g. full loop or partial loop.", "type": [ "string", "null" ] }, "time": { "$ref": "#/definitions/TimeWithRaw", "description": "The time that the injection takes place." }, "volume": { "$ref": "#/definitions/RawValueUnit", "description": "Volume of sample to inject." }, "sample_temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature set point of the sample or sample tray." } }, "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "TimeWithRaw": { "additionalProperties": false, "properties": { "value": { "type": [ "string", "null" ] }, "raw_value": { "type": [ "string", "null" ] } }, "type": "object" }, "Wash": { "additionalProperties": false, "description": "Parameters describing a wash step, e.g. of a loop or needle/syringe used for\ninjection.", "properties": { "repeat_count": { "description": "Number of times this step of the wash is repeated.", "type": [ "integer", "null" ] }, "timing": { "description": "Timing of this wash step in relation to the injection, e.g. before the injection, after the injection, or both.", "type": [ "string", "null" ] }, "solvent": { "description": "Solvent used for this wash step.", "type": [ "string", "null" ] }, "volume": { "$ref": "#/definitions/RawValueUnit", "description": "Volume of solvent used for this wash step." } }, "type": "object" } } }
- Validators:
- field dilution_factor: RawValueUnit#
The dilution factor of the sample introduction.
- field dispense_speed: RawValueUnit#
The rate at which a sample is dispensed.
- field draw_speed: RawValueUnit#
The rate at which a sample is drawn.
- Model GasInlet[source]#
Bases:
IdsElementGas chromatography inlet method parameters.
Show JSON schema
{ "description": "Gas chromatography inlet method parameters.", "type": "object", "properties": { "fk_module": { "@foreign_key": "/properties/modules/items/properties/pk", "type": "string" }, "temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature of the inlet." }, "operating_mode": { "description": "Operating mode, e.g. split or splitless.", "type": [ "string", "null" ] }, "split_flow": { "$ref": "#/definitions/RawValueUnit", "description": "Flow rate for split mode injections." }, "split_flow_ratio": { "$ref": "#/definitions/RawValueUnit", "description": "Ratio of total flow of gas entering the inlet to column flow in split mode injections." }, "purge_flow": { "$ref": "#/definitions/RawValueUnit", "description": "Rate of the purge flow." }, "vacuum_compensation": { "description": "Whether vacuum correction is on at the start of the run, at 0 seconds retention time.", "type": [ "boolean", "null" ] } }, "additionalProperties": false, "required": [ "fk_module" ], "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field fk_module: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- field purge_flow: RawValueUnit#
Rate of the purge flow.
- field split_flow: RawValueUnit#
Flow rate for split mode injections.
- field split_flow_ratio: RawValueUnit#
Ratio of total flow of gas entering the inlet to column flow in split mode injections.
- field temperature: RawValueUnit#
Temperature of the inlet.
- Model Heater[source]#
Bases:
IdsElementHeater parameters.
Show JSON schema
{ "description": "Heater parameters.", "type": "object", "properties": { "location": { "description": "Description of the location of the heater in the column compartment, e.g. left or right.", "type": [ "string", "null" ] }, "temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature set point of the heater." } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field location: str | None#
Description of the location of the heater in the column compartment, e.g. left or right.
- field temperature: RawValueUnit#
Temperature set point of the heater.
- Model Column[source]#
Bases:
IdsElementColumn identifiers for this method.
Show JSON schema
{ "description": "Column identifiers for this method.", "type": "object", "properties": { "fk_column": { "@foreign_key": "/properties/columns/items/properties/pk", "type": "string" }, "name": { "description": "Name of the column.", "type": [ "string", "null" ] } }, "additionalProperties": false, "required": [ "fk_column" ] }
- Validators:
- Model Compartment[source]#
Bases:
IdsElementConfiguration of the column compartment.
Show JSON schema
{ "description": "Configuration of the column compartment.", "type": "object", "properties": { "fk_module": { "@foreign_key": "/properties/modules/items/properties/pk", "type": "string" }, "heaters": { "description": "Heater parameters.", "items": { "$ref": "#/definitions/Heater" }, "type": "array" }, "column": { "$ref": "#/definitions/Column", "description": "Column identifiers for this method." } }, "additionalProperties": false, "required": [ "fk_module" ], "definitions": { "Column": { "additionalProperties": false, "description": "Column identifiers for this method.", "properties": { "fk_column": { "@foreign_key": "/properties/columns/items/properties/pk", "type": "string" }, "name": { "description": "Name of the column.", "type": [ "string", "null" ] } }, "required": [ "fk_column" ], "type": "object" }, "Heater": { "additionalProperties": false, "description": "Heater parameters.", "properties": { "location": { "description": "Description of the location of the heater in the column compartment, e.g. left or right.", "type": [ "string", "null" ] }, "temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature set point of the heater." } }, "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- Model DetectionMethod[source]#
Bases:
IdsElementMetadata about a detection method.
Show JSON schema
{ "description": "Metadata about a detection method.", "type": "object", "properties": { "fk_module": { "@foreign_key": "/properties/modules/items/properties/pk", "type": "string" }, "name": { "description": "Name of the detector.", "type": [ "string", "null" ] }, "description": { "description": "Description of the detector channel.", "type": [ "string", "null" ] }, "data_collection_rate": { "$ref": "#/definitions/RawValueUnit", "description": "Frequency at which data is collected by the detector." }, "gain": { "$ref": "#/definitions/RawValueUnit", "description": "Parameters to adjust the sensitivity of the detector." } }, "additionalProperties": false, "required": [ "fk_module" ], "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field data_collection_rate: RawValueUnit#
Frequency at which data is collected by the detector.
- field fk_module: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- field gain: RawValueUnit#
Parameters to adjust the sensitivity of the detector.
- Model Electrode[source]#
Bases:
IdsElementElectrical parameters of an electrode.
Show JSON schema
{ "description": "Electrical parameters of an electrode.", "type": "object", "properties": { "voltage": { "$ref": "#/definitions/RawValueUnit", "description": "Electrode voltage." }, "current": { "$ref": "#/definitions/RawValueUnit", "description": "Current through the electrode." } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field current: RawValueUnit#
Current through the electrode.
- field voltage: RawValueUnit#
Electrode voltage.
- Model MassRange[source]#
Bases:
IdsElementRange of mass/charge ratios for mass spectra.
Show JSON schema
{ "description": "Range of mass/charge ratios for mass spectra.", "type": "object", "properties": { "minimum": { "$ref": "#/definitions/RawValueUnit", "description": "Minimum value in a range of mass/charge ratios." }, "maximum": { "$ref": "#/definitions/RawValueUnit", "description": "Maximum value in a range of mass/charge ratios." } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field maximum: RawValueUnit#
Maximum value in a range of mass/charge ratios.
- field minimum: RawValueUnit#
Minimum value in a range of mass/charge ratios.
- Model MassSpectrometerSettings[source]#
Bases:
IdsElementMass spectrometer settings for single spectra instruments, e.g. single quadrupole or TOF.
Show JSON schema
{ "description": "Mass spectrometer settings for single spectra instruments, e.g. single\nquadrupole or TOF.", "type": "object", "properties": { "polarity": { "description": "Polarity of generated ions.", "type": [ "string", "null" ] }, "source": { "$ref": "#/definitions/MassSpecSource", "description": "Ionization source parameters, including source voltage and current." }, "mass_range": { "$ref": "#/definitions/MassRange", "description": "Lower and upper cutoffs for m/z values detected." }, "selected_ions": { "description": "List of specific selected ions for detection.", "items": { "$ref": "#/definitions/SelectedIon" }, "type": "array" }, "full_scan_duration": { "$ref": "#/definitions/RawValueUnit", "description": "Duration of time of the full mass scan." } }, "additionalProperties": false, "definitions": { "Electrode": { "additionalProperties": false, "description": "Electrical parameters of an electrode.", "properties": { "voltage": { "$ref": "#/definitions/RawValueUnit", "description": "Electrode voltage." }, "current": { "$ref": "#/definitions/RawValueUnit", "description": "Current through the electrode." } }, "type": "object" }, "MassRange": { "additionalProperties": false, "description": "Range of mass/charge ratios for mass spectra.", "properties": { "minimum": { "$ref": "#/definitions/RawValueUnit", "description": "Minimum value in a range of mass/charge ratios." }, "maximum": { "$ref": "#/definitions/RawValueUnit", "description": "Maximum value in a range of mass/charge ratios." } }, "type": "object" }, "MassSpecSource": { "additionalProperties": false, "properties": { "type": { "description": "Type of ionization source.", "type": [ "string", "null" ] }, "positive": { "$ref": "#/definitions/Electrode", "description": "Electrical parameters for the positive electrode." }, "negative": { "$ref": "#/definitions/Electrode", "description": "Electrical parameters for the negative electrode." } }, "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "SelectedIon": { "additionalProperties": false, "properties": { "mass_charge_ratio": { "$ref": "#/definitions/RawValueUnit", "description": "The mass to charge ratio associated with a selected ion." } }, "type": "object" } } }
- Validators:
- field full_scan_duration: RawValueUnit#
Duration of time of the full mass scan.
- field source: MassSpecSource#
Ionization source parameters, including source voltage and current.
- Model WavelengthSelection[source]#
Bases:
IdsElementParameters for wavelength selection.
Show JSON schema
{ "description": "Parameters for wavelength selection.", "type": "object", "properties": { "wavelength": { "$ref": "#/definitions/RawValueUnit", "description": "Nominal wavelength of detection." }, "bandwidth": { "$ref": "#/definitions/RawValueUnit", "description": "Spectral bandwidth of detection." }, "filter_wheel": { "description": "Metadata related to a filter wheel.", "type": [ "string", "null" ] } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field bandwidth: RawValueUnit#
Spectral bandwidth of detection.
- field wavelength: RawValueUnit#
Nominal wavelength of detection.
- Model FluorescenceSettings[source]#
Bases:
IdsElementSettings for fluorescence detection.
Show JSON schema
{ "description": "Settings for fluorescence detection.", "type": "object", "properties": { "excitation": { "$ref": "#/definitions/WavelengthSelection", "description": "Wavelength and bandwidth of the excitation light." }, "emission": { "$ref": "#/definitions/WavelengthSelection", "description": "Wavelength and bandwidth of the emission detection." }, "scan": { "$ref": "#/definitions/FluorescenceScan", "description": "Spectral scan detection parameters for emission scan, excitation scan, or both." } }, "additionalProperties": false, "definitions": { "FluorescenceScan": { "additionalProperties": false, "properties": { "mode": { "description": "Mode of the fluorescence scan, e.g. an emission or excitation scan.", "type": "string" }, "excitation_wavelength": { "$ref": "#/definitions/WavelengthRange", "description": "Wavelength range of an excitation spectral scan." }, "emission_wavelength": { "$ref": "#/definitions/WavelengthRange", "description": "Wavelength range of an emission spectral scan." } }, "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "WavelengthRange": { "additionalProperties": false, "properties": { "minimum": { "$ref": "#/definitions/RawValueUnit", "description": "Minimum wavelength in the spectral range." }, "maximum": { "$ref": "#/definitions/RawValueUnit", "description": "Maximum wavelength in the spectral range." }, "step": { "$ref": "#/definitions/RawValueUnit", "description": "Spacing between wavelengths in the spectrum." } }, "type": "object" }, "WavelengthSelection": { "additionalProperties": false, "description": "Parameters for wavelength selection.", "properties": { "wavelength": { "$ref": "#/definitions/RawValueUnit", "description": "Nominal wavelength of detection." }, "bandwidth": { "$ref": "#/definitions/RawValueUnit", "description": "Spectral bandwidth of detection." }, "filter_wheel": { "description": "Metadata related to a filter wheel.", "type": [ "string", "null" ] } }, "type": "object" } } }
- Validators:
- field emission: WavelengthSelection#
Wavelength and bandwidth of the emission detection.
- field excitation: WavelengthSelection#
Wavelength and bandwidth of the excitation light.
- field scan: FluorescenceScan#
Spectral scan detection parameters for emission scan, excitation scan, or both.
- Model ChargedAerosolSettings[source]#
Bases:
IdsElementCharged aerosol detection settings.
Show JSON schema
{ "description": "Charged aerosol detection settings.", "type": "object", "properties": { "corona_needle_voltage": { "$ref": "#/definitions/RawValueUnit", "description": "Voltage applied between the needle and the chamber wall to ionize the charger gas stream. Also called the charger voltage." }, "corona_needle_current": { "$ref": "#/definitions/RawValueUnit", "description": "Current supplied to ionize the charger gas stream. Also called the charger current." }, "evaporator_temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature of the Charged Aerosol Detector evaporator." } }, "additionalProperties": false, "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field corona_needle_current: RawValueUnit#
Current supplied to ionize the charger gas stream. Also called the charger current.
- field corona_needle_voltage: RawValueUnit#
Voltage applied between the needle and the chamber wall to ionize the charger gas stream. Also called the charger voltage.
- field evaporator_temperature: RawValueUnit#
Temperature of the Charged Aerosol Detector evaporator.
- Model ConductivitySettings[source]#
Bases:
IdsElementConductivity detector settings.
Show JSON schema
{ "description": "Conductivity detector settings.", "type": "object", "properties": { "suppressor": { "$ref": "#/definitions/Suppressor", "description": "Ion exchange suppressor parameters." } }, "additionalProperties": false, "definitions": { "EluentIon": { "additionalProperties": false, "properties": { "name": { "description": "Name of the ion being eluted by the suppressor.", "type": [ "string", "null" ] }, "concentration": { "$ref": "#/definitions/RawValueUnit", "description": "Eluent ion concentration." } }, "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "Suppressor": { "additionalProperties": false, "properties": { "name": { "description": "Name of the ion suppressor.", "type": [ "string", "null" ] }, "type": { "description": "Ion suppressor type.", "type": [ "string", "null" ] }, "eluent_ions": { "description": "Ions being eluted by the suppressor.", "items": { "$ref": "#/definitions/EluentIon" }, "type": "array" }, "current": { "$ref": "#/definitions/RawValueUnit", "description": "Current in the suppressor." }, "flow_rate": { "$ref": "#/definitions/RawValueUnit", "description": "Flow rate through the suppressor." } }, "type": "object" } } }
- Validators:
- field suppressor: Suppressor#
Ion exchange suppressor parameters.
- Model FlameIonizationSettings[source]#
Bases:
IdsElementFlame ionization detector parameters.
Show JSON schema
{ "description": "Flame ionization detector parameters.", "type": "object", "properties": { "detector_temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Flame ionization detector temperature." }, "air_flow": { "$ref": "#/definitions/FlowControlQuantity", "description": "Flow of air into the flame ionization detector." }, "makeup_gas_flow": { "$ref": "#/definitions/FlowControlQuantity", "description": "Flow of makeup gas into the flame ionization detector." }, "hydrogen_gas_flow": { "$ref": "#/definitions/FlowControlQuantity", "description": "Flow of hydrogen into the flame ionization detector." } }, "additionalProperties": false, "definitions": { "FlowControlQuantity": { "additionalProperties": false, "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] }, "control": { "description": "Whether the flow is on.", "type": [ "boolean", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field air_flow: FlowControlQuantity#
Flow of air into the flame ionization detector.
- field detector_temperature: RawValueUnit#
Flame ionization detector temperature.
- field hydrogen_gas_flow: FlowControlQuantity#
Flow of hydrogen into the flame ionization detector.
- field makeup_gas_flow: FlowControlQuantity#
Flow of makeup gas into the flame ionization detector.
- Model AnalogDigitalConverterSettings[source]#
Bases:
IdsElementAnalog to digital converter settings.
Show JSON schema
{ "description": "Analog to digital converter settings.", "type": "object", "properties": { "input_multiplier": { "description": "Multiplier for the input voltage.", "type": [ "number", "null" ] }, "input_offset": { "description": "Offset for the input voltage.", "type": [ "number", "null" ] } }, "additionalProperties": false }
- Validators:
- Model DetectorChannel[source]#
Bases:
DetectionMethodDetection method parameters.
Show JSON schema
{ "description": "Detection method parameters.", "type": "object", "properties": { "fk_module": { "@foreign_key": "/properties/modules/items/properties/pk", "type": "string" }, "name": { "description": "Name of the detector.", "type": [ "string", "null" ] }, "description": { "description": "Description of the detector channel.", "type": [ "string", "null" ] }, "data_collection_rate": { "$ref": "#/definitions/RawValueUnit", "description": "Frequency at which data is collected by the detector." }, "gain": { "$ref": "#/definitions/RawValueUnit", "description": "Parameters to adjust the sensitivity of the detector." }, "fk_method": { "@foreign_key": "/properties/methods/items/properties/pk", "type": "string" }, "detector_type": { "description": "The type of detector. Possible values are: UV-vis, Mass spectrometer, Fluorescence, Charged Aerosol, conductivity, Flame ionization, Analog digital converters, and other.", "example_values": [ "UV-vis", "Mass spectrometer", "Fluorescence", "Charged Aerosol", "Conductivity", "Flame ionization", "Analog digital converters", "Other" ], "type": "string" }, "uv_vis": { "$ref": "#/definitions/UvVisSettings" }, "mass_spectrometer": { "$ref": "#/definitions/MassSpectrometerSettings" }, "fluorescence": { "$ref": "#/definitions/FluorescenceSettings" }, "charged_aerosol": { "$ref": "#/definitions/ChargedAerosolSettings" }, "conductivity": { "$ref": "#/definitions/ConductivitySettings" }, "flame_ionization": { "$ref": "#/definitions/FlameIonizationSettings" }, "analog_digital_converters": { "$ref": "#/definitions/AnalogDigitalConverterSettings" } }, "additionalProperties": false, "required": [ "fk_module", "fk_method" ], "definitions": { "AnalogDigitalConverterSettings": { "additionalProperties": false, "description": "Analog to digital converter settings.", "properties": { "input_multiplier": { "description": "Multiplier for the input voltage.", "type": [ "number", "null" ] }, "input_offset": { "description": "Offset for the input voltage.", "type": [ "number", "null" ] } }, "type": "object" }, "ChargedAerosolSettings": { "additionalProperties": false, "description": "Charged aerosol detection settings.", "properties": { "corona_needle_voltage": { "$ref": "#/definitions/RawValueUnit", "description": "Voltage applied between the needle and the chamber wall to ionize the charger gas stream. Also called the charger voltage." }, "corona_needle_current": { "$ref": "#/definitions/RawValueUnit", "description": "Current supplied to ionize the charger gas stream. Also called the charger current." }, "evaporator_temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Temperature of the Charged Aerosol Detector evaporator." } }, "type": "object" }, "ConductivitySettings": { "additionalProperties": false, "description": "Conductivity detector settings.", "properties": { "suppressor": { "$ref": "#/definitions/Suppressor", "description": "Ion exchange suppressor parameters." } }, "type": "object" }, "Electrode": { "additionalProperties": false, "description": "Electrical parameters of an electrode.", "properties": { "voltage": { "$ref": "#/definitions/RawValueUnit", "description": "Electrode voltage." }, "current": { "$ref": "#/definitions/RawValueUnit", "description": "Current through the electrode." } }, "type": "object" }, "EluentIon": { "additionalProperties": false, "properties": { "name": { "description": "Name of the ion being eluted by the suppressor.", "type": [ "string", "null" ] }, "concentration": { "$ref": "#/definitions/RawValueUnit", "description": "Eluent ion concentration." } }, "type": "object" }, "FlameIonizationSettings": { "additionalProperties": false, "description": "Flame ionization detector parameters.", "properties": { "detector_temperature": { "$ref": "#/definitions/RawValueUnit", "description": "Flame ionization detector temperature." }, "air_flow": { "$ref": "#/definitions/FlowControlQuantity", "description": "Flow of air into the flame ionization detector." }, "makeup_gas_flow": { "$ref": "#/definitions/FlowControlQuantity", "description": "Flow of makeup gas into the flame ionization detector." }, "hydrogen_gas_flow": { "$ref": "#/definitions/FlowControlQuantity", "description": "Flow of hydrogen into the flame ionization detector." } }, "type": "object" }, "FlowControlQuantity": { "additionalProperties": false, "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] }, "control": { "description": "Whether the flow is on.", "type": [ "boolean", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "FluorescenceScan": { "additionalProperties": false, "properties": { "mode": { "description": "Mode of the fluorescence scan, e.g. an emission or excitation scan.", "type": "string" }, "excitation_wavelength": { "$ref": "#/definitions/WavelengthRange", "description": "Wavelength range of an excitation spectral scan." }, "emission_wavelength": { "$ref": "#/definitions/WavelengthRange", "description": "Wavelength range of an emission spectral scan." } }, "type": "object" }, "FluorescenceSettings": { "additionalProperties": false, "description": "Settings for fluorescence detection.", "properties": { "excitation": { "$ref": "#/definitions/WavelengthSelection", "description": "Wavelength and bandwidth of the excitation light." }, "emission": { "$ref": "#/definitions/WavelengthSelection", "description": "Wavelength and bandwidth of the emission detection." }, "scan": { "$ref": "#/definitions/FluorescenceScan", "description": "Spectral scan detection parameters for emission scan, excitation scan, or both." } }, "type": "object" }, "MassRange": { "additionalProperties": false, "description": "Range of mass/charge ratios for mass spectra.", "properties": { "minimum": { "$ref": "#/definitions/RawValueUnit", "description": "Minimum value in a range of mass/charge ratios." }, "maximum": { "$ref": "#/definitions/RawValueUnit", "description": "Maximum value in a range of mass/charge ratios." } }, "type": "object" }, "MassSpecSource": { "additionalProperties": false, "properties": { "type": { "description": "Type of ionization source.", "type": [ "string", "null" ] }, "positive": { "$ref": "#/definitions/Electrode", "description": "Electrical parameters for the positive electrode." }, "negative": { "$ref": "#/definitions/Electrode", "description": "Electrical parameters for the negative electrode." } }, "type": "object" }, "MassSpectrometerSettings": { "additionalProperties": false, "description": "Mass spectrometer settings for single spectra instruments, e.g. single\nquadrupole or TOF.", "properties": { "polarity": { "description": "Polarity of generated ions.", "type": [ "string", "null" ] }, "source": { "$ref": "#/definitions/MassSpecSource", "description": "Ionization source parameters, including source voltage and current." }, "mass_range": { "$ref": "#/definitions/MassRange", "description": "Lower and upper cutoffs for m/z values detected." }, "selected_ions": { "description": "List of specific selected ions for detection.", "items": { "$ref": "#/definitions/SelectedIon" }, "type": "array" }, "full_scan_duration": { "$ref": "#/definitions/RawValueUnit", "description": "Duration of time of the full mass scan." } }, "type": "object" }, "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "SelectedIon": { "additionalProperties": false, "properties": { "mass_charge_ratio": { "$ref": "#/definitions/RawValueUnit", "description": "The mass to charge ratio associated with a selected ion." } }, "type": "object" }, "Suppressor": { "additionalProperties": false, "properties": { "name": { "description": "Name of the ion suppressor.", "type": [ "string", "null" ] }, "type": { "description": "Ion suppressor type.", "type": [ "string", "null" ] }, "eluent_ions": { "description": "Ions being eluted by the suppressor.", "items": { "$ref": "#/definitions/EluentIon" }, "type": "array" }, "current": { "$ref": "#/definitions/RawValueUnit", "description": "Current in the suppressor." }, "flow_rate": { "$ref": "#/definitions/RawValueUnit", "description": "Flow rate through the suppressor." } }, "type": "object" }, "UvVisSettings": { "additionalProperties": false, "properties": { "wavelength": { "$ref": "#/definitions/RawValueUnit", "description": "Wavelength at which absorbance is recorded." }, "bandwidth": { "$ref": "#/definitions/RawValueUnit", "description": "Spectral bandwidth of the UV-vis channel." }, "reference_used": { "description": "Whether a reference wavelength is used.", "type": [ "boolean", "null" ] }, "reference_wavelength": { "$ref": "#/definitions/RawValueUnit", "description": "Wavelength at which the reference absorbance is recorded." }, "reference_bandwidth": { "$ref": "#/definitions/RawValueUnit", "description": "Spectral bandwidth of the reference UV-vis channel." }, "wavelength_range": { "$ref": "#/definitions/WavelengthRange", "description": "Wavelength range parameters for a spectral scan." } }, "type": "object" }, "WavelengthRange": { "additionalProperties": false, "properties": { "minimum": { "$ref": "#/definitions/RawValueUnit", "description": "Minimum wavelength in the spectral range." }, "maximum": { "$ref": "#/definitions/RawValueUnit", "description": "Maximum wavelength in the spectral range." }, "step": { "$ref": "#/definitions/RawValueUnit", "description": "Spacing between wavelengths in the spectrum." } }, "type": "object" }, "WavelengthSelection": { "additionalProperties": false, "description": "Parameters for wavelength selection.", "properties": { "wavelength": { "$ref": "#/definitions/RawValueUnit", "description": "Nominal wavelength of detection." }, "bandwidth": { "$ref": "#/definitions/RawValueUnit", "description": "Spectral bandwidth of detection." }, "filter_wheel": { "description": "Metadata related to a filter wheel.", "type": [ "string", "null" ] } }, "type": "object" } } }
- Validators:
- field analog_digital_converters: AnalogDigitalConverterSettings#
- field charged_aerosol: ChargedAerosolSettings#
- field conductivity: ConductivitySettings#
- field detector_type: str#
The type of detector. Possible values are: UV-vis, Mass spectrometer, Fluorescence, Charged Aerosol, conductivity, Flame ionization, Analog digital converters, and other.
- field fk_method: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- field flame_ionization: FlameIonizationSettings#
- field fluorescence: FluorescenceSettings#
- field mass_spectrometer: MassSpectrometerSettings#
- field uv_vis: UvVisSettings#
- Model Solvent[source]#
Bases:
IdsElementSolvent metadata in liquid chromatography or ion exchange chromatography
Show JSON schema
{ "description": "Solvent metadata in liquid chromatography or ion exchange chromatography", "type": "object", "properties": { "name": { "description": "Name of the solvent.", "type": [ "string", "null" ] }, "description": { "description": "Description of the solvent.", "type": [ "string", "null" ] }, "used": { "description": "Whether or not this solvent is used in this method.", "type": [ "boolean", "null" ] } }, "additionalProperties": false }
- Validators:
- Model MobilePhase[source]#
Bases:
IdsElementMobile phase metadata in liquid chromatography or ion exchange chromatography
Show JSON schema
{ "description": "Mobile phase metadata in liquid chromatography or ion exchange chromatography", "type": "object", "properties": { "pk": { "@primary_key": true, "description": "Primary key for mobile phases in the chromatography system.", "type": "string" }, "fk_method": { "@foreign_key": "/properties/methods/items/properties/pk", "type": "string" }, "solvent_a": { "$ref": "#/definitions/Solvent" }, "solvent_b": { "$ref": "#/definitions/Solvent" }, "solvent_c": { "$ref": "#/definitions/Solvent" }, "solvent_d": { "$ref": "#/definitions/Solvent" }, "id": { "description": "ID of the mobile phase.", "type": [ "string", "null" ] }, "name": { "description": "Name assigned to the mobile phase.", "type": [ "string", "null" ] }, "used": { "description": "Whether or not this mobile phase is used in this method.", "type": [ "boolean", "null" ] } }, "additionalProperties": false, "required": [ "pk", "fk_method" ], "definitions": { "Solvent": { "additionalProperties": false, "description": "Solvent metadata in liquid chromatography or ion exchange chromatography", "properties": { "name": { "description": "Name of the solvent.", "type": [ "string", "null" ] }, "description": { "description": "Description of the solvent.", "type": [ "string", "null" ] }, "used": { "description": "Whether or not this solvent is used in this method.", "type": [ "boolean", "null" ] } }, "type": "object" } } }
- Validators:
- field fk_method: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- Model MobilePhaseGradientStep[source]#
Bases:
IdsElementParameters of a mobile phase gradient step. Composition is given in terms of mobile phases labelled A, B, C and D. For example, A and B may be used with a binary pump, and all four may be used with a quaternary pump.
Show JSON schema
{ "description": "Parameters of a mobile phase gradient step.\nComposition is given in terms of mobile phases labelled A, B, C and D.\nFor example, A and B may be used with a binary pump, and all four may be used with a\nquaternary pump.", "type": "object", "properties": { "fk_mobile_phase": { "@foreign_key": "/properties/mobile_phases/items/properties/pk", "type": "string" }, "percent_a": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of A used." }, "percent_b": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of B used." }, "percent_c": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of C used." }, "percent_d": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of D used." }, "percent_a_start": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of A at start of gradient step." }, "percent_b_start": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of B at start of gradient step." }, "percent_c_start": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of C at start of gradient step." }, "percent_d_start": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of D at start of gradient step." }, "percent_a_end": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of A at end of gradient step." }, "percent_b_end": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of B at end of gradient step." }, "percent_c_end": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of C at end of gradient step." }, "percent_d_end": { "$ref": "#/definitions/RawValueUnit", "description": "Percent of D at end of gradient step." }, "flow": { "$ref": "#/definitions/RawValueUnit", "description": "Flow rate for this gradient step." }, "curve": { "description": "A curve identifier for the curve defining this gradient step.", "type": [ "string", "null" ] }, "duration": { "$ref": "#/definitions/RawValueUnit", "description": "Duration of time of this gradient step." }, "retention_time": { "$ref": "#/definitions/RawValueUnit", "description": "The retention time at which this gradient step starts." } }, "additionalProperties": false, "required": [ "fk_mobile_phase" ], "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field duration: RawValueUnit#
Duration of time of this gradient step.
- field fk_mobile_phase: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- field flow: RawValueUnit#
Flow rate for this gradient step.
- field percent_a: RawValueUnit#
Percent of A used.
- field percent_a_end: RawValueUnit#
Percent of A at end of gradient step.
- field percent_a_start: RawValueUnit#
Percent of A at start of gradient step.
- field percent_b: RawValueUnit#
Percent of B used.
- field percent_b_end: RawValueUnit#
Percent of B at end of gradient step.
- field percent_b_start: RawValueUnit#
Percent of B at start of gradient step.
- field percent_c: RawValueUnit#
Percent of C used.
- field percent_c_end: RawValueUnit#
Percent of C at end of gradient step.
- field percent_c_start: RawValueUnit#
Percent of C at start of gradient step.
- field percent_d: RawValueUnit#
Percent of D used.
- field percent_d_end: RawValueUnit#
Percent of D at end of gradient step.
- field percent_d_start: RawValueUnit#
Percent of D at start of gradient step.
- field retention_time: RawValueUnit#
The retention time at which this gradient step starts.
- Model ProcessingBase[source]#
Bases:
IdsElementBasic parameters describing a processing method.
Show JSON schema
{ "description": "Basic parameters describing a processing method.", "type": "object", "properties": { "fk_method": { "@foreign_key": "/properties/methods/items/properties/pk", "type": "string" }, "name": { "description": "Name of the processing method.", "type": [ "string", "null" ] }, "algorithm": { "description": "Identifier or name of the processing algorithm.", "type": [ "string", "null" ] }, "creation": { "$ref": "#/definitions/MethodEvent", "description": "Information about the creation of this processing method." }, "last_update": { "$ref": "#/definitions/MethodEvent", "description": "Information about the last update of this processing method." } }, "additionalProperties": false, "required": [ "fk_method" ], "definitions": { "MethodEvent": { "additionalProperties": false, "description": "Parameters describing when an event took place and who performed it.", "properties": { "computer": { "description": "Identifier of the computer.", "type": [ "string", "null" ] }, "comment": { "description": "Comments provided by user associated with the event.", "type": [ "string", "null" ] }, "time": { "$ref": "#/definitions/TimeWithRaw", "description": "Time that the event took place." }, "user": { "description": "User associated with the event.", "type": [ "string", "null" ] } }, "type": "object" }, "TimeWithRaw": { "additionalProperties": false, "properties": { "value": { "type": [ "string", "null" ] }, "raw_value": { "type": [ "string", "null" ] } }, "type": "object" } } }
- Validators:
- field creation: MethodEvent#
Information about the creation of this processing method.
- field fk_method: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- field last_update: MethodEvent#
Information about the last update of this processing method.
- Model GradientStep[source]#
Bases:
IdsElementParameters describing a gradient control step such as temperature, flow or pressure gradients.
Show JSON schema
{ "description": "Parameters describing a gradient control step such as temperature, flow or pressure\ngradients.", "type": "object", "properties": { "fk_method": { "@foreign_key": "/properties/methods/items/properties/pk", "type": "string" }, "gradient_type": { "description": "The type of gradient step. Possible values are: Temperature, Flow, and Pressure.", "example_values": [ "Temperature", "Flow", "Pressure" ], "type": "string" }, "retention_time": { "$ref": "#/definitions/RawValueUnit", "description": "The retention time at which this gradient step starts." }, "rate": { "$ref": "#/definitions/RawValueUnit", "description": "Rate of the gradient step." }, "start_value": { "$ref": "#/definitions/RawValueUnit", "description": "Start value of the parameter." }, "target_value": { "$ref": "#/definitions/RawValueUnit", "description": "Target value of the parameter." }, "hold_duration": { "$ref": "#/definitions/RawValueUnit", "description": "Duration of time that this parameter is held for after reaching the target." } }, "additionalProperties": false, "required": [ "fk_method" ], "definitions": { "RawValueUnit": { "additionalProperties": false, "description": "A value with a unit, including the raw representation of the value from the primary data.", "properties": { "value": { "description": "A numerical value.", "type": [ "number", "null" ] }, "unit": { "description": "Unit for the numerical value.", "type": [ "string", "null" ] }, "raw_value": { "description": "The raw, untransformed value from the primary data.", "type": [ "string", "null" ] } }, "required": [ "value", "unit", "raw_value" ], "type": "object" } } }
- Validators:
- field fk_method: str#
- Constraints:
func = <function validate_uuid at 0x7f83f18f3550>
json_schema_input_type = PydanticUndefined
ids_field_arg = primary_key
pk_reference_field = @foreign_key
- field gradient_type: str#
The type of gradient step. Possible values are: Temperature, Flow, and Pressure.
- field hold_duration: RawValueUnit#
Duration of time that this parameter is held for after reaching the target.
- field rate: RawValueUnit#
Rate of the gradient step.
- field retention_time: RawValueUnit#
The retention time at which this gradient step starts.
- field start_value: RawValueUnit#
Start value of the parameter.
- field target_value: RawValueUnit#
Target value of the parameter.