# {py:mod}`nexusLIMS.schemas.metadata` ```{py:module} nexusLIMS.schemas.metadata ``` ```{autodoc2-docstring} nexusLIMS.schemas.metadata :parser: autodoc2_docstrings_parser :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`ExtractionDetails ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails :parser: autodoc2_docstrings_parser :summary: ``` * - {py:obj}`StagePosition ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition :parser: autodoc2_docstrings_parser :summary: ``` * - {py:obj}`NexusMetadata ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata :parser: autodoc2_docstrings_parser :summary: ``` * - {py:obj}`ImageMetadata ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata :parser: autodoc2_docstrings_parser :summary: ``` * - {py:obj}`SpectrumMetadata ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata :parser: autodoc2_docstrings_parser :summary: ``` * - {py:obj}`SpectrumImageMetadata ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumImageMetadata :parser: autodoc2_docstrings_parser :summary: ``` * - {py:obj}`DiffractionMetadata ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata :parser: autodoc2_docstrings_parser :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`emg_field ` - ```{autodoc2-docstring} nexusLIMS.schemas.metadata.emg_field :parser: autodoc2_docstrings_parser :summary: ``` ```` ### API ````{py:function} emg_field(field_name: str, default: typing.Any = None, *, description: str | None = None, **kwargs: typing.Any) -> typing.Any :canonical: nexusLIMS.schemas.metadata.emg_field ```{autodoc2-docstring} nexusLIMS.schemas.metadata.emg_field :parser: autodoc2_docstrings_parser ``` ```` `````{py:class} ExtractionDetails(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.ExtractionDetails Bases: {py:obj}`pydantic.BaseModel` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails :parser: autodoc2_docstrings_parser ``` ````{py:attribute} date :canonical: nexusLIMS.schemas.metadata.ExtractionDetails.date **Type:** str ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails.date :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} module :canonical: nexusLIMS.schemas.metadata.ExtractionDetails.module **Type:** str ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails.module :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} version :canonical: nexusLIMS.schemas.metadata.ExtractionDetails.version **Type:** str ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails.version :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} extractor_warnings :canonical: nexusLIMS.schemas.metadata.ExtractionDetails.extractor_warnings **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails.extractor_warnings :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} model_config :canonical: nexusLIMS.schemas.metadata.ExtractionDetails.model_config **Type:** dict ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ExtractionDetails.model_config :parser: autodoc2_docstrings_parser ``` ```` ````` `````{py:class} StagePosition(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.StagePosition Bases: {py:obj}`pydantic.BaseModel` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition :parser: autodoc2_docstrings_parser ``` ````{py:attribute} x :canonical: nexusLIMS.schemas.metadata.StagePosition.x **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.x :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} y :canonical: nexusLIMS.schemas.metadata.StagePosition.y **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.y :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} z :canonical: nexusLIMS.schemas.metadata.StagePosition.z **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.z :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} rotation :canonical: nexusLIMS.schemas.metadata.StagePosition.rotation **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.rotation :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} tilt_alpha :canonical: nexusLIMS.schemas.metadata.StagePosition.tilt_alpha **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.tilt_alpha :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} tilt_beta :canonical: nexusLIMS.schemas.metadata.StagePosition.tilt_beta **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.tilt_beta :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} model_config :canonical: nexusLIMS.schemas.metadata.StagePosition.model_config ```{autodoc2-docstring} nexusLIMS.schemas.metadata.StagePosition.model_config :parser: autodoc2_docstrings_parser ``` ```` ````` `````{py:class} NexusMetadata(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.NexusMetadata Bases: {py:obj}`pydantic.BaseModel` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata :parser: autodoc2_docstrings_parser ``` ````{py:attribute} creation_time :canonical: nexusLIMS.schemas.metadata.NexusMetadata.creation_time **Type:** str ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.creation_time :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} data_type :canonical: nexusLIMS.schemas.metadata.NexusMetadata.data_type **Type:** str ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.data_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} dataset_type :canonical: nexusLIMS.schemas.metadata.NexusMetadata.dataset_type **Type:** typing.Literal[Image, Spectrum, SpectrumImage, Diffraction, Misc, Unknown] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.dataset_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} data_dimensions :canonical: nexusLIMS.schemas.metadata.NexusMetadata.data_dimensions **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.data_dimensions :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} instrument_id :canonical: nexusLIMS.schemas.metadata.NexusMetadata.instrument_id **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.instrument_id :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} warnings :canonical: nexusLIMS.schemas.metadata.NexusMetadata.warnings **Type:** list[str | list[str]] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.warnings :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} nexuslims_extraction :canonical: nexusLIMS.schemas.metadata.NexusMetadata.nexuslims_extraction **Type:** nexusLIMS.schemas.metadata.ExtractionDetails | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.nexuslims_extraction :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} extensions :canonical: nexusLIMS.schemas.metadata.NexusMetadata.extensions **Type:** typing.Dict[str, typing.Any] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.extensions :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} model_config :canonical: nexusLIMS.schemas.metadata.NexusMetadata.model_config ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.model_config :parser: autodoc2_docstrings_parser ``` ```` ````{py:method} validate_iso_timestamp(v: str) -> str :canonical: nexusLIMS.schemas.metadata.NexusMetadata.validate_iso_timestamp :classmethod: ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.validate_iso_timestamp :parser: autodoc2_docstrings_parser ``` ```` ````{py:method} validate_data_type_not_empty(v: str) -> str :canonical: nexusLIMS.schemas.metadata.NexusMetadata.validate_data_type_not_empty :classmethod: ```{autodoc2-docstring} nexusLIMS.schemas.metadata.NexusMetadata.validate_data_type_not_empty :parser: autodoc2_docstrings_parser ``` ```` ````` `````{py:class} ImageMetadata(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.ImageMetadata Bases: {py:obj}`nexusLIMS.schemas.metadata.NexusMetadata` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata :parser: autodoc2_docstrings_parser ``` ````{py:attribute} dataset_type :canonical: nexusLIMS.schemas.metadata.ImageMetadata.dataset_type **Type:** typing.Literal[Image] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.dataset_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} acceleration_voltage :canonical: nexusLIMS.schemas.metadata.ImageMetadata.acceleration_voltage **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.acceleration_voltage :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} working_distance :canonical: nexusLIMS.schemas.metadata.ImageMetadata.working_distance **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.working_distance :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} beam_current :canonical: nexusLIMS.schemas.metadata.ImageMetadata.beam_current **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.beam_current :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} emission_current :canonical: nexusLIMS.schemas.metadata.ImageMetadata.emission_current **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.emission_current :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} dwell_time :canonical: nexusLIMS.schemas.metadata.ImageMetadata.dwell_time **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.dwell_time :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} magnification :canonical: nexusLIMS.schemas.metadata.ImageMetadata.magnification **Type:** float | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.magnification :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} horizontal_field_width :canonical: nexusLIMS.schemas.metadata.ImageMetadata.horizontal_field_width **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.horizontal_field_width :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} vertical_field_width :canonical: nexusLIMS.schemas.metadata.ImageMetadata.vertical_field_width **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.vertical_field_width :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} pixel_width :canonical: nexusLIMS.schemas.metadata.ImageMetadata.pixel_width **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.pixel_width :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} pixel_height :canonical: nexusLIMS.schemas.metadata.ImageMetadata.pixel_height **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.pixel_height :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} scan_rotation :canonical: nexusLIMS.schemas.metadata.ImageMetadata.scan_rotation **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.scan_rotation :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} detector_type :canonical: nexusLIMS.schemas.metadata.ImageMetadata.detector_type **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.detector_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} acquisition_device :canonical: nexusLIMS.schemas.metadata.ImageMetadata.acquisition_device **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.acquisition_device :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} stage_position :canonical: nexusLIMS.schemas.metadata.ImageMetadata.stage_position **Type:** nexusLIMS.schemas.metadata.StagePosition | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.ImageMetadata.stage_position :parser: autodoc2_docstrings_parser ``` ```` ````` `````{py:class} SpectrumMetadata(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata Bases: {py:obj}`nexusLIMS.schemas.metadata.NexusMetadata` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata :parser: autodoc2_docstrings_parser ``` ````{py:attribute} dataset_type :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.dataset_type **Type:** typing.Literal[Spectrum] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.dataset_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} acquisition_time :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.acquisition_time **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.acquisition_time :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} live_time :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.live_time **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.live_time :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} detector_energy_resolution :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.detector_energy_resolution **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.detector_energy_resolution :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} channel_size :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.channel_size **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.channel_size :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} starting_energy :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.starting_energy **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.starting_energy :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} azimuthal_angle :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.azimuthal_angle **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.azimuthal_angle :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} elevation_angle :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.elevation_angle **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.elevation_angle :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} takeoff_angle :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.takeoff_angle **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.takeoff_angle :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} elements :canonical: nexusLIMS.schemas.metadata.SpectrumMetadata.elements **Type:** list[str] | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumMetadata.elements :parser: autodoc2_docstrings_parser ``` ```` ````` `````{py:class} SpectrumImageMetadata(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.SpectrumImageMetadata Bases: {py:obj}`nexusLIMS.schemas.metadata.ImageMetadata`, {py:obj}`nexusLIMS.schemas.metadata.SpectrumMetadata` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumImageMetadata :parser: autodoc2_docstrings_parser ``` ````{py:attribute} dataset_type :canonical: nexusLIMS.schemas.metadata.SpectrumImageMetadata.dataset_type **Type:** typing.Literal[SpectrumImage] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumImageMetadata.dataset_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} pixel_time :canonical: nexusLIMS.schemas.metadata.SpectrumImageMetadata.pixel_time **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumImageMetadata.pixel_time :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} scan_mode :canonical: nexusLIMS.schemas.metadata.SpectrumImageMetadata.scan_mode **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumImageMetadata.scan_mode :parser: autodoc2_docstrings_parser ``` ```` ````{py:method} validate_spectrum_image_fields() -> nexusLIMS.schemas.metadata.SpectrumImageMetadata :canonical: nexusLIMS.schemas.metadata.SpectrumImageMetadata.validate_spectrum_image_fields ```{autodoc2-docstring} nexusLIMS.schemas.metadata.SpectrumImageMetadata.validate_spectrum_image_fields :parser: autodoc2_docstrings_parser ``` ```` ````` `````{py:class} DiffractionMetadata(/, **data: typing.Any) :canonical: nexusLIMS.schemas.metadata.DiffractionMetadata Bases: {py:obj}`nexusLIMS.schemas.metadata.NexusMetadata` ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata :parser: autodoc2_docstrings_parser ``` ````{py:attribute} dataset_type :canonical: nexusLIMS.schemas.metadata.DiffractionMetadata.dataset_type **Type:** typing.Literal[Diffraction] ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata.dataset_type :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} camera_length :canonical: nexusLIMS.schemas.metadata.DiffractionMetadata.camera_length **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata.camera_length :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} convergence_angle :canonical: nexusLIMS.schemas.metadata.DiffractionMetadata.convergence_angle **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata.convergence_angle :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} acceleration_voltage :canonical: nexusLIMS.schemas.metadata.DiffractionMetadata.acceleration_voltage **Type:** {py:data}`PintQuantity ` | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata.acceleration_voltage :parser: autodoc2_docstrings_parser ``` ```` ````{py:attribute} acquisition_device :canonical: nexusLIMS.schemas.metadata.DiffractionMetadata.acquisition_device **Type:** str | None ```{autodoc2-docstring} nexusLIMS.schemas.metadata.DiffractionMetadata.acquisition_device :parser: autodoc2_docstrings_parser ``` ```` `````