ts_ids_components.particle_sizer.result module

Result components for particle sizer IDSs.

Result bundles the technique-specific result blocks (DLSResult, ELSResult, SLSResult, LaserDiffractionResult) alongside the size distributions (SizeDistribution) that DLS and Laser Diffraction share. A consuming IDS includes only the blocks relevant to the techniques it supports.

class SizeDistributionWeighting(value)

Bases: str, Enum

Statistical weighting of a size distribution. The same physical distribution can be expressed weighted by scattered intensity, by particle volume/mass, or by particle number; the three differ substantially for polydisperse samples, so the weighting must be preserved to interpret the distribution correctly.

class PolydispersityIndexDefinition(value)

Bases: str, Enum

Algorithm used to compute the polydispersity index (PDI). The two definitions are not interchangeable, so the definition must be recorded alongside the value.

• ISO_22412 – µ₂/Γ̄² from the cumulants fit (Zetasizer).

• PERCENT_PD_OVER_100 – (%Pd/100)² (DynaPro).

class ResultAnalysisPass(value)

Bases: str, Enum

Zetasizer-specific analysis pass. The Zetasizer reports two Result entries per measurement, one for each pass. DynaPro and Mastersizer set this to null.

Model SizeDistributionPeak

Bases: IdsElement

A single peak within a size distribution.

Show JSON schema

{
   "description": "A single peak within a size distribution.",
   "type": "object",
   "properties": {
      "mean": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Mean size of the peak."
      },
      "mode": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Modal (most frequent) size of the peak."
      },
      "standard_deviation": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Standard deviation (width) of the peak."
      },
      "area": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Area under the peak."
      },
      "radius": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Radius corresponding to the peak."
      },
      "polydispersity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Polydispersity of the peak."
      },
      "molecular_weight": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Molecular weight estimated for the peak."
      },
      "diffusion_coefficient": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Diffusion coefficient corresponding to the peak."
      },
      "percent_intensity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
      },
      "percent_mass": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
      },
      "percent_number": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
      }
   },
   "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 area: RawValueUnit

Area under the peak.

field diffusion_coefficient: RawValueUnit

Diffusion coefficient corresponding to the peak.

field mean: RawValueUnit

Mean size of the peak.

field mode: RawValueUnit

Modal (most frequent) size of the peak.

field molecular_weight: RawValueUnit

Molecular weight estimated for the peak.

field percent_intensity: RawValueUnit

Contribution of the peak to the intensity-weighted distribution, as a percentage.

field percent_mass: RawValueUnit

Contribution of the peak to the mass/volume-weighted distribution, as a percentage.

field percent_number: RawValueUnit

Contribution of the peak to the number-weighted distribution, as a percentage.

field polydispersity: RawValueUnit

Polydispersity of the peak.

field radius: RawValueUnit

Radius corresponding to the peak.

field standard_deviation: RawValueUnit

Standard deviation (width) of the peak.

Model SizeDistribution

Bases: IdsElement

A size distribution result for a given weighting, summarized by its percentile statistics and constituent peaks.

Show JSON schema

{
   "description": "A size distribution result for a given weighting, summarized by its\npercentile statistics and constituent peaks.",
   "type": "object",
   "properties": {
      "weighting": {
         "description": "Statistical weighting of the distribution.",
         "example_values": [
            "intensity",
            "volume",
            "mass",
            "number"
         ],
         "type": [
            "string",
            "null"
         ]
      },
      "source": {
         "description": "Analysis/source that produced the distribution, e.g. 'cumulants' or 'distribution analysis'.",
         "type": [
            "string",
            "null"
         ]
      },
      "d10": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "10th percentile size: 10% of the distribution lies below this size."
      },
      "d50": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "50th percentile (median) size."
      },
      "d90": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "90th percentile size: 90% of the distribution lies below this size."
      },
      "span": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Distribution width, (d90 - d10) / d50."
      },
      "peaks": {
         "description": "Individual peaks that make up the distribution.",
         "items": {
            "$ref": "#/definitions/SizeDistributionPeak"
         },
         "type": "array"
      }
   },
   "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"
      },
      "SizeDistributionPeak": {
         "additionalProperties": false,
         "description": "A single peak within a size distribution.",
         "properties": {
            "mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Mean size of the peak."
            },
            "mode": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Modal (most frequent) size of the peak."
            },
            "standard_deviation": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Standard deviation (width) of the peak."
            },
            "area": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Area under the peak."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Radius corresponding to the peak."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity of the peak."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated for the peak."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion coefficient corresponding to the peak."
            },
            "percent_intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
            },
            "percent_mass": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
            },
            "percent_number": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field d10: RawValueUnit

10th percentile size: 10% of the distribution lies below this size.

field d50: RawValueUnit

50th percentile (median) size.

field d90: RawValueUnit

90th percentile size: 90% of the distribution lies below this size.

field peaks: List[SizeDistributionPeak]

Individual peaks that make up the distribution.

field source: str | None

Analysis/source that produced the distribution, e.g. ‘cumulants’ or ‘distribution analysis’.

field span: RawValueUnit

Distribution width, (d90 - d10) / d50.

field weighting: str | None

Statistical weighting of the distribution.

Model ZAverage

Bases: IdsElement

Intensity-weighted harmonic mean hydrodynamic size from the cumulants fit. The Zetasizer reports diameter natively; DynaPro reports radius natively.

Show JSON schema

{
   "description": "Intensity-weighted harmonic mean hydrodynamic size from the cumulants\nfit. The Zetasizer reports diameter natively; DynaPro reports radius\nnatively.",
   "type": "object",
   "properties": {
      "diameter": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Z-average hydrodynamic diameter."
      },
      "radius": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Z-average hydrodynamic radius."
      }
   },
   "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 diameter: RawValueUnit

Z-average hydrodynamic diameter.

field radius: RawValueUnit

Z-average hydrodynamic radius.

Model PolydispersityIndex

Bases: IdsElement

Polydispersity index (PDI) from the cumulants fit: <0.1 indicates a monodisperse sample, >0.4 a broad or aggregated one. The computation differs between instruments – always check definition.

Show JSON schema

{
   "description": "Polydispersity index (PDI) from the cumulants fit: <0.1 indicates a\nmonodisperse sample, >0.4 a broad or aggregated one. The computation\ndiffers between instruments -- always check ``definition``.",
   "type": "object",
   "properties": {
      "value": {
         "description": "Numeric PDI value.",
         "type": [
            "number",
            "null"
         ]
      },
      "unit": {
         "description": "Unit of the PDI value (typically dimensionless).",
         "type": [
            "string",
            "null"
         ]
      },
      "definition": {
         "description": "Algorithm used to compute the PDI. The definitions are not interchangeable.",
         "example_values": [
            "iso_22412",
            "percent_pd_over_100"
         ],
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

field definition: str | None

Algorithm used to compute the PDI. The definitions are not interchangeable.

field unit: str | None

Unit of the PDI value (typically dimensionless).

field value: float | None

Numeric PDI value.

Model CumulantFit

Bases: IdsElement

Cumulant analysis fit parameters from the DLS autocorrelation function (ACF). Regularized NNLS deconvolution yields amplitude, decay time, and diffusion coefficient from the fitted ACF decay.

Show JSON schema

{
   "description": "Cumulant analysis fit parameters from the DLS autocorrelation function\n(ACF). Regularized NNLS deconvolution yields amplitude, decay time, and\ndiffusion coefficient from the fitted ACF decay.",
   "type": "object",
   "properties": {
      "amplitude": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Fitted amplitude (intercept) of the ACF."
      },
      "decay_time": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Characteristic decay time of the ACF."
      },
      "diffusion_coefficient": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Translational diffusion coefficient from the fit."
      },
      "radius": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Hydrodynamic radius from the fit."
      },
      "molecular_weight": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Molecular weight estimated from the fit."
      },
      "viscosity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Viscosity used in the fit."
      },
      "q": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Scattering vector magnitude used in the fit."
      },
      "polydispersity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Polydispersity from the fit."
      },
      "polydispersity_index": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Polydispersity index from the fit."
      },
      "polydispersity_percent": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Polydispersity expressed as a percentage."
      },
      "baseline": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Fitted baseline of the ACF."
      },
      "sos_error": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Sum-of-squares error of the fit."
      },
      "lambda": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Regularization parameter used in the deconvolution."
      },
      "sigma": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Standard deviation (width) parameter of the fit."
      },
      "first_cumulant": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "First cumulant (mean decay rate)."
      },
      "second_cumulant": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Second cumulant (variance of the decay rate)."
      },
      "measured_baseline": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Measured (as opposed to fitted) baseline."
      },
      "fit_error": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Overall error metric of the fit."
      },
      "order_of_fit": {
         "description": "Order of the cumulant polynomial fit.",
         "type": [
            "number",
            "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 amplitude: RawValueUnit

Fitted amplitude (intercept) of the ACF.

field baseline: RawValueUnit

Fitted baseline of the ACF.

field decay_time: RawValueUnit

Characteristic decay time of the ACF.

field diffusion_coefficient: RawValueUnit

Translational diffusion coefficient from the fit.

field first_cumulant: RawValueUnit

First cumulant (mean decay rate).

field fit_error: RawValueUnit

Overall error metric of the fit.

field lambda_: RawValueUnit (alias 'lambda')

Regularization parameter used in the deconvolution.

field measured_baseline: RawValueUnit

Measured (as opposed to fitted) baseline.

field molecular_weight: RawValueUnit

Molecular weight estimated from the fit.

field order_of_fit: float | None

Order of the cumulant polynomial fit.

field polydispersity: RawValueUnit

Polydispersity from the fit.

field polydispersity_index: RawValueUnit

Polydispersity index from the fit.

field polydispersity_percent: RawValueUnit

Polydispersity expressed as a percentage.

field q: RawValueUnit

Scattering vector magnitude used in the fit.

field radius: RawValueUnit

Hydrodynamic radius from the fit.

field second_cumulant: RawValueUnit

Second cumulant (variance of the decay rate).

field sigma: RawValueUnit

Standard deviation (width) parameter of the fit.

field sos_error: RawValueUnit

Sum-of-squares error of the fit.

field viscosity: RawValueUnit

Viscosity used in the fit.

Model RegularizedFitPeak

Bases: IdsElement

A single peak from regularized NNLS deconvolution of the DLS ACF.

Show JSON schema

{
   "description": "A single peak from regularized NNLS deconvolution of the DLS ACF.",
   "type": "object",
   "properties": {
      "dist": {
         "description": "Distribution index the peak belongs to.",
         "type": [
            "number",
            "null"
         ]
      },
      "peak_index": {
         "description": "Index of the peak within the distribution.",
         "type": [
            "number",
            "null"
         ]
      },
      "radius": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Hydrodynamic radius of the peak."
      },
      "diffusion_coefficient": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Diffusion coefficient of the peak."
      },
      "molecular_weight": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Molecular weight estimated for the peak."
      },
      "polydispersity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Polydispersity of the peak."
      },
      "first_index": {
         "description": "Index of the first ACF grid point contributing to the peak.",
         "type": [
            "number",
            "null"
         ]
      },
      "number_of_points": {
         "description": "Number of ACF grid points contributing to the peak.",
         "type": [
            "number",
            "null"
         ]
      },
      "decay_time": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Characteristic decay time of the peak."
      },
      "percent_intensity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
      },
      "percent_mass": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
      },
      "percent_number": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
      }
   },
   "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 decay_time: RawValueUnit

Characteristic decay time of the peak.

field diffusion_coefficient: RawValueUnit

Diffusion coefficient of the peak.

field dist: float | None

Distribution index the peak belongs to.

field first_index: float | None

Index of the first ACF grid point contributing to the peak.

field molecular_weight: RawValueUnit

Molecular weight estimated for the peak.

field number_of_points: float | None

Number of ACF grid points contributing to the peak.

field peak_index: float | None

Index of the peak within the distribution.

field percent_intensity: RawValueUnit

Contribution of the peak to the intensity-weighted distribution, as a percentage.

field percent_mass: RawValueUnit

Contribution of the peak to the mass/volume-weighted distribution, as a percentage.

field percent_number: RawValueUnit

Contribution of the peak to the number-weighted distribution, as a percentage.

field polydispersity: RawValueUnit

Polydispersity of the peak.

field radius: RawValueUnit

Hydrodynamic radius of the peak.

Model DLSAcquisition

Bases: IdsElement

A single DLS acquisition within a measurement, with its own fit results.

Show JSON schema

{
   "description": "A single DLS acquisition within a measurement, with its own fit results.",
   "type": "object",
   "properties": {
      "index": {
         "description": "Index of the acquisition within the measurement.",
         "type": [
            "number",
            "null"
         ]
      },
      "cumulant_fit": {
         "$ref": "#/definitions/CumulantFit",
         "description": "Cumulant fit for this acquisition."
      },
      "regularized_fit_peaks": {
         "description": "Peaks from the regularized fit of this acquisition.",
         "items": {
            "$ref": "#/definitions/RegularizedFitPeak"
         },
         "type": "array"
      }
   },
   "additionalProperties": false,
   "definitions": {
      "CumulantFit": {
         "additionalProperties": false,
         "description": "Cumulant analysis fit parameters from the DLS autocorrelation function\n(ACF). Regularized NNLS deconvolution yields amplitude, decay time, and\ndiffusion coefficient from the fitted ACF decay.",
         "properties": {
            "amplitude": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fitted amplitude (intercept) of the ACF."
            },
            "decay_time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Characteristic decay time of the ACF."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Translational diffusion coefficient from the fit."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Hydrodynamic radius from the fit."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated from the fit."
            },
            "viscosity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Viscosity used in the fit."
            },
            "q": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Scattering vector magnitude used in the fit."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity from the fit."
            },
            "polydispersity_index": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity index from the fit."
            },
            "polydispersity_percent": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity expressed as a percentage."
            },
            "baseline": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fitted baseline of the ACF."
            },
            "sos_error": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Sum-of-squares error of the fit."
            },
            "lambda": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Regularization parameter used in the deconvolution."
            },
            "sigma": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Standard deviation (width) parameter of the fit."
            },
            "first_cumulant": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "First cumulant (mean decay rate)."
            },
            "second_cumulant": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Second cumulant (variance of the decay rate)."
            },
            "measured_baseline": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Measured (as opposed to fitted) baseline."
            },
            "fit_error": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Overall error metric of the fit."
            },
            "order_of_fit": {
               "description": "Order of the cumulant polynomial fit.",
               "type": [
                  "number",
                  "null"
               ]
            }
         },
         "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"
      },
      "RegularizedFitPeak": {
         "additionalProperties": false,
         "description": "A single peak from regularized NNLS deconvolution of the DLS ACF.",
         "properties": {
            "dist": {
               "description": "Distribution index the peak belongs to.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "peak_index": {
               "description": "Index of the peak within the distribution.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Hydrodynamic radius of the peak."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion coefficient of the peak."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated for the peak."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity of the peak."
            },
            "first_index": {
               "description": "Index of the first ACF grid point contributing to the peak.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "number_of_points": {
               "description": "Number of ACF grid points contributing to the peak.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "decay_time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Characteristic decay time of the peak."
            },
            "percent_intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
            },
            "percent_mass": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
            },
            "percent_number": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field cumulant_fit: CumulantFit

Cumulant fit for this acquisition.

field index: float | None

Index of the acquisition within the measurement.

field regularized_fit_peaks: List[RegularizedFitPeak]

Peaks from the regularized fit of this acquisition.

Model InstrumentReading

Bases: IdsElement

Average instrument reading over all acquisitions in a measurement.

Show JSON schema

{
   "description": "Average instrument reading over all acquisitions in a measurement.",
   "type": "object",
   "properties": {
      "intensity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Average scattered light intensity."
      },
      "temperature": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Average measured temperature."
      },
      "time": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Average acquisition time."
      }
   },
   "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 intensity: RawValueUnit

Average scattered light intensity.

field temperature: RawValueUnit

Average measured temperature.

field time: RawValueUnit

Average acquisition time.

Model DerivedAnalysis

Bases: IdsElement

Derived concentration-dependent analysis from DLS (DynaPro SLS companion), computed across a concentration series.

Show JSON schema

{
   "description": "Derived concentration-dependent analysis from DLS (DynaPro SLS\ncompanion), computed across a concentration series.",
   "type": "object",
   "properties": {
      "kd": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Diffusion interaction parameter (k_D) from the concentration series."
      },
      "a2": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Second virial coefficient (A2) from the concentration series."
      },
      "tagg": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Aggregation onset temperature (T_agg), when a thermal ramp is run."
      }
   },
   "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 a2: RawValueUnit

Second virial coefficient (A2) from the concentration series.

field kd: RawValueUnit

Diffusion interaction parameter (k_D) from the concentration series.

field tagg: RawValueUnit

Aggregation onset temperature (T_agg), when a thermal ramp is run.

Model DLSResult

Bases: IdsElement

Dynamic Light Scattering (DLS) specific results.

Show JSON schema

{
   "description": "Dynamic Light Scattering (DLS) specific results.",
   "type": "object",
   "properties": {
      "z_average": {
         "$ref": "#/definitions/ZAverage",
         "description": "Intensity-weighted harmonic mean hydrodynamic size from the cumulants fit. Zetasizer reports diameter natively; DynaPro reports radius natively."
      },
      "polydispersity_index": {
         "$ref": "#/definitions/PolydispersityIndex",
         "description": "PDI from the cumulants fit. <0.1 monodisperse, >0.4 broad/aggregated. Definition differs between instruments -- check the ``definition`` field."
      },
      "diffusion_coefficient": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Translational diffusion coefficient from the cumulants fit."
      },
      "intercept": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "ACF y-intercept at tau=0. Data quality indicator; ideal = 1.0."
      },
      "mean_count_rate": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Photon count rate in kcps. Signal strength indicator."
      },
      "derived_mean_count_rate": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Derived (attenuation-corrected) mean count rate."
      },
      "in_range": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Fraction of the signal within the configured size range."
      },
      "quality_indicator": {
         "description": "Overall data-quality verdict reported by the instrument, e.g. 'good' or a warning message.",
         "type": [
            "string",
            "null"
         ]
      },
      "number_of_runs": {
         "description": "Number of sub-runs/acquisitions averaged into this result.",
         "type": [
            "number",
            "null"
         ]
      },
      "run_retention": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Fraction of sub-runs retained after quality filtering."
      },
      "particle_concentration": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Estimated particle concentration."
      },
      "cumulant_fit": {
         "$ref": "#/definitions/CumulantFit",
         "description": "Cumulant fit for the averaged measurement."
      },
      "regularized_fit_peaks": {
         "description": "Peaks from the regularized fit of the averaged measurement.",
         "items": {
            "$ref": "#/definitions/RegularizedFitPeak"
         },
         "type": "array"
      },
      "acquisitions": {
         "description": "Per-acquisition results within the measurement.",
         "items": {
            "$ref": "#/definitions/DLSAcquisition"
         },
         "type": "array"
      },
      "average_instrument_reading": {
         "$ref": "#/definitions/InstrumentReading",
         "description": "Average instrument reading over all acquisitions."
      },
      "derived": {
         "$ref": "#/definitions/DerivedAnalysis",
         "description": "Derived concentration-dependent analysis (DynaPro SLS companion)."
      }
   },
   "additionalProperties": false,
   "definitions": {
      "CumulantFit": {
         "additionalProperties": false,
         "description": "Cumulant analysis fit parameters from the DLS autocorrelation function\n(ACF). Regularized NNLS deconvolution yields amplitude, decay time, and\ndiffusion coefficient from the fitted ACF decay.",
         "properties": {
            "amplitude": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fitted amplitude (intercept) of the ACF."
            },
            "decay_time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Characteristic decay time of the ACF."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Translational diffusion coefficient from the fit."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Hydrodynamic radius from the fit."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated from the fit."
            },
            "viscosity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Viscosity used in the fit."
            },
            "q": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Scattering vector magnitude used in the fit."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity from the fit."
            },
            "polydispersity_index": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity index from the fit."
            },
            "polydispersity_percent": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity expressed as a percentage."
            },
            "baseline": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fitted baseline of the ACF."
            },
            "sos_error": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Sum-of-squares error of the fit."
            },
            "lambda": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Regularization parameter used in the deconvolution."
            },
            "sigma": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Standard deviation (width) parameter of the fit."
            },
            "first_cumulant": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "First cumulant (mean decay rate)."
            },
            "second_cumulant": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Second cumulant (variance of the decay rate)."
            },
            "measured_baseline": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Measured (as opposed to fitted) baseline."
            },
            "fit_error": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Overall error metric of the fit."
            },
            "order_of_fit": {
               "description": "Order of the cumulant polynomial fit.",
               "type": [
                  "number",
                  "null"
               ]
            }
         },
         "type": "object"
      },
      "DLSAcquisition": {
         "additionalProperties": false,
         "description": "A single DLS acquisition within a measurement, with its own fit results.",
         "properties": {
            "index": {
               "description": "Index of the acquisition within the measurement.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "cumulant_fit": {
               "$ref": "#/definitions/CumulantFit",
               "description": "Cumulant fit for this acquisition."
            },
            "regularized_fit_peaks": {
               "description": "Peaks from the regularized fit of this acquisition.",
               "items": {
                  "$ref": "#/definitions/RegularizedFitPeak"
               },
               "type": "array"
            }
         },
         "type": "object"
      },
      "DerivedAnalysis": {
         "additionalProperties": false,
         "description": "Derived concentration-dependent analysis from DLS (DynaPro SLS\ncompanion), computed across a concentration series.",
         "properties": {
            "kd": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion interaction parameter (k_D) from the concentration series."
            },
            "a2": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Second virial coefficient (A2) from the concentration series."
            },
            "tagg": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Aggregation onset temperature (T_agg), when a thermal ramp is run."
            }
         },
         "type": "object"
      },
      "InstrumentReading": {
         "additionalProperties": false,
         "description": "Average instrument reading over all acquisitions in a measurement.",
         "properties": {
            "intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Average scattered light intensity."
            },
            "temperature": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Average measured temperature."
            },
            "time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Average acquisition time."
            }
         },
         "type": "object"
      },
      "PolydispersityIndex": {
         "additionalProperties": false,
         "description": "Polydispersity index (PDI) from the cumulants fit: <0.1 indicates a\nmonodisperse sample, >0.4 a broad or aggregated one. The computation\ndiffers between instruments -- always check ``definition``.",
         "properties": {
            "value": {
               "description": "Numeric PDI value.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit of the PDI value (typically dimensionless).",
               "type": [
                  "string",
                  "null"
               ]
            },
            "definition": {
               "description": "Algorithm used to compute the PDI. The definitions are not interchangeable.",
               "example_values": [
                  "iso_22412",
                  "percent_pd_over_100"
               ],
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "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"
      },
      "RegularizedFitPeak": {
         "additionalProperties": false,
         "description": "A single peak from regularized NNLS deconvolution of the DLS ACF.",
         "properties": {
            "dist": {
               "description": "Distribution index the peak belongs to.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "peak_index": {
               "description": "Index of the peak within the distribution.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Hydrodynamic radius of the peak."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion coefficient of the peak."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated for the peak."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity of the peak."
            },
            "first_index": {
               "description": "Index of the first ACF grid point contributing to the peak.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "number_of_points": {
               "description": "Number of ACF grid points contributing to the peak.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "decay_time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Characteristic decay time of the peak."
            },
            "percent_intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
            },
            "percent_mass": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
            },
            "percent_number": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
            }
         },
         "type": "object"
      },
      "ZAverage": {
         "additionalProperties": false,
         "description": "Intensity-weighted harmonic mean hydrodynamic size from the cumulants\nfit. The Zetasizer reports diameter natively; DynaPro reports radius\nnatively.",
         "properties": {
            "diameter": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Z-average hydrodynamic diameter."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Z-average hydrodynamic radius."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field acquisitions: List[DLSAcquisition]

Per-acquisition results within the measurement.

field average_instrument_reading: InstrumentReading

Average instrument reading over all acquisitions.

field cumulant_fit: CumulantFit

Cumulant fit for the averaged measurement.

field derived: DerivedAnalysis

Derived concentration-dependent analysis (DynaPro SLS companion).

field derived_mean_count_rate: RawValueUnit

Derived (attenuation-corrected) mean count rate.

field diffusion_coefficient: RawValueUnit

Translational diffusion coefficient from the cumulants fit.

field in_range: RawValueUnit

Fraction of the signal within the configured size range.

field intercept: RawValueUnit

ACF y-intercept at tau=0. Data quality indicator; ideal = 1.0.

field mean_count_rate: RawValueUnit

Photon count rate in kcps. Signal strength indicator.

field number_of_runs: float | None

Number of sub-runs/acquisitions averaged into this result.

field particle_concentration: RawValueUnit

Estimated particle concentration.

field polydispersity_index: PolydispersityIndex

PDI from the cumulants fit. <0.1 monodisperse, >0.4 broad/aggregated. Definition differs between instruments – check the definition field.

field quality_indicator: str | None

Overall data-quality verdict reported by the instrument, e.g. ‘good’ or a warning message.

field regularized_fit_peaks: List[RegularizedFitPeak]

Peaks from the regularized fit of the averaged measurement.

field run_retention: RawValueUnit

Fraction of sub-runs retained after quality filtering.

field z_average: ZAverage

Intensity-weighted harmonic mean hydrodynamic size from the cumulants fit. Zetasizer reports diameter natively; DynaPro reports radius natively.

Model ZetaDistributionPeak

Bases: IdsElement

A single peak in a zeta potential distribution.

Show JSON schema

{
   "description": "A single peak in a zeta potential distribution.",
   "type": "object",
   "properties": {
      "mean": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Mean zeta potential of the peak."
      },
      "area": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Area (relative contribution) of the peak."
      }
   },
   "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 area: RawValueUnit

Area (relative contribution) of the peak.

field mean: RawValueUnit

Mean zeta potential of the peak.

Model ZetaDistribution

Bases: IdsElement

Zeta potential distribution, expressed as a set of peaks.

Show JSON schema

{
   "description": "Zeta potential distribution, expressed as a set of peaks.",
   "type": "object",
   "properties": {
      "peaks": {
         "description": "Peaks that make up the zeta potential distribution.",
         "items": {
            "$ref": "#/definitions/ZetaDistributionPeak"
         },
         "type": "array"
      }
   },
   "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"
      },
      "ZetaDistributionPeak": {
         "additionalProperties": false,
         "description": "A single peak in a zeta potential distribution.",
         "properties": {
            "mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Mean zeta potential of the peak."
            },
            "area": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Area (relative contribution) of the peak."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field peaks: List[ZetaDistributionPeak]

Peaks that make up the zeta potential distribution.

Model ELSResult

Bases: IdsElement

Electrophoretic Light Scattering (ELS) / zeta potential results.

Show JSON schema

{
   "description": "Electrophoretic Light Scattering (ELS) / zeta potential results.",
   "type": "object",
   "properties": {
      "potential": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Zeta potential."
      },
      "zeta_deviation": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Standard deviation (width) of the zeta potential distribution."
      },
      "mobility": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Electrophoretic mobility."
      },
      "model": {
         "description": "Model used to convert mobility to zeta potential, e.g. 'Smoluchowski' or 'Huckel'.",
         "type": [
            "string",
            "null"
         ]
      },
      "conductivity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Conductivity of the dispersant."
      },
      "mean_count_rate": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Photon count rate in kcps during the ELS measurement."
      },
      "quality_factor": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Data quality factor reported for the measurement."
      },
      "effective_voltage": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Effective voltage applied across the cell."
      },
      "measured_voltage": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Measured voltage across the cell."
      },
      "measured_current": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Measured current through the cell."
      },
      "distribution": {
         "$ref": "#/definitions/ZetaDistribution",
         "description": "Zeta potential distribution."
      }
   },
   "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"
      },
      "ZetaDistribution": {
         "additionalProperties": false,
         "description": "Zeta potential distribution, expressed as a set of peaks.",
         "properties": {
            "peaks": {
               "description": "Peaks that make up the zeta potential distribution.",
               "items": {
                  "$ref": "#/definitions/ZetaDistributionPeak"
               },
               "type": "array"
            }
         },
         "type": "object"
      },
      "ZetaDistributionPeak": {
         "additionalProperties": false,
         "description": "A single peak in a zeta potential distribution.",
         "properties": {
            "mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Mean zeta potential of the peak."
            },
            "area": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Area (relative contribution) of the peak."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field conductivity: RawValueUnit

Conductivity of the dispersant.

field distribution: ZetaDistribution

Zeta potential distribution.

field effective_voltage: RawValueUnit

Effective voltage applied across the cell.

field mean_count_rate: RawValueUnit

Photon count rate in kcps during the ELS measurement.

field measured_current: RawValueUnit

Measured current through the cell.

field measured_voltage: RawValueUnit

Measured voltage across the cell.

field mobility: RawValueUnit

Electrophoretic mobility.

field model: str | None

Model used to convert mobility to zeta potential, e.g. ‘Smoluchowski’ or ‘Huckel’.

field potential: RawValueUnit

Zeta potential.

field quality_factor: RawValueUnit

Data quality factor reported for the measurement.

field zeta_deviation: RawValueUnit

Standard deviation (width) of the zeta potential distribution.

Model SLSResult

Bases: IdsElement

Static Light Scattering (SLS) results (DynaPro only, simultaneous with DLS).

Show JSON schema

{
   "description": "Static Light Scattering (SLS) results (DynaPro only, simultaneous with DLS).",
   "type": "object",
   "properties": {
      "molar_mass": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Molar mass from the static scattering intensity."
      },
      "particle_concentration": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Particle concentration used in the SLS calculation."
      },
      "error": {
         "description": "Error/warning message for the SLS calculation, when present.",
         "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 error: str | None

Error/warning message for the SLS calculation, when present.

field molar_mass: RawValueUnit

Molar mass from the static scattering intensity.

field particle_concentration: RawValueUnit

Particle concentration used in the SLS calculation.

Model AdditionalStatistic

Bases: IdsElement

An additional Dxx percentile beyond the standard D10/D50/D90.

Show JSON schema

{
   "description": "An additional Dxx percentile beyond the standard D10/D50/D90.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Name of the percentile, e.g. 'D[v,0.25]'.",
         "type": [
            "string",
            "null"
         ]
      },
      "value": {
         "description": "Numeric value of the percentile.",
         "type": [
            "number",
            "null"
         ]
      },
      "unit": {
         "description": "Unit of the value, e.g. 'Micrometer'.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

field name: str | None

Name of the percentile, e.g. ‘D[v,0.25]’.

field unit: str | None

Unit of the value, e.g. ‘Micrometer’.

field value: float | None

Numeric value of the percentile.

Model LaserDiffractionResult

Bases: IdsElement

Laser Diffraction specific results.

Show JSON schema

{
   "description": "Laser Diffraction specific results.",
   "type": "object",
   "properties": {
      "d10": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "10th percentile size: 10% of the volume distribution lies below this size."
      },
      "d50": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "50th percentile (median) size."
      },
      "d90": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "90th percentile size: 90% of the volume distribution lies below this size."
      },
      "span": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Distribution width, (d90 - d10) / d50."
      },
      "volume_weighted_mean": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "D[4,3] - volume-weighted mean diameter."
      },
      "surface_weighted_mean": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "D[3,2] - surface-weighted mean diameter (Sauter mean)."
      },
      "obscuration": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Obscuration (fraction of light attenuated) during the measurement."
      },
      "concentration": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Sample concentration in the measurement zone."
      },
      "weighted_residual": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Weighted residual of the model fit to the diffraction pattern; a goodness-of-fit indicator."
      },
      "uniformity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Uniformity of the size distribution."
      },
      "specific_surface_area": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Specific surface area computed from the volume distribution."
      },
      "additional_statistics": {
         "description": "Additional Dxx percentiles beyond D10/D50/D90.",
         "items": {
            "$ref": "#/definitions/AdditionalStatistic"
         },
         "type": "array"
      }
   },
   "additionalProperties": false,
   "definitions": {
      "AdditionalStatistic": {
         "additionalProperties": false,
         "description": "An additional Dxx percentile beyond the standard D10/D50/D90.",
         "properties": {
            "name": {
               "description": "Name of the percentile, e.g. 'D[v,0.25]'.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "value": {
               "description": "Numeric value of the percentile.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit of the value, e.g. 'Micrometer'.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "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 additional_statistics: List[AdditionalStatistic]

Additional Dxx percentiles beyond D10/D50/D90.

field concentration: RawValueUnit

Sample concentration in the measurement zone.

field d10: RawValueUnit

10th percentile size: 10% of the volume distribution lies below this size.

field d50: RawValueUnit

50th percentile (median) size.

field d90: RawValueUnit

90th percentile size: 90% of the volume distribution lies below this size.

field obscuration: RawValueUnit

Obscuration (fraction of light attenuated) during the measurement.

field span: RawValueUnit

Distribution width, (d90 - d10) / d50.

field specific_surface_area: RawValueUnit

Specific surface area computed from the volume distribution.

field surface_weighted_mean: RawValueUnit

D[3,2] - surface-weighted mean diameter (Sauter mean).

field uniformity: RawValueUnit

Uniformity of the size distribution.

field volume_weighted_mean: RawValueUnit

D[4,3] - volume-weighted mean diameter.

field weighted_residual: RawValueUnit

Weighted residual of the model fit to the diffraction pattern; a goodness-of-fit indicator.

Model Result

Bases: IdsElement

A measurement result: the fields common to every technique (size distributions plus the foreign keys linking it back to its run, method, sample, and originating curve).

The technique-specific result blocks are not included here. As with Method, a vendor-specific IDS composes only the blocks its instrument produces by inheriting from this base plus the relevant nested mixin classes – e.g. class MyResult(Result, Result.DynamicLightScattering, Result.ElectrophoreticLightScattering) for a DLS/ELS instrument.

Show JSON schema

{
   "description": "A measurement result: the fields common to every technique (size\ndistributions plus the foreign keys linking it back to its run, method,\nsample, and originating curve).\n\nThe technique-specific result blocks are *not* included here. As with\n:py:class:`Method <ts_ids_components.particle_sizer.method.Method>`, a\nvendor-specific IDS composes only the blocks its instrument produces by\ninheriting from this base plus the relevant nested mixin classes -- e.g.\n``class MyResult(Result, Result.DynamicLightScattering, Result.ElectrophoreticLightScattering)``\nfor a DLS/ELS instrument.",
   "type": "object",
   "properties": {
      "pk": {
         "@primary_key": true,
         "description": "Primary key for this result.",
         "type": "string"
      },
      "analysis_pass": {
         "description": "Zetasizer-specific analysis pass. Two ``Result`` entries per measurement (one per pass). DynaPro and Mastersizer set null.",
         "example_values": [
            "filtered",
            "unfiltered"
         ],
         "type": [
            "string",
            "null"
         ]
      },
      "size_distributions": {
         "description": "Size distributions for this result, one per weighting (shared across DLS and Laser Diffraction).",
         "items": {
            "$ref": "#/definitions/SizeDistribution"
         },
         "type": "array"
      },
      "fk_run": {
         "@foreign_key": "/properties/runs/items/properties/pk",
         "description": "Foreign key to the run that produced this result.",
         "type": "string"
      },
      "fk_method": {
         "@foreign_key": "/properties/methods/items/properties/pk",
         "description": "Foreign key to the method used for this result.",
         "type": "string"
      },
      "fk_sample": {
         "@foreign_key": "/properties/samples/items/properties/pk",
         "description": "Foreign key to the sample. Essential for plate-reader instruments where one run produces results for many samples.",
         "type": "string"
      },
      "fk_curve": {
         "@foreign_key": "/properties/curves/items/properties/pk",
         "description": "Foreign key to the raw curve (in the ``curves`` array) this result was derived from. See :py:class:`CurveFile <ts_ids_components.particle_sizer.curve.CurveFile>`. When a result has no corresponding curve, point this at a placeholder curve entry so the foreign key is always satisfied.",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "pk",
      "fk_run",
      "fk_method",
      "fk_sample",
      "fk_curve"
   ],
   "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"
      },
      "SizeDistribution": {
         "additionalProperties": false,
         "description": "A size distribution result for a given weighting, summarized by its\npercentile statistics and constituent peaks.",
         "properties": {
            "weighting": {
               "description": "Statistical weighting of the distribution.",
               "example_values": [
                  "intensity",
                  "volume",
                  "mass",
                  "number"
               ],
               "type": [
                  "string",
                  "null"
               ]
            },
            "source": {
               "description": "Analysis/source that produced the distribution, e.g. 'cumulants' or 'distribution analysis'.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "d10": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "10th percentile size: 10% of the distribution lies below this size."
            },
            "d50": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "50th percentile (median) size."
            },
            "d90": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "90th percentile size: 90% of the distribution lies below this size."
            },
            "span": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Distribution width, (d90 - d10) / d50."
            },
            "peaks": {
               "description": "Individual peaks that make up the distribution.",
               "items": {
                  "$ref": "#/definitions/SizeDistributionPeak"
               },
               "type": "array"
            }
         },
         "type": "object"
      },
      "SizeDistributionPeak": {
         "additionalProperties": false,
         "description": "A single peak within a size distribution.",
         "properties": {
            "mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Mean size of the peak."
            },
            "mode": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Modal (most frequent) size of the peak."
            },
            "standard_deviation": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Standard deviation (width) of the peak."
            },
            "area": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Area under the peak."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Radius corresponding to the peak."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity of the peak."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated for the peak."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion coefficient corresponding to the peak."
            },
            "percent_intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
            },
            "percent_mass": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
            },
            "percent_number": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field analysis_pass: str | None

Zetasizer-specific analysis pass. Two Result entries per measurement (one per pass). DynaPro and Mastersizer set null.

field fk_curve: str

Foreign key to the raw curve (in the curves array) this result was derived from. See CurveFile. When a result has no corresponding curve, point this at a placeholder curve entry so the foreign key is always satisfied.

Constraints:

• func = <function validate_uuid at 0x7f1493ac61f0>

• json_schema_input_type = PydanticUndefined

• ids_field_arg = primary_key

• pk_reference_field = @foreign_key

field fk_method: str

Foreign key to the method used for this result.

Constraints:

• func = <function validate_uuid at 0x7f1493ac61f0>

• json_schema_input_type = PydanticUndefined

• ids_field_arg = primary_key

• pk_reference_field = @foreign_key

field fk_run: str

Foreign key to the run that produced this result.

Constraints:

• func = <function validate_uuid at 0x7f1493ac61f0>

• json_schema_input_type = PydanticUndefined

• ids_field_arg = primary_key

• pk_reference_field = @foreign_key

field fk_sample: str

Foreign key to the sample. Essential for plate-reader instruments where one run produces results for many samples.

Constraints:

• func = <function validate_uuid at 0x7f1493ac61f0>

• json_schema_input_type = PydanticUndefined

• ids_field_arg = primary_key

• pk_reference_field = @foreign_key

field pk: str

Primary key for this result.

Constraints:

• func = <function validate_uuid at 0x7f1493ac61f0>

• json_schema_input_type = PydanticUndefined

field size_distributions: List[SizeDistribution]

Size distributions for this result, one per weighting (shared across DLS and Laser Diffraction).

Model DynamicLightScattering

Bases: IdsElement

Adds the Dynamic Light Scattering result block.

Show JSON schema

{
   "description": "Adds the Dynamic Light Scattering result block.",
   "type": "object",
   "properties": {
      "dynamic_light_scattering": {
         "$ref": "#/definitions/DLSResult",
         "description": "Dynamic Light Scattering results."
      }
   },
   "additionalProperties": false,
   "definitions": {
      "CumulantFit": {
         "additionalProperties": false,
         "description": "Cumulant analysis fit parameters from the DLS autocorrelation function\n(ACF). Regularized NNLS deconvolution yields amplitude, decay time, and\ndiffusion coefficient from the fitted ACF decay.",
         "properties": {
            "amplitude": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fitted amplitude (intercept) of the ACF."
            },
            "decay_time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Characteristic decay time of the ACF."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Translational diffusion coefficient from the fit."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Hydrodynamic radius from the fit."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated from the fit."
            },
            "viscosity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Viscosity used in the fit."
            },
            "q": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Scattering vector magnitude used in the fit."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity from the fit."
            },
            "polydispersity_index": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity index from the fit."
            },
            "polydispersity_percent": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity expressed as a percentage."
            },
            "baseline": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fitted baseline of the ACF."
            },
            "sos_error": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Sum-of-squares error of the fit."
            },
            "lambda": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Regularization parameter used in the deconvolution."
            },
            "sigma": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Standard deviation (width) parameter of the fit."
            },
            "first_cumulant": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "First cumulant (mean decay rate)."
            },
            "second_cumulant": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Second cumulant (variance of the decay rate)."
            },
            "measured_baseline": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Measured (as opposed to fitted) baseline."
            },
            "fit_error": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Overall error metric of the fit."
            },
            "order_of_fit": {
               "description": "Order of the cumulant polynomial fit.",
               "type": [
                  "number",
                  "null"
               ]
            }
         },
         "type": "object"
      },
      "DLSAcquisition": {
         "additionalProperties": false,
         "description": "A single DLS acquisition within a measurement, with its own fit results.",
         "properties": {
            "index": {
               "description": "Index of the acquisition within the measurement.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "cumulant_fit": {
               "$ref": "#/definitions/CumulantFit",
               "description": "Cumulant fit for this acquisition."
            },
            "regularized_fit_peaks": {
               "description": "Peaks from the regularized fit of this acquisition.",
               "items": {
                  "$ref": "#/definitions/RegularizedFitPeak"
               },
               "type": "array"
            }
         },
         "type": "object"
      },
      "DLSResult": {
         "additionalProperties": false,
         "description": "Dynamic Light Scattering (DLS) specific results.",
         "properties": {
            "z_average": {
               "$ref": "#/definitions/ZAverage",
               "description": "Intensity-weighted harmonic mean hydrodynamic size from the cumulants fit. Zetasizer reports diameter natively; DynaPro reports radius natively."
            },
            "polydispersity_index": {
               "$ref": "#/definitions/PolydispersityIndex",
               "description": "PDI from the cumulants fit. <0.1 monodisperse, >0.4 broad/aggregated. Definition differs between instruments -- check the ``definition`` field."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Translational diffusion coefficient from the cumulants fit."
            },
            "intercept": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "ACF y-intercept at tau=0. Data quality indicator; ideal = 1.0."
            },
            "mean_count_rate": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Photon count rate in kcps. Signal strength indicator."
            },
            "derived_mean_count_rate": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Derived (attenuation-corrected) mean count rate."
            },
            "in_range": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fraction of the signal within the configured size range."
            },
            "quality_indicator": {
               "description": "Overall data-quality verdict reported by the instrument, e.g. 'good' or a warning message.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "number_of_runs": {
               "description": "Number of sub-runs/acquisitions averaged into this result.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "run_retention": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Fraction of sub-runs retained after quality filtering."
            },
            "particle_concentration": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Estimated particle concentration."
            },
            "cumulant_fit": {
               "$ref": "#/definitions/CumulantFit",
               "description": "Cumulant fit for the averaged measurement."
            },
            "regularized_fit_peaks": {
               "description": "Peaks from the regularized fit of the averaged measurement.",
               "items": {
                  "$ref": "#/definitions/RegularizedFitPeak"
               },
               "type": "array"
            },
            "acquisitions": {
               "description": "Per-acquisition results within the measurement.",
               "items": {
                  "$ref": "#/definitions/DLSAcquisition"
               },
               "type": "array"
            },
            "average_instrument_reading": {
               "$ref": "#/definitions/InstrumentReading",
               "description": "Average instrument reading over all acquisitions."
            },
            "derived": {
               "$ref": "#/definitions/DerivedAnalysis",
               "description": "Derived concentration-dependent analysis (DynaPro SLS companion)."
            }
         },
         "type": "object"
      },
      "DerivedAnalysis": {
         "additionalProperties": false,
         "description": "Derived concentration-dependent analysis from DLS (DynaPro SLS\ncompanion), computed across a concentration series.",
         "properties": {
            "kd": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion interaction parameter (k_D) from the concentration series."
            },
            "a2": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Second virial coefficient (A2) from the concentration series."
            },
            "tagg": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Aggregation onset temperature (T_agg), when a thermal ramp is run."
            }
         },
         "type": "object"
      },
      "InstrumentReading": {
         "additionalProperties": false,
         "description": "Average instrument reading over all acquisitions in a measurement.",
         "properties": {
            "intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Average scattered light intensity."
            },
            "temperature": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Average measured temperature."
            },
            "time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Average acquisition time."
            }
         },
         "type": "object"
      },
      "PolydispersityIndex": {
         "additionalProperties": false,
         "description": "Polydispersity index (PDI) from the cumulants fit: <0.1 indicates a\nmonodisperse sample, >0.4 a broad or aggregated one. The computation\ndiffers between instruments -- always check ``definition``.",
         "properties": {
            "value": {
               "description": "Numeric PDI value.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit of the PDI value (typically dimensionless).",
               "type": [
                  "string",
                  "null"
               ]
            },
            "definition": {
               "description": "Algorithm used to compute the PDI. The definitions are not interchangeable.",
               "example_values": [
                  "iso_22412",
                  "percent_pd_over_100"
               ],
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "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"
      },
      "RegularizedFitPeak": {
         "additionalProperties": false,
         "description": "A single peak from regularized NNLS deconvolution of the DLS ACF.",
         "properties": {
            "dist": {
               "description": "Distribution index the peak belongs to.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "peak_index": {
               "description": "Index of the peak within the distribution.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Hydrodynamic radius of the peak."
            },
            "diffusion_coefficient": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Diffusion coefficient of the peak."
            },
            "molecular_weight": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molecular weight estimated for the peak."
            },
            "polydispersity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Polydispersity of the peak."
            },
            "first_index": {
               "description": "Index of the first ACF grid point contributing to the peak.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "number_of_points": {
               "description": "Number of ACF grid points contributing to the peak.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "decay_time": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Characteristic decay time of the peak."
            },
            "percent_intensity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the intensity-weighted distribution, as a percentage."
            },
            "percent_mass": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the mass/volume-weighted distribution, as a percentage."
            },
            "percent_number": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Contribution of the peak to the number-weighted distribution, as a percentage."
            }
         },
         "type": "object"
      },
      "ZAverage": {
         "additionalProperties": false,
         "description": "Intensity-weighted harmonic mean hydrodynamic size from the cumulants\nfit. The Zetasizer reports diameter natively; DynaPro reports radius\nnatively.",
         "properties": {
            "diameter": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Z-average hydrodynamic diameter."
            },
            "radius": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Z-average hydrodynamic radius."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field dynamic_light_scattering: DLSResult

Dynamic Light Scattering results.

Model ElectrophoreticLightScattering

Bases: IdsElement

Adds the Electrophoretic Light Scattering (zeta potential) result block.

Show JSON schema

{
   "description": "Adds the Electrophoretic Light Scattering (zeta potential) result block.",
   "type": "object",
   "properties": {
      "electrophoretic_light_scattering": {
         "$ref": "#/definitions/ELSResult",
         "description": "Electrophoretic Light Scattering / zeta potential results."
      }
   },
   "additionalProperties": false,
   "definitions": {
      "ELSResult": {
         "additionalProperties": false,
         "description": "Electrophoretic Light Scattering (ELS) / zeta potential results.",
         "properties": {
            "potential": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Zeta potential."
            },
            "zeta_deviation": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Standard deviation (width) of the zeta potential distribution."
            },
            "mobility": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Electrophoretic mobility."
            },
            "model": {
               "description": "Model used to convert mobility to zeta potential, e.g. 'Smoluchowski' or 'Huckel'.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "conductivity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Conductivity of the dispersant."
            },
            "mean_count_rate": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Photon count rate in kcps during the ELS measurement."
            },
            "quality_factor": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Data quality factor reported for the measurement."
            },
            "effective_voltage": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Effective voltage applied across the cell."
            },
            "measured_voltage": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Measured voltage across the cell."
            },
            "measured_current": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Measured current through the cell."
            },
            "distribution": {
               "$ref": "#/definitions/ZetaDistribution",
               "description": "Zeta potential distribution."
            }
         },
         "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"
      },
      "ZetaDistribution": {
         "additionalProperties": false,
         "description": "Zeta potential distribution, expressed as a set of peaks.",
         "properties": {
            "peaks": {
               "description": "Peaks that make up the zeta potential distribution.",
               "items": {
                  "$ref": "#/definitions/ZetaDistributionPeak"
               },
               "type": "array"
            }
         },
         "type": "object"
      },
      "ZetaDistributionPeak": {
         "additionalProperties": false,
         "description": "A single peak in a zeta potential distribution.",
         "properties": {
            "mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Mean zeta potential of the peak."
            },
            "area": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Area (relative contribution) of the peak."
            }
         },
         "type": "object"
      }
   }
}

Validators:

field electrophoretic_light_scattering: ELSResult

Electrophoretic Light Scattering / zeta potential results.

Model LaserDiffraction

Bases: IdsElement

Adds the Laser Diffraction result block.

Show JSON schema

{
   "description": "Adds the Laser Diffraction result block.",
   "type": "object",
   "properties": {
      "laser_diffraction": {
         "$ref": "#/definitions/LaserDiffractionResult",
         "description": "Laser Diffraction results."
      }
   },
   "additionalProperties": false,
   "definitions": {
      "AdditionalStatistic": {
         "additionalProperties": false,
         "description": "An additional Dxx percentile beyond the standard D10/D50/D90.",
         "properties": {
            "name": {
               "description": "Name of the percentile, e.g. 'D[v,0.25]'.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "value": {
               "description": "Numeric value of the percentile.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit of the value, e.g. 'Micrometer'.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "type": "object"
      },
      "LaserDiffractionResult": {
         "additionalProperties": false,
         "description": "Laser Diffraction specific results.",
         "properties": {
            "d10": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "10th percentile size: 10% of the volume distribution lies below this size."
            },
            "d50": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "50th percentile (median) size."
            },
            "d90": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "90th percentile size: 90% of the volume distribution lies below this size."
            },
            "span": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Distribution width, (d90 - d10) / d50."
            },
            "volume_weighted_mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "D[4,3] - volume-weighted mean diameter."
            },
            "surface_weighted_mean": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "D[3,2] - surface-weighted mean diameter (Sauter mean)."
            },
            "obscuration": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Obscuration (fraction of light attenuated) during the measurement."
            },
            "concentration": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Sample concentration in the measurement zone."
            },
            "weighted_residual": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Weighted residual of the model fit to the diffraction pattern; a goodness-of-fit indicator."
            },
            "uniformity": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Uniformity of the size distribution."
            },
            "specific_surface_area": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Specific surface area computed from the volume distribution."
            },
            "additional_statistics": {
               "description": "Additional Dxx percentiles beyond D10/D50/D90.",
               "items": {
                  "$ref": "#/definitions/AdditionalStatistic"
               },
               "type": "array"
            }
         },
         "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 laser_diffraction: LaserDiffractionResult

Laser Diffraction results.

Model StaticLightScattering

Bases: IdsElement

Adds the Static Light Scattering result block.

Show JSON schema

{
   "description": "Adds the Static Light Scattering result block.",
   "type": "object",
   "properties": {
      "static_light_scattering": {
         "$ref": "#/definitions/SLSResult",
         "description": "Static Light Scattering results."
      }
   },
   "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"
      },
      "SLSResult": {
         "additionalProperties": false,
         "description": "Static Light Scattering (SLS) results (DynaPro only, simultaneous with DLS).",
         "properties": {
            "molar_mass": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Molar mass from the static scattering intensity."
            },
            "particle_concentration": {
               "$ref": "#/definitions/RawValueUnit",
               "description": "Particle concentration used in the SLS calculation."
            },
            "error": {
               "description": "Error/warning message for the SLS calculation, when present.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "type": "object"
      }
   }
}

Validators:

field static_light_scattering: SLSResult

Static Light Scattering results.