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

Section Navigation

  • ess.sans.providers
  • ess.sans.with_background_runs
  • ess.sans.with_banks
  • ess.sans.with_pixel_mask_filenames
  • ess.sans.with_sample_runs
  • ess.sans.beam_center_finder
    • ess.sans.beam_center_finder.beam_center_from_center_of_mass
    • ess.sans.beam_center_finder.beam_center_from_iofq
  • ess.sans.common
    • ess.sans.common.beam_center_to_detector_position_offset
    • ess.sans.common.gravity_vector
    • ess.sans.common.mask_range
  • ess.sans.conversions
    • ess.sans.conversions.Qxy
    • ess.sans.conversions.compute_Q
    • ess.sans.conversions.compute_Qxy
    • ess.sans.conversions.cyl_unit_vectors
    • ess.sans.conversions.cylindrical_x
    • ess.sans.conversions.cylindrical_y
    • ess.sans.conversions.detector_to_wavelength
    • ess.sans.conversions.mask_and_scale_wavelength_q
    • ess.sans.conversions.mask_and_scale_wavelength_qxy
    • ess.sans.conversions.mask_wavelength_q
    • ess.sans.conversions.mask_wavelength_qxy
    • ess.sans.conversions.monitor_to_wavelength
    • ess.sans.conversions.phi_no_gravity
    • ess.sans.conversions.sans_elastic
    • ess.sans.conversions.sans_monitor
  • ess.sans.normalization
    • ess.sans.normalization.mask_solid_angle
    • ess.sans.normalization.norm_detector_term
    • ess.sans.normalization.norm_monitor_term
    • ess.sans.normalization.normalize_q
    • ess.sans.normalization.normalize_qxy
    • ess.sans.normalization.process_wavelength_bands
    • ess.sans.normalization.reduce_q
    • ess.sans.normalization.reduce_qxy
    • ess.sans.normalization.solid_angle
    • ess.sans.normalization.transmission_fraction
  • ess.sans.data
    • ess.sans.data.Registry
  • ess.sans.direct_beam
  • ess.sans.i_of_q
    • ess.sans.i_of_q.bin_in_q
    • ess.sans.i_of_q.bin_in_qxy
    • ess.sans.i_of_q.preprocess_monitor_data
    • ess.sans.i_of_q.resample_direct_beam
    • ess.sans.i_of_q.subtract_background
    • ess.sans.i_of_q.subtract_background_xy
  • ess.sans.io
    • ess.sans.io.read_xml_detector_masking
    • ess.sans.io.save_background_subtracted_iofq
  • ess.sans.logging
    • ess.sans.logging.configure
    • ess.sans.logging.configure_workflow
    • ess.sans.logging.default_loggers_to_configure
    • ess.sans.logging.get_logger
    • ess.sans.logging.greet
    • ess.sans.logging.log_call
    • ess.sans.logging.Formatter
  • ess.sans.types
    • ess.sans.types.Numerator
    • ess.sans.types.Denominator
    • ess.sans.types.IofQPart
    • ess.sans.types.PixelShapePath
    • ess.sans.types.TransformationPath
    • ess.sans.types.ReturnEvents
    • ess.sans.types.WavelengthBins
    • ess.sans.types.WavelengthBands
    • ess.sans.types.ProcessedWavelengthBands
    • ess.sans.types.QBins
    • ess.sans.types.QxBins
    • ess.sans.types.QyBins
    • ess.sans.types.NonBackgroundWavelengthRange
    • ess.sans.types.DirectBeamFilename
    • ess.sans.types.BeamCenter
    • ess.sans.types.WavelengthMask
    • ess.sans.types.CorrectForGravity
    • ess.sans.types.DimsToKeep
    • ess.sans.types.OutFilename
    • ess.sans.types.DetectorIDs
    • ess.sans.types.MaskedDetectorIDs
    • ess.sans.types.DetectorMasks
    • ess.sans.types.DirectBeam
    • ess.sans.types.CleanDirectBeam
    • ess.sans.types.BackgroundSubtractedIofQ
    • ess.sans.types.BackgroundSubtractedIofQxy
    • ess.sans.types.RunTitle
    • ess.sans.types.RunNumber
    • ess.sans.types.CleanMonitor
    • ess.sans.types.CleanQ
    • ess.sans.types.CleanQxy
    • ess.sans.types.CleanSummedQ
    • ess.sans.types.CleanSummedQxy
    • ess.sans.types.CleanWavelength
    • ess.sans.types.DetectorPixelShape
    • ess.sans.types.IofQ
    • ess.sans.types.IofQxy
    • ess.sans.types.MaskedData
    • ess.sans.types.MaskedSolidAngle
    • ess.sans.types.MonitorTerm
    • ess.sans.types.ReducedQ
    • ess.sans.types.ReducedQxy
    • ess.sans.types.SolidAngle
    • ess.sans.types.TofData
    • ess.sans.types.TofMonitor
    • ess.sans.types.TransmissionFraction
    • ess.sans.types.WavelengthMonitor
    • ess.sans.types.WavelengthScaledQ
    • ess.sans.types.WavelengthScaledQxy
  • ess.loki.data
    • ess.loki.data.loki_tutorial_agbeh_sample_run
    • ess.loki.data.loki_tutorial_agbeh_transmission_run
    • ess.loki.data.loki_tutorial_background_run_60248
    • ess.loki.data.loki_tutorial_background_run_60393
    • ess.loki.data.loki_tutorial_deut_sds_sample_run
    • ess.loki.data.loki_tutorial_deut_sds_transmission_run
    • ess.loki.data.loki_tutorial_direct_beam_all_pixels
    • ess.loki.data.loki_tutorial_isis_polymer_sample_run
    • ess.loki.data.loki_tutorial_isis_polymer_transmission_run
    • ess.loki.data.loki_tutorial_mask_filenames
    • ess.loki.data.loki_tutorial_poly_gauss_I0
    • ess.loki.data.loki_tutorial_porous_silica_sample_run
    • ess.loki.data.loki_tutorial_porous_silica_transmission_run
    • ess.loki.data.loki_tutorial_run_60392
    • ess.loki.data.loki_tutorial_sample_run_60250
    • ess.loki.data.loki_tutorial_sample_run_60339
    • ess.loki.data.loki_tutorial_sample_transmission_run
  • ess.loki.general
    • ess.loki.general.LokiAtLarmorTutorialWorkflow
    • ess.loki.general.LokiAtLarmorWorkflow
    • ess.loki.general.data_to_tof
    • ess.loki.general.default_parameters
    • ess.loki.general.detector_pixel_shape
    • ess.loki.general.load_direct_beam
    • ess.loki.general.monitor_to_tof
  • ess.loki.LokiAtLarmorWorkflow
  • ess.isissans.data
    • ess.isissans.data.sans2d_solid_angle_reference
    • ess.isissans.data.sans2d_tutorial_background_run
    • ess.isissans.data.sans2d_tutorial_direct_beam
    • ess.isissans.data.sans2d_tutorial_empty_beam_run
    • ess.isissans.data.sans2d_tutorial_sample_run
    • ess.isissans.data.zoom_tutorial_calibration
    • ess.isissans.data.zoom_tutorial_direct_beam
    • ess.isissans.data.zoom_tutorial_empty_beam_run
    • ess.isissans.data.zoom_tutorial_mask_filenames
    • ess.isissans.data.zoom_tutorial_sample_run
  • ess.isissans.general
    • ess.isissans.general.data_to_tof
    • ess.isissans.general.default_parameters
    • ess.isissans.general.dummy_assemble_detector_data
    • ess.isissans.general.dummy_assemble_monitor_data
    • ess.isissans.general.get_calibrated_isis_detector
    • ess.isissans.general.get_detector_data
    • ess.isissans.general.get_detector_ids_from_sample_run
    • ess.isissans.general.get_monitor_data
    • ess.isissans.general.get_sample_position
    • ess.isissans.general.get_source_position
    • ess.isissans.general.helium3_tube_detector_pixel_shape
    • ess.isissans.general.lab_frame_transform
    • ess.isissans.general.monitor_to_tof
    • ess.isissans.general.run_number
    • ess.isissans.general.run_title
    • ess.isissans.general.to_detector_position_offset
    • ess.isissans.general.to_monitor_position_offset
    • ess.isissans.general.MonitorOffset
  • ess.isissans.io
    • ess.isissans.io.load_tutorial_direct_beam
    • ess.isissans.io.load_tutorial_run
    • ess.isissans.io.transmission_from_background_run
    • ess.isissans.io.transmission_from_sample_run
    • ess.isissans.io.LoadedFileContents
  • ess.isissans.mantidio
    • ess.isissans.mantidio.Period
    • ess.isissans.mantidio.from_data_workspace
    • ess.isissans.mantidio.load_calibration
    • ess.isissans.mantidio.load_direct_beam
    • ess.isissans.mantidio.load_run
    • ess.isissans.mantidio.DataWorkspace
  • ess.isissans.sans2d
    • ess.isissans.sans2d.DetectorEdgeMask
    • ess.isissans.sans2d.LowCountThreshold
    • ess.isissans.sans2d.SampleHolderMask
    • ess.isissans.sans2d.Sans2dTutorialWorkflow
    • ess.isissans.sans2d.Sans2dWorkflow
    • ess.isissans.sans2d.detector_edge_mask
    • ess.isissans.sans2d.sample_holder_mask
    • ess.isissans.sans2d.to_detector_masks
  • ess.isissans.visualization
    • ess.isissans.visualization.plot_flat_detector_xy
  • ess.isissans.zoom
    • ess.isissans.zoom.ZoomTutorialWorkflow
    • ess.isissans.zoom.ZoomWorkflow
    • ess.isissans.zoom.set_mantid_log_level
On this page
  • subtract_background()
Show Source
  • API Reference
  • ess.sans.i_of_q
  • ess.sans.i_o...

ess.sans.i_of_q.subtract_background#

ess.sans.i_of_q.subtract_background(sample, background, return_events)[source]#
Return type:

types.BackgroundSubtractedIofQ (scipp.DataArray)

previous

ess.sans.i_of_q.resample_direct_beam

next

ess.sans.i_of_q.subtract_background_xy

© Copyright 2024 Scipp contributors.

Created using Sphinx 8.1.0.

Current ESSsans version: 24.10.1 (older versions).

Built with the PyData Sphinx Theme 0.15.4.