ess.powder.types.Source

pydantic model ess.powder.types.Source

Information about a neutron source.

The ESS source is provided as scippneutron.metadata.ESS_SOURCE.

Show JSON schema

{
   "title": "Source",
   "description": "Information about a neutron source.\n\nThe ESS source is provided as ``scippneutron.metadata.ESS_SOURCE``.",
   "type": "object",
   "properties": {
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      },
      "source_type": {
         "$ref": "#/$defs/SourceType"
      },
      "probe": {
         "$ref": "#/$defs/RadiationProbe"
      }
   },
   "$defs": {
      "RadiationProbe": {
         "description": "Type of radiation probe.\n\nNames are based on NeXus definitions.",
         "enum": [
            "neutron",
            "X-ray"
         ],
         "title": "RadiationProbe",
         "type": "string"
      },
      "SourceType": {
         "description": "Type of source.\n\nNames are based on NeXus definitions.",
         "enum": [
            "Spallation Neutron Source",
            "Reactor Neutron Source",
            "Synchrotron X-ray Source"
         ],
         "title": "SourceType",
         "type": "string"
      }
   },
   "required": [
      "source_type",
      "probe"
   ]
}

Fields:

• name (str | None)

• probe (scippneutron.metadata._model.RadiationProbe)

• source_type (scippneutron.metadata._model.SourceType)

field name: Annotated[str | None, BeforeValidator(_unpack_variable)] = None

Name of the source.

Constraints:

• func = <function _unpack_variable at 0x7f1da02d0e00>

• json_schema_input_type = PydanticUndefined

field probe: RadiationProbe [Required]

Radiation probe of the source.

field source_type: SourceType [Required]

Type of this source.