Skip to main content
Ctrl+K
ESSimaging - Home
  • User guide
  • API Reference
  • Development
  • About
    • Essreduce
    • Plopp
    • Sciline
    • Scipp
    • ScippNexus
  • GitHub
  • PyPI
  • Conda
  • User guide
  • API Reference
  • Development
  • About
  • Essreduce
  • Plopp
  • Sciline
  • Scipp
  • ScippNexus
  • GitHub
  • PyPI
  • Conda

Section Navigation

  • ess.imaging.normalize
    • ess.imaging.normalize.AverageBackgroundPixelCounts
    • ess.imaging.normalize.AverageSamplePixelCounts
    • ess.imaging.normalize.ScaleFactor
    • ess.imaging.normalize.OpenBeamImage
    • ess.imaging.normalize.DarkCurrentImage
    • ess.imaging.normalize.CleansedOpenBeamImage
    • ess.imaging.normalize.CleansedSampleImages
    • ess.imaging.normalize.SampleImageStacks
    • ess.imaging.normalize.BackgroundImage
    • ess.imaging.normalize.NormalizedSampleImages
    • ess.imaging.normalize.BackgroundPixelThreshold
    • ess.imaging.normalize.SamplePixelThreshold
    • ess.imaging.normalize.apply_threshold_to_background_image
    • ess.imaging.normalize.apply_threshold_to_sample_images
    • ess.imaging.normalize.average_background_pixel_counts
    • ess.imaging.normalize.average_dark_current_images
    • ess.imaging.normalize.average_open_beam_images
    • ess.imaging.normalize.average_sample_pixel_counts
    • ess.imaging.normalize.calculate_scale_factor
    • ess.imaging.normalize.cleanse_open_beam_image
    • ess.imaging.normalize.cleanse_sample_images
    • ess.imaging.normalize.normalize_sample_images
  • ess.imaging.io
    • ess.imaging.io.FileLock
    • ess.imaging.io.HistogramModeDetector
    • ess.imaging.io.HistogramModeDetectorData
    • ess.imaging.io.ImageKeyCoord
    • ess.imaging.io.SampleImageStacksWithLogs
    • ess.imaging.io.RotationAngleCoord
    • ess.imaging.io.RawSampleImageStacks
    • ess.imaging.io.OpenBeamImageStacks
    • ess.imaging.io.DarkCurrentImageStacks
    • ess.imaging.io.IMAGE_KEY_COORD_NAME
    • ess.imaging.io.TIME_COORD_NAME
    • ess.imaging.io.ROTATION_ANGLE_COORD_NAME
    • ess.imaging.io.DIM1_COORD_NAME
    • ess.imaging.io.DIM2_COORD_NAME
    • ess.imaging.io.MinDim1
    • ess.imaging.io.MaxDim1
    • ess.imaging.io.MinDim2
    • ess.imaging.io.apply_logs_as_coords
    • ess.imaging.io.derive_log_coord_by_range
    • ess.imaging.io.dummy_progress_wrapper
    • ess.imaging.io.export_image_stacks_as_tiff
    • ess.imaging.io.load_nexus_histogram_mode_detector
    • ess.imaging.io.load_nexus_rotation_logs
    • ess.imaging.io.retrieve_dark_current_images
    • ess.imaging.io.retrieve_open_beam_images
    • ess.imaging.io.retrieve_sample_images
    • ess.imaging.io.separate_detector_images
    • ess.imaging.io.separate_image_by_keys
    • ess.imaging.io.separate_image_key_logs
    • ess.imaging.io.ImageKey
  • ess.imaging.workflow
    • ess.imaging.workflow.YmirImageNormalizationWorkflow
On this page
  • retrieve_sample_images()
Show Source
  • API Reference
  • ess.imaging.io
  • ess.imaging....

ess.imaging.io.retrieve_sample_images#

ess.imaging.io.retrieve_sample_images(da, image_keys)[source]#
Return type:

io.RawSampleImageStacks (scipp.DataArray)

previous

ess.imaging.io.retrieve_open_beam_images

next

ess.imaging.io.separate_detector_images

© Copyright 2024 Scipp contributors.

Created using Sphinx 8.0.2.

Current ESSimaging version: 24.9.0 (older versions).

Built with the PyData Sphinx Theme 0.15.4.