ts_ids_components.chromatography.peak module#
This module contains components to model a single peak for a liquid chromatography result.
- Model AreaPercent[source]#
Bases:
RawValueUnitThe area of a chromatographic peak expressed as a percent of the sum of the areas of all integrated peaks in the chromatogram
Show JSON schema
{ "description": "The area of a chromatographic peak expressed as a percent of the\nsum of the areas of all integrated peaks in the chromatogram", "type": "object", "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" ] }, "adjusted": { "$ref": "#/definitions/RawValueUnit", "description": "Percent adjusted area." }, "capillary_electrophoresis": { "$ref": "#/definitions/RawValueUnit", "description": "Capillary electrophoresis (CE) area for the peak as a percentage of the total CE areas." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "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 adjusted: RawValueUnit#
Percent adjusted area.
- field capillary_electrophoresis: RawValueUnit#
Capillary electrophoresis (CE) area for the peak as a percentage of the total CE areas.
- Model Area[source]#
Bases:
RawValueUnitArea values for a peak.
Show JSON schema
{ "description": "Area values for a peak.", "type": "object", "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" ] }, "percent": { "$ref": "#/definitions/AreaPercent" }, "corrected": { "$ref": "#/definitions/RawValueUnit", "description": "The area of a peak divided by its migration time." }, "capillary_electrophoresis": { "$ref": "#/definitions/RawValueUnit", "description": "Capillary electrophoresis (CE) area for the peak, which is defined as area / retention time." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "definitions": { "AreaPercent": { "additionalProperties": false, "description": "The area of a chromatographic peak expressed as a percent of the\nsum of the areas of all integrated peaks in the chromatogram", "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" ] }, "adjusted": { "$ref": "#/definitions/RawValueUnit", "description": "Percent adjusted area." }, "capillary_electrophoresis": { "$ref": "#/definitions/RawValueUnit", "description": "Capillary electrophoresis (CE) area for the peak as a percentage of the total CE areas." } }, "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 capillary_electrophoresis: RawValueUnit#
Capillary electrophoresis (CE) area for the peak, which is defined as area / retention time.
- field corrected: RawValueUnit#
The area of a peak divided by its migration time.
- field percent: AreaPercent#
- Model ProcessingCode[source]#
Bases:
IdsElementA code used to describe the processing of a peak.
Show JSON schema
{ "description": "A code used to describe the processing of a peak.", "type": "object", "properties": { "code": { "description": "The code value defined by the software.", "type": "string" }, "category": { "description": "A category to describe what specific component of a peak this code influences.", "example_values": [ "baseline", "baseline_start", "baseline_end", "unspecified" ], "type": "string" } }, "additionalProperties": false, "required": [ "code" ] }
- Validators:
- Model CalibrationCurve[source]#
Bases:
IdsElementInformation pertaining to the peak’s calibration curve.
Show JSON schema
{ "description": "Information pertaining to the peak's calibration curve.", "type": "object", "properties": { "id": { "description": "Calibration curve identifier associated with the peak.", "type": [ "string", "null" ] }, "mode": { "description": "Determines which calibration standard injections are used as the basis for the calibration of each injection in a sequence.", "type": [ "string", "null" ] }, "entered_x_value": { "$ref": "#/definitions/ValuePair", "description": "Amount, concentration, or custom field, depending on the selection in the processing method." }, "type": { "description": "Describes the mathematical model function (calibration function) that is used to calculate the calibration curve.", "type": [ "string", "null" ] }, "weight": { "description": "Weighting used when calculating the calibration curve. For example, 1/Amount.", "type": [ "string", "null" ] }, "retention": { "$ref": "#/definitions/ValuePair", "description": "Retention time of calibration curve." }, "detection_limit": { "$ref": "#/definitions/ValuePair", "description": "The minimum amount of an analyte that can be detected by a method with a specified level of certainty, given a particular set of calibration data." }, "r": { "$ref": "#/definitions/ValuePair", "description": "Correlation coefficient. The 'linear dependence' between two variables (for example, the peak area and the amount or concentration of an analyte)" }, "r_squared": { "$ref": "#/definitions/ValuePair", "description": "The coefficient of determination, which reflects the deviation of the measured data points from the calibration curve." }, "adjusted_r_squared": { "$ref": "#/definitions/ValuePair", "description": "The coefficient of determination corrected by the degree of freedom" }, "number_of_disabled_calibration_points": { "description": "The number of values that were not considered in the calibration.", "type": [ "integer", "null" ] }, "x_unit": { "description": "Unit of the x-axis of the calibration plot.", "type": [ "string", "null" ] }, "y_unit": { "description": "Unit of the y-axis of the calibration plot.", "type": [ "string", "null" ] }, "injection_volume": { "$ref": "#/definitions/ValuePair", "description": "Injection volume use to generate the calibration curve." }, "rf": { "$ref": "#/definitions/ValuePair", "description": "Calculates the ascending slope of the calibration curve, specified as amount/area value." }, "variance": { "$ref": "#/definitions/ValuePair", "description": "The sum of the average deviation of all area values from the corresponding ideal area value in a calibration." }, "variance_coefficient": { "$ref": "#/definitions/ValuePair", "description": "A type of normalized variance value. The variance coefficient indicates how well the data points correspond to the theoretically assumed course of the curve." }, "standard_deviation": { "$ref": "#/definitions/ValuePair", "description": "Square root of calibration variance." } }, "additionalProperties": false, "definitions": { "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field adjusted_r_squared: ValuePair#
The coefficient of determination corrected by the degree of freedom
- field detection_limit: ValuePair#
The minimum amount of an analyte that can be detected by a method with a specified level of certainty, given a particular set of calibration data.
- field entered_x_value: ValuePair#
Amount, concentration, or custom field, depending on the selection in the processing method.
- field injection_volume: ValuePair#
Injection volume use to generate the calibration curve.
- field mode: str | None#
Determines which calibration standard injections are used as the basis for the calibration of each injection in a sequence.
- field number_of_disabled_calibration_points: int | None#
The number of values that were not considered in the calibration.
- field r: ValuePair#
Correlation coefficient. The ‘linear dependence’ between two variables (for example, the peak area and the amount or concentration of an analyte)
- field r_squared: ValuePair#
The coefficient of determination, which reflects the deviation of the measured data points from the calibration curve.
- field retention: ValuePair#
Retention time of calibration curve.
- field rf: ValuePair#
Calculates the ascending slope of the calibration curve, specified as amount/area value.
- field standard_deviation: ValuePair#
Square root of calibration variance.
- field type_: str | None (alias 'type')#
Describes the mathematical model function (calibration function) that is used to calculate the calibration curve.
- field variance: ValuePair#
The sum of the average deviation of all area values from the corresponding ideal area value in a calibration.
- field variance_coefficient: ValuePair#
A type of normalized variance value. The variance coefficient indicates how well the data points correspond to the theoretically assumed course of the curve.
- Model Amount[source]#
Bases:
RawValueUnitQuantity of a component in a chromatogram.
Show JSON schema
{ "description": "Quantity of a component in a chromatogram.", "type": "object", "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" ] }, "percent": { "$ref": "#/definitions/AmountPercent" }, "from_extinction_coeff": { "description": "True if amount value was calculated using the component's extinction coefficient.", "type": "boolean" }, "deviation": { "$ref": "#/definitions/ValuePair", "description": "Difference between the nominal amount of the component and the actual value." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "definitions": { "AmountPercent": { "additionalProperties": false, "properties": { "total": { "$ref": "#/definitions/RawValueUnit", "description": "Peak amount as a percent of the sum of the amounts of all quantitated peaks in the chromatogram." }, "deviation": { "$ref": "#/definitions/RawValueUnit", "description": "The difference between the calculated and control sample amount or concentration values, expressed as a percentage of the control 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" }, "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field deviation: ValuePair#
Difference between the nominal amount of the component and the actual value.
- field from_extinction_coeff: bool#
True if amount value was calculated using the component’s extinction coefficient.
- field percent: AmountPercent#
- Model Response[source]#
Bases:
RawValueUnitThe peak area, peak height, or a ratio, depending on the Y Value flag and use of an internal standard. Together with amount and concentration, response is the value used to produce a point in the calibration curve and used during quantitation to obtain the amount of concentration of the unknown peak from the calibration curve.
Show JSON schema
{ "description": "The peak area, peak height, or a ratio, depending on the Y Value flag and use of an internal standard.\nTogether with amount and concentration, response is the value used to produce a point in the\ncalibration curve and used during quantitation to obtain the amount of concentration of the\nunknown peak from the calibration curve.", "type": "object", "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" ] }, "relative": { "$ref": "#/definitions/ValuePair", "description": "A parameter that scales the response of a specified component to the response of a component named as a Curve reference." }, "factor": { "$ref": "#/definitions/ValuePair", "description": "Ratio off response to analyte concentration. This value is dependent on the response type chosen." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "definitions": { "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field factor: ValuePair#
Ratio off response to analyte concentration. This value is dependent on the response type chosen.
- field relative: ValuePair#
A parameter that scales the response of a specified component to the response of a component named as a Curve reference.
- Model RelativeRetentionTime[source]#
Bases:
RawValueUnitDifference between the retention time of a component and the retention time of its RT Reference peak
Show JSON schema
{ "description": "Difference between the retention time of a component and the retention time of its RT Reference peak", "type": "object", "properties": { "value": { "description": "Relative retention time value calculated using an unspecified pharmacop(o)eia standard.", "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" ] }, "usp": { "$ref": "#/definitions/RawValueUnit", "description": "Relative retention time calculated using the USP standard." }, "ep": { "$ref": "#/definitions/RawValueUnit", "description": "Relative retention time calculated using the EP standard." }, "jp": { "$ref": "#/definitions/RawValueUnit", "description": "Relative retention time calculated using the JP standard." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "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 ep: RawValueUnit#
Relative retention time calculated using the EP standard.
- field jp: RawValueUnit#
Relative retention time calculated using the JP standard.
- field usp: RawValueUnit#
Relative retention time calculated using the USP standard.
- Model RetentionTime[source]#
Bases:
RawValueUnitThe time that elapses between the injection of a sample and the appearance of the peak maximum (apex) of a component in the sample.
Show JSON schema
{ "description": "The time that elapses between the injection of a sample and the appearance of\nthe peak maximum (apex) of a component in the sample.", "type": "object", "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" ] }, "relative": { "$ref": "#/definitions/RelativeRetentionTime" }, "ratio": { "$ref": "#/definitions/ValuePair", "description": "The retention time of a component divided by the retention time of its reference peak (RT Reference)." }, "centroid": { "$ref": "#/definitions/RawValueUnit", "description": "The centroid time of the peak (i.e. the peak's center of mass)." }, "corrected": { "$ref": "#/definitions/RawValueUnit", "description": "Corrected retention time based off a standard peak's deviation from its expected retention time." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "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" }, "RelativeRetentionTime": { "additionalProperties": false, "description": "Difference between the retention time of a component and the retention time of its RT Reference peak", "properties": { "value": { "description": "Relative retention time value calculated using an unspecified pharmacop(o)eia standard.", "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" ] }, "usp": { "$ref": "#/definitions/RawValueUnit", "description": "Relative retention time calculated using the USP standard." }, "ep": { "$ref": "#/definitions/RawValueUnit", "description": "Relative retention time calculated using the EP standard." }, "jp": { "$ref": "#/definitions/RawValueUnit", "description": "Relative retention time calculated using the JP standard." } }, "required": [ "value", "unit", "raw_value" ], "type": "object" }, "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field centroid: RawValueUnit#
The centroid time of the peak (i.e. the peak’s center of mass).
- field corrected: RawValueUnit#
Corrected retention time based off a standard peak’s deviation from its expected retention time.
- field ratio: ValuePair#
The retention time of a component divided by the retention time of its reference peak (RT Reference).
- field relative: RelativeRetentionTime#
- Model USPResolution[source]#
Bases:
IdsElementResolution values calculated following United States Pharmacopeia standards.
Show JSON schema
{ "description": "Resolution values calculated following United States Pharmacopeia standards.", "type": "object", "properties": { "tangent": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP tangent method." }, "half_height": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP half-height method." }, "five_sigma": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP 5-sigma method." }, "half_width": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP half-width method." }, "statistical": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP statistical method." } }, "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 five_sigma: RawValueUnit#
Resolution calculated using USP 5-sigma method.
- field half_height: RawValueUnit#
Resolution calculated using USP half-height method.
- field half_width: RawValueUnit#
Resolution calculated using USP half-width method.
- field statistical: RawValueUnit#
Resolution calculated using USP statistical method.
- field tangent: RawValueUnit#
Resolution calculated using USP tangent method.
- Model Resolution[source]#
Bases:
RawValueUnitThe extent to which a chromatographic column separates components from each other
Show JSON schema
{ "description": "The extent to which a chromatographic column separates components from each other", "type": "object", "properties": { "value": { "description": "Resolution calculated using an unspecified resolution formula.", "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" ] }, "usp": { "$ref": "#/definitions/USPResolution", "description": "Resolution calculated using the USP standard." }, "ep_jp": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using the EP/JP pharmacopeia standard. This standard is the same for EP and JP." } }, "additionalProperties": false, "required": [ "unit", "raw_value" ], "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" }, "USPResolution": { "additionalProperties": false, "description": "Resolution values calculated following United States Pharmacopeia standards.", "properties": { "tangent": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP tangent method." }, "half_height": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP half-height method." }, "five_sigma": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP 5-sigma method." }, "half_width": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP half-width method." }, "statistical": { "$ref": "#/definitions/RawValueUnit", "description": "Resolution calculated using USP statistical method." } }, "type": "object" } } }
- Validators:
- field ep_jp: RawValueUnit#
Resolution calculated using the EP/JP pharmacopeia standard. This standard is the same for EP and JP.
- field usp: USPResolution#
Resolution calculated using the USP standard.
- Model Width[source]#
Bases:
RawValueUnitA width measurement of a peak.
Show JSON schema
{ "description": "A width measurement of a peak.", "type": "object", "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" ] }, "percent_height": { "description": "Percent height of peak at which width value was calculated.", "type": [ "number", "null" ] }, "span": { "description": "The span of the width. 'Tangent' if the width is measured from peak tangent lines. 'Signal' if the width is measured from the peak's signal values.", "example_values": [ "Tangent", "Signal" ], "type": "string" }, "location": { "description": "The width location along the peak's y-axis. 'Percent Height' if the width is measured at a percent height of the peak. 'Baseline' if the width is measured at the baseline of the peak.", "example_values": [ "Percent Height", "Baseline" ], "type": "string" }, "pharmacopeia": { "description": "Designates which standard the width value conforms to. This flags the width with which standard's formulas may use this width value.", "example_values": [ "United States Pharmacopeia", "European Pharmacopoeia", "Japanese Pharmacopoeia" ], "type": "string" }, "type": { "description": "Describes width distance relative to retention time. Where 'left' marks the width as the distance between peak start and retention time, 'right' as the distance between retention time and peak end, and 'full' when the width crosses the retention time and spans the entire peak.", "example_values": [ "Left", "Right", "Full" ], "type": "string" } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ] }
- Validators:
- field location: str#
The width location along the peak’s y-axis. ‘Percent Height’ if the width is measured at a percent height of the peak. ‘Baseline’ if the width is measured at the baseline of the peak.
- field pharmacopeia: str#
Designates which standard the width value conforms to. This flags the width with which standard’s formulas may use this width value.
- field span: str#
The span of the width. ‘Tangent’ if the width is measured from peak tangent lines. ‘Signal’ if the width is measured from the peak’s signal values.
- field type_: str (alias 'type')#
Describes width distance relative to retention time. Where ‘left’ marks the width as the distance between peak start and retention time, ‘right’ as the distance between retention time and peak end, and ‘full’ when the width crosses the retention time and spans the entire peak.
- Model Concentration[source]#
Bases:
RawValueUnitConcentration of sample.
Show JSON schema
{ "description": "Concentration of sample.", "type": "object", "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" ] }, "from_extinction_coeff": { "description": "True if concentration was calculated using the component's extinction coefficient.", "type": "boolean" } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ] }
- Validators:
- Model FractionTube[source]#
Bases:
IdsElementFraction tubes used during peak elution.
Show JSON schema
{ "description": "Fraction tubes used during peak elution.", "type": "object", "properties": { "end": { "$ref": "#/definitions/RawValueUnit", "description": "Tube label or position collecting eluent at time of peak end." }, "start": { "$ref": "#/definitions/RawValueUnit", "description": "Tube label or position collecting eluent at time of peak start." }, "max": { "$ref": "#/definitions/RawValueUnit", "description": "Tube label or position collecting eluent at time of max peak height." } }, "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 end: RawValueUnit#
Tube label or position collecting eluent at time of peak end.
- field max: RawValueUnit#
Tube label or position collecting eluent at time of max peak height.
- field start: RawValueUnit#
Tube label or position collecting eluent at time of peak start.
- Model StandardDeviation[source]#
Bases:
RawValueUnitStandard deviation for a Gaussian-shaped peak.
Show JSON schema
{ "description": "Standard deviation for a Gaussian-shaped peak.", "type": "object", "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" ] }, "relative": { "$ref": "#/definitions/ValuePair", "description": "The standard deviation as a percentage of the mean of the measured values. A normalized standard deviation that can be used to measure relative error in the calibration." } }, "additionalProperties": false, "required": [ "value", "unit", "raw_value" ], "definitions": { "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field relative: ValuePair#
The standard deviation as a percentage of the mean of the measured values. A normalized standard deviation that can be used to measure relative error in the calibration.
- Model PeakValleyRatio[source]#
Bases:
IdsElementPeak value ratio(s) for a peak.
Show JSON schema
{ "description": "Peak value ratio(s) for a peak.", "type": "object", "properties": { "start": { "$ref": "#/definitions/ValuePair", "description": "Ratio of peak height to valley height at start of peak." }, "end": { "$ref": "#/definitions/ValuePair", "description": "Ratio of peak height to valley height at end of peak." }, "max": { "$ref": "#/definitions/ValuePair", "description": "Peak valley ratio using the smallest valley adjacent to the peak." } }, "additionalProperties": false, "definitions": { "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field end: ValuePair#
Ratio of peak height to valley height at end of peak.
- field max: ValuePair#
Peak valley ratio using the smallest valley adjacent to the peak.
- field start: ValuePair#
Ratio of peak height to valley height at start of peak.
- Model PeakGroup[source]#
Bases:
IdsElementAggregate information pertaining to a group of peaks.
Show JSON schema
{ "description": "Aggregate information pertaining to a group of peaks.", "type": "object", "properties": { "name": { "description": "Name of the peak group.", "type": [ "string", "null" ] }, "amount": { "$ref": "#/definitions/ValuePair", "description": "Sum peak amounts within a group." }, "area": { "$ref": "#/definitions/RawValueUnit", "description": "Sum peak areas within a group." }, "height": { "$ref": "#/definitions/RawValueUnit", "description": "Sum peak heights within a group." } }, "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" }, "ValuePair": { "additionalProperties": false, "properties": { "raw_value": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] } }, "type": "object" } } }
- Validators:
- field amount: ValuePair#
Sum peak amounts within a group.
- field area: RawValueUnit#
Sum peak areas within a group.
- field height: RawValueUnit#
Sum peak heights within a group.