Skip to content

Class: SAXSInstrument

SAXS/WAXS instrument specifications

URI: lambda:SAXSInstrument

classDiagram class SAXSInstrument click SAXSInstrument href "../SAXSInstrument/" Instrument <|-- SAXSInstrument click Instrument href "../Instrument/" SAXSInstrument : beamline_id SAXSInstrument : current_status SAXSInstrument --> "0..1" InstrumentStatusEnum : current_status click InstrumentStatusEnum href "../InstrumentStatusEnum/" SAXSInstrument : description SAXSInstrument : detector_distance_max SAXSInstrument --> "0..1" QuantityValue : detector_distance_max click QuantityValue href "../QuantityValue/" SAXSInstrument : detector_distance_min SAXSInstrument --> "0..1" QuantityValue : detector_distance_min click QuantityValue href "../QuantityValue/" SAXSInstrument : facility_name SAXSInstrument --> "0..1" FacilityEnum : facility_name click FacilityEnum href "../FacilityEnum/" SAXSInstrument : facility_organization_id SAXSInstrument --> "0..1" Organization : facility_organization_id click Organization href "../Organization/" SAXSInstrument : facility_ror SAXSInstrument : id SAXSInstrument : installation_date SAXSInstrument : instrument_category SAXSInstrument --> "0..1" InstrumentCategoryEnum : instrument_category click InstrumentCategoryEnum href "../InstrumentCategoryEnum/" SAXSInstrument : instrument_code SAXSInstrument : instrument_registry_id SAXSInstrument : manufacturer SAXSInstrument : model SAXSInstrument : q_range_max SAXSInstrument --> "0..1" QuantityValue : q_range_max click QuantityValue href "../QuantityValue/" SAXSInstrument : q_range_min SAXSInstrument --> "0..1" QuantityValue : q_range_min click QuantityValue href "../QuantityValue/" SAXSInstrument : sample_changer_capacity SAXSInstrument --> "0..1" QuantityValue : sample_changer_capacity click QuantityValue href "../QuantityValue/" SAXSInstrument : temperature_control_range SAXSInstrument : title

Inheritance

Slots

Name Cardinality and Range Description Inheritance
q_range_min 0..1
QuantityValue		 Minimum q value in inverse Angstroms direct
q_range_max 0..1
QuantityValue		 Maximum q value in inverse Angstroms direct
detector_distance_min 0..1
QuantityValue		 Minimum detector distance in mm direct
detector_distance_max 0..1
QuantityValue		 Maximum detector distance in mm direct
sample_changer_capacity 0..1
QuantityValue		 Number of samples in automatic sample changer direct
temperature_control_range 0..1
String		 Temperature control range in Celsius direct
instrument_code 1
String		 Human-friendly facility or laboratory identifier for the instrument (e Instrument
instrument_registry_id 0..1
String or 
BeamlineEnum		 Controlled-vocabulary identifier linking this instrument to its canonical ent... Instrument
instrument_category 0..1
InstrumentCategoryEnum		 Category distinguishing beamlines from laboratory equipment Instrument
facility_name 0..1
FacilityEnum		 Name of the research facility where the instrument is located Instrument
facility_ror 0..1
Uriorcurie		 Research Organization Registry (ROR) identifier for the facility Instrument
facility_organization_id 0..1
Organization		 The Organization that operates this instrument's facility Instrument
beamline_id 0..1
String		 Beamline identifier at synchrotron/neutron facility Instrument
manufacturer 0..1
String		 Instrument manufacturer Instrument
model 0..1
String		 Instrument model Instrument
installation_date 0..1
String		 Date of instrument installation Instrument
current_status 0..1
InstrumentStatusEnum		 Current operational status Instrument
id 1
Uriorcurie		 Globally unique identifier as an IRI or CURIE for machine processing and exte... NamedThing
title 0..1
String		 A human-readable name or title for this entity NamedThing
description 0..1
String		 A detailed textual description of this entity NamedThing

Identifier and Mapping Information

Schema Source

  • from schema: http://w3id.org/lambda/

Mappings

Mapping Type Mapped Value
self lambda:SAXSInstrument
native lambda:SAXSInstrument

LinkML Source

Direct

name: SAXSInstrument
description: SAXS/WAXS instrument specifications
from_schema: http://w3id.org/lambda/
is_a: Instrument
attributes:
  q_range_min:
    name: q_range_min
    description: Minimum q value in inverse Angstroms
    from_schema: http://w3id.org/lambda/
    domain_of:
    - SANSInstrument
    - SAXSInstrument
    - BeamlineInstrument
    range: QuantityValue
    inlined: true
  q_range_max:
    name: q_range_max
    description: Maximum q value in inverse Angstroms
    from_schema: http://w3id.org/lambda/
    domain_of:
    - SANSInstrument
    - SAXSInstrument
    - BeamlineInstrument
    range: QuantityValue
    inlined: true
  detector_distance_min:
    name: detector_distance_min
    description: Minimum detector distance in mm
    from_schema: http://w3id.org/lambda/
    rank: 1000
    domain_of:
    - SAXSInstrument
    range: QuantityValue
    inlined: true
  detector_distance_max:
    name: detector_distance_max
    description: Maximum detector distance in mm
    from_schema: http://w3id.org/lambda/
    rank: 1000
    domain_of:
    - SAXSInstrument
    range: QuantityValue
    inlined: true
  sample_changer_capacity:
    name: sample_changer_capacity
    description: Number of samples in automatic sample changer
    from_schema: http://w3id.org/lambda/
    rank: 1000
    domain_of:
    - SAXSInstrument
    - BeamlineInstrument
    range: QuantityValue
    inlined: true
  temperature_control_range:
    name: temperature_control_range
    description: Temperature control range in Celsius
    from_schema: http://w3id.org/lambda/
    rank: 1000
    domain_of:
    - SAXSInstrument

Induced

name: SAXSInstrument
description: SAXS/WAXS instrument specifications
from_schema: http://w3id.org/lambda/
is_a: Instrument
attributes:
  q_range_min:
    name: q_range_min
    description: Minimum q value in inverse Angstroms
    from_schema: http://w3id.org/lambda/
    alias: q_range_min
    owner: SAXSInstrument
    domain_of:
    - SANSInstrument
    - SAXSInstrument
    - BeamlineInstrument
    range: QuantityValue
    inlined: true
  q_range_max:
    name: q_range_max
    description: Maximum q value in inverse Angstroms
    from_schema: http://w3id.org/lambda/
    alias: q_range_max
    owner: SAXSInstrument
    domain_of:
    - SANSInstrument
    - SAXSInstrument
    - BeamlineInstrument
    range: QuantityValue
    inlined: true
  detector_distance_min:
    name: detector_distance_min
    description: Minimum detector distance in mm
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: detector_distance_min
    owner: SAXSInstrument
    domain_of:
    - SAXSInstrument
    range: QuantityValue
    inlined: true
  detector_distance_max:
    name: detector_distance_max
    description: Maximum detector distance in mm
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: detector_distance_max
    owner: SAXSInstrument
    domain_of:
    - SAXSInstrument
    range: QuantityValue
    inlined: true
  sample_changer_capacity:
    name: sample_changer_capacity
    description: Number of samples in automatic sample changer
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: sample_changer_capacity
    owner: SAXSInstrument
    domain_of:
    - SAXSInstrument
    - BeamlineInstrument
    range: QuantityValue
    inlined: true
  temperature_control_range:
    name: temperature_control_range
    description: Temperature control range in Celsius
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: temperature_control_range
    owner: SAXSInstrument
    domain_of:
    - SAXSInstrument
    range: string
  instrument_code:
    name: instrument_code
    description: Human-friendly facility or laboratory identifier for the instrument
      (e.g., 'TITAN-KRIOS-1', 'ALS-12.3.1-SIBYLS', 'RIGAKU-FR-E'). Used for local
      reference and equipment tracking.
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: instrument_code
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: string
    required: true
  instrument_registry_id:
    name: instrument_registry_id
    description: Controlled-vocabulary identifier linking this instrument to its canonical
      entry in a registry enum appropriate to the instrument type. For beamlines,
      use a value from BeamlineEnum; additional instrument-type registries may be
      referenced here as they are introduced.
    comments:
    - Use this to link an instrument record to a known, validated registry entry,
      enabling schema-level validation against typos
    - instrument_code is a free-text local label; instrument_registry_id is the schema-level
      controlled identity
    - beamline_id captures the facility-local string ID (e.g., '19-ID'); instrument_registry_id
      captures the enum identity (e.g., APS_SBCCAT_19ID)
    - Distinct from the instrument_id foreign-key slot used in association tables,
      which references an Instrument object
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: instrument_registry_id
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: string
    any_of:
    - range: BeamlineEnum
  instrument_category:
    name: instrument_category
    description: Category distinguishing beamlines from laboratory equipment
    comments:
    - Use SYNCHROTRON_BEAMLINE for synchrotron beamlines
    - Use ELECTRON_MICROSCOPE for cryo-EM instruments
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: instrument_category
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: InstrumentCategoryEnum
  facility_name:
    name: facility_name
    description: Name of the research facility where the instrument is located
    comments:
    - Select from the standardized list of major synchrotron facilities
    - Leave empty for laboratory-based instruments
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: facility_name
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: FacilityEnum
  facility_ror:
    name: facility_ror
    description: Research Organization Registry (ROR) identifier for the facility
    comments:
    - Persistent identifier for the facility organization
    - 'Example: https://ror.org/02jbv0t02 (Lawrence Berkeley National Laboratory)'
    - Retained for sources that publish only a ROR. Where the facility is described
      as an entity, prefer facility_organization_id, which reaches its parent institution,
      type and location rather than just its identifier.
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: facility_ror
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: uriorcurie
    pattern: ^https://ror\.org/\w+$
  facility_organization_id:
    name: facility_organization_id
    description: The Organization that operates this instrument's facility. An instrument
      sits at exactly one facility, so this is a direct reference rather than an association
      table - the same shape as Sample.parent_sample_id.
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: facility_organization_id
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: Organization
  beamline_id:
    name: beamline_id
    description: Beamline identifier at synchrotron/neutron facility
    comments:
    - Use facility-specific naming convention
    - 'Examples: ''12.3.1'' (ALS), ''17-ID-1'' (NSLS-II), ''I04'' (Diamond)'
    - For a validated controlled-vocabulary identity, also set instrument_registry_id
      (e.g., APS_SBCCAT_19ID)
    from_schema: http://w3id.org/lambda/
    exact_mappings:
    - mmCIF:_diffrn_source.pdbx_synchrotron_beamline
    - nsls2:Beamline
    - ispyb:BLSession.beamLineName
    rank: 1000
    alias: beamline_id
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: string
  manufacturer:
    name: manufacturer
    description: Instrument manufacturer
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: manufacturer
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: string
  model:
    name: model
    description: Instrument model
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: model
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: string
  installation_date:
    name: installation_date
    description: Date of instrument installation
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: installation_date
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: string
  current_status:
    name: current_status
    description: Current operational status
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: current_status
    owner: SAXSInstrument
    domain_of:
    - Instrument
    range: InstrumentStatusEnum
  id:
    name: id
    description: Globally unique identifier as an IRI or CURIE for machine processing
      and external references. Used for linking data across systems and semantic web
      integration.
    from_schema: http://w3id.org/lambda/
    rank: 1000
    identifier: true
    alias: id
    owner: SAXSInstrument
    domain_of:
    - NamedThing
    - Attribute
    range: uriorcurie
    required: true
  title:
    name: title
    description: A human-readable name or title for this entity
    from_schema: http://w3id.org/lambda/
    rank: 1000
    slot_uri: dcterms:title
    alias: title
    owner: SAXSInstrument
    domain_of:
    - NamedThing
    range: string
  description:
    name: description
    description: A detailed textual description of this entity
    from_schema: http://w3id.org/lambda/
    rank: 1000
    alias: description
    owner: SAXSInstrument
    domain_of:
    - NamedThing
    - AttributeGroup
    range: string