ts_ids_components.particle_sizer.shared module

Shared method components used across particle sizer techniques (DLS, ELS, SLS, and Laser Diffraction).

These describe the sample environment and the optical constants needed to convert a light-scattering measurement into a particle size: the dispersant (Solvent), the analyte particle’s optical properties (Particle), the measurement Temperature, and the Plate for plate-reader instruments.

Model Temperature

Bases: IdsElement

Target (set-point) and actual (measured) temperature for a measurement.

Show JSON schema

{
   "description": "Target (set-point) and actual (measured) temperature for a measurement.",
   "type": "object",
   "properties": {
      "target": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Target/set-point temperature configured for the measurement."
      },
      "actual": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Actual temperature measured during the measurement."
      }
   },
   "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 actual: RawValueUnit

Actual temperature measured during the measurement.

field target: RawValueUnit

Target/set-point temperature configured for the measurement.

Model Solvent

Bases: IdsElement

Dispersant / solvent medium the particles are suspended in. Its refractive index and viscosity are required inputs to the Stokes-Einstein relation used to convert a measured diffusion coefficient into a hydrodynamic size, and its dielectric constant is required for ELS/zeta potential calculations.

Show JSON schema

{
   "description": "Dispersant / solvent medium the particles are suspended in. Its\nrefractive index and viscosity are required inputs to the Stokes-Einstein\nrelation used to convert a measured diffusion coefficient into a\nhydrodynamic size, and its dielectric constant is required for ELS/zeta\npotential calculations.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Vendor identifier for the dispersant in the instrument's material database.",
         "type": [
            "string",
            "null"
         ]
      },
      "name": {
         "description": "Name of the dispersant, e.g. 'Water'.",
         "type": [
            "string",
            "null"
         ]
      },
      "refractive_index": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Refractive index of the dispersant at the measurement wavelength."
      },
      "viscosity": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Dynamic viscosity of the dispersant at the measurement temperature."
      },
      "dielectric_constant": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Dielectric constant (relative permittivity) of the dispersant, used for ELS/zeta calculations."
      },
      "abundance": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Relative abundance/fraction of this dispersant, when the medium is a mixture."
      }
   },
   "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 abundance: RawValueUnit

Relative abundance/fraction of this dispersant, when the medium is a mixture.

field dielectric_constant: RawValueUnit

Dielectric constant (relative permittivity) of the dispersant, used for ELS/zeta calculations.

field id_: str | None (alias 'id')

Vendor identifier for the dispersant in the instrument’s material database.

field name: str | None

Name of the dispersant, e.g. ‘Water’.

field refractive_index: RawValueUnit

Refractive index of the dispersant at the measurement wavelength.

field viscosity: RawValueUnit

Dynamic viscosity of the dispersant at the measurement temperature.

Model Particle

Bases: IdsElement

Optical properties of the analyte particle (material). The refractive index and absorption index are the material constants used by the scattering model (e.g. Mie theory for laser diffraction) to convert a scattering pattern into a size distribution.

The *_blue variants carry the constants at a second, shorter (blue) wavelength, reported by laser diffraction instruments (e.g. Mastersizer) that use a blue light source in addition to the red laser to improve resolution of fine particles.

Show JSON schema

{
   "description": "Optical properties of the analyte particle (material). The refractive\nindex and absorption index are the material constants used by the\nscattering model (e.g. Mie theory for laser diffraction) to convert a\nscattering pattern into a size distribution.\n\nThe ``*_blue`` variants carry the constants at a second, shorter (blue)\nwavelength, reported by laser diffraction instruments (e.g. Mastersizer)\nthat use a blue light source in addition to the red laser to improve\nresolution of fine particles.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Name of the particle material, e.g. 'Polystyrene latex'.",
         "type": [
            "string",
            "null"
         ]
      },
      "refractive_index": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Real part of the particle's refractive index (at the primary/red wavelength)."
      },
      "absorption_index": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Imaginary part (absorption) of the particle's refractive index (at the primary/red wavelength)."
      },
      "refractive_index_blue": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Real part of the particle's refractive index at the blue wavelength (laser diffraction)."
      },
      "absorption_index_blue": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Imaginary part (absorption) of the particle's refractive index at the blue wavelength (laser diffraction)."
      },
      "density": {
         "$ref": "#/definitions/RawValueUnit",
         "description": "Density of the particle material, used to convert between volume- and mass-weighted results."
      },
      "shape_model": {
         "description": "Particle shape model assumed by the analysis, e.g. 'spherical'.",
         "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 absorption_index: RawValueUnit

Imaginary part (absorption) of the particle’s refractive index (at the primary/red wavelength).

field absorption_index_blue: RawValueUnit

Imaginary part (absorption) of the particle’s refractive index at the blue wavelength (laser diffraction).

field density: RawValueUnit

Density of the particle material, used to convert between volume- and mass-weighted results.

field name: str | None

Name of the particle material, e.g. ‘Polystyrene latex’.

field refractive_index: RawValueUnit

Real part of the particle’s refractive index (at the primary/red wavelength).

field refractive_index_blue: RawValueUnit

Real part of the particle’s refractive index at the blue wavelength (laser diffraction).

field shape_model: str | None

Particle shape model assumed by the analysis, e.g. ‘spherical’.

Model Plate

Bases: IdsElement

Well plate used by plate-reader DLS instruments (e.g. DynaPro Plate Reader), where each well holds a separate sample.

Show JSON schema

{
   "description": "Well plate used by plate-reader DLS instruments (e.g. DynaPro Plate\nReader), where each well holds a separate sample.",
   "type": "object",
   "properties": {
      "brand": {
         "description": "Manufacturer/brand of the plate.",
         "type": [
            "string",
            "null"
         ]
      },
      "name": {
         "description": "Name or catalog identifier of the plate.",
         "type": [
            "string",
            "null"
         ]
      },
      "type": {
         "description": "Plate type/format, e.g. '96-well' or '384-well'.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

field brand: str | None

Manufacturer/brand of the plate.

field name: str | None

Name or catalog identifier of the plate.

field type_: str | None (alias 'type')

Plate type/format, e.g. ‘96-well’ or ‘384-well’.