Skip to main content
Ctrl+K
ESSimaging - Home ESSimaging - Home
  • Odin
  • Test beamline
  • Ymir
  • Tools
  • API Reference
  • Development
  • About
    • Essreduce
    • Plopp
    • Sciline
    • Scipp
    • ScippNeutron
    • ScippNexus
    • Scitiff
    • Tof
  • GitHub
  • PyPI
  • Conda
  • Scipp
  • Odin
  • Test beamline
  • Ymir
  • Tools
  • API Reference
  • Development
  • About
  • Essreduce
  • Plopp
  • Sciline
  • Scipp
  • ScippNeutron
  • ScippNexus
  • Scitiff
  • Tof
  • GitHub
  • PyPI
  • Conda
  • Scipp

Section Navigation

  • ess.imaging.data
    • ess.imaging.data.jparc_siemens_star_measured_path
    • ess.imaging.data.jparc_siemens_star_openbeam_path
    • ess.imaging.data.resolving_power_test_target_path
    • ess.imaging.data.siemens_star_path
  • ess.imaging.tools
    • ess.imaging.tools.analysis
      • ess.imaging.tools.analysis.blockify
      • ess.imaging.tools.analysis.laplace_2d
      • ess.imaging.tools.analysis.resample
      • ess.imaging.tools.analysis.resize
      • ess.imaging.tools.analysis.sharpness
    • ess.imaging.tools.resolution
      • ess.imaging.tools.resolution.estimate_cut_off_frequency
      • ess.imaging.tools.resolution.maximum_resolution_achievable
      • ess.imaging.tools.resolution.modulation_transfer_function
      • ess.imaging.tools.resolution.mtf_less_than
    • ess.imaging.tools.saturation
      • ess.imaging.tools.saturation.saturation_indicator
  • ess.imaging.types
    • ess.imaging.types.SampleRun
    • ess.imaging.types.DarkBackgroundRun
    • ess.imaging.types.OpenBeamRun
    • ess.imaging.types.AllRuns
    • ess.imaging.types.BeamMonitor1
    • ess.imaging.types.BeamMonitor2
    • ess.imaging.types.BeamMonitor3
    • ess.imaging.types.BeamMonitor4
    • ess.imaging.types.MaskingRules
    • ess.imaging.types.MeanDarkFrame
    • ess.imaging.types.NormalizedImage
    • ess.imaging.types.ImageKey
    • ess.imaging.types.BackgroundSubtractedDetector
    • ess.imaging.types.CoordTransformGraph
    • ess.imaging.types.CorrectedDetector
    • ess.imaging.types.FluxNormalizedDetector
  • ess.odin.beamline
    • ess.odin.beamline.choppers
  • ess.odin.data
    • ess.odin.data.iron_simulation_ob_large
    • ess.odin.data.iron_simulation_ob_small
    • ess.odin.data.iron_simulation_sample_large
    • ess.odin.data.iron_simulation_sample_small
    • ess.odin.data.odin_lego_images
    • ess.odin.data.odin_wavelength_lookup_table
  • ess.odin.masking
    • ess.odin.masking.apply_masks
  • ess.odin.workflows
    • ess.odin.workflows.OdinBraggEdgeWorkflow
    • ess.odin.workflows.OdinOrcaWorkflow
    • ess.odin.workflows.OdinWorkflow
    • ess.odin.workflows.compute_detector_tof
    • ess.odin.workflows.default_parameters
    • ess.odin.workflows.extract_dark_run
    • ess.odin.workflows.extract_openbeam_run
    • ess.odin.workflows.extract_sample_run
    • ess.odin.workflows.load_image_key
    • ess.odin.workflows.normalize_by_proton_charge_orca_all_runs
  • ess.tbl.data
    • ess.tbl.data.tbl_lego_dark_run
    • ess.tbl.data.tbl_lego_openbeam_run
    • ess.tbl.data.tbl_lego_sample_run
    • ess.tbl.data.tbl_orca_focussing_data
    • ess.tbl.data.tbl_wavelength_lookup_table_no_choppers
    • ess.tbl.data.tutorial_sample_data
  • ess.tbl.workflow
    • ess.tbl.workflow.OrcaNormalizedImagesWorkflow
    • ess.tbl.workflow.TblWorkflow
    • ess.tbl.workflow.default_parameters
  • ess.ymir.data
    • ess.ymir.data.ymir_lego_images_path
  • ess.ymir.io
    • ess.ymir.io.FileLock
    • ess.ymir.io.HistogramModeDetector
    • ess.ymir.io.HistogramModeDetectorData
    • ess.ymir.io.ImageKeyCoord
    • ess.ymir.io.SampleImageStacksWithLogs
    • ess.ymir.io.RotationAngleCoord
    • ess.ymir.io.RawSampleImageStacks
    • ess.ymir.io.OpenBeamImageStacks
    • ess.ymir.io.DarkCurrentImageStacks
    • ess.ymir.io.IMAGE_KEY_COORD_NAME
    • ess.ymir.io.TIME_COORD_NAME
    • ess.ymir.io.ROTATION_ANGLE_COORD_NAME
    • ess.ymir.io.DIM1_COORD_NAME
    • ess.ymir.io.DIM2_COORD_NAME
    • ess.ymir.io.MinDim1
    • ess.ymir.io.MaxDim1
    • ess.ymir.io.MinDim2
    • ess.ymir.io.apply_logs_as_coords
    • ess.ymir.io.derive_log_coord_by_range
    • ess.ymir.io.dummy_progress_wrapper
    • ess.ymir.io.export_image_stacks_as_tiff
    • ess.ymir.io.load_nexus_histogram_mode_detector
    • ess.ymir.io.load_nexus_rotation_logs
    • ess.ymir.io.retrieve_dark_current_images
    • ess.ymir.io.retrieve_open_beam_images
    • ess.ymir.io.retrieve_sample_images
    • ess.ymir.io.separate_detector_images
    • ess.ymir.io.separate_image_by_keys
    • ess.ymir.io.separate_image_key_logs
    • ess.ymir.io.tiff_from_nexus
    • ess.ymir.io.ImageKey
  • ess.ymir.normalize
    • ess.ymir.normalize.AverageBackgroundPixelCounts
    • ess.ymir.normalize.AverageSamplePixelCounts
    • ess.ymir.normalize.ScaleFactor
    • ess.ymir.normalize.OpenBeamImage
    • ess.ymir.normalize.DarkCurrentImage
    • ess.ymir.normalize.CleansedOpenBeamImage
    • ess.ymir.normalize.CleansedSampleImages
    • ess.ymir.normalize.SampleImageStacks
    • ess.ymir.normalize.BackgroundImage
    • ess.ymir.normalize.NormalizedSampleImages
    • ess.ymir.normalize.BackgroundPixelThreshold
    • ess.ymir.normalize.SamplePixelThreshold
    • ess.ymir.normalize.apply_threshold_to_background_image
    • ess.ymir.normalize.apply_threshold_to_sample_images
    • ess.ymir.normalize.average_background_pixel_counts
    • ess.ymir.normalize.average_dark_current_images
    • ess.ymir.normalize.average_open_beam_images
    • ess.ymir.normalize.average_sample_pixel_counts
    • ess.ymir.normalize.calculate_scale_factor
    • ess.ymir.normalize.cleanse_open_beam_image
    • ess.ymir.normalize.cleanse_sample_images
    • ess.ymir.normalize.normalize_sample_images
  • ess.ymir.types
    • ess.ymir.types.ImageDetectorName
    • ess.ymir.types.ImageKeyLogs
    • ess.ymir.types.RotationMotionSensorName
    • ess.ymir.types.RotationLogs
    • ess.ymir.types.HistogramModeDetectorsPath
  • ess.ymir.workflow
    • ess.ymir.workflow.YmirImageNormalizationWorkflow
On this page
  • load_image_key()
Show Source
  • API Reference
  • ess.odin.workflows
  • ess.odin.workflows.load_image_key

ess.odin.workflows.load_image_key#

ess.odin.workflows.load_image_key(file, path)[source]#
Return type:

types.ImageKey (scipp.DataArray)

previous

ess.odin.workflows.extract_sample_run

next

ess.odin.workflows.normalize_by_proton_charge_orca_all_runs

© Copyright 2025 Scipp contributors.

Created using Sphinx 8.2.3.

Current ESSimaging version: 26.9.1 (older versions).

Built with the PyData Sphinx Theme 0.19.0.