Contents Menu Expand Light mode Dark mode Auto light/dark mode
cbclib 0.7.2 documentation
Light Logo Dark Logo
  • Installation
  • cbclib API
    • Reading Kamzik log files
      • LogProtocol
      • LogContainer
    • Working with HDF5 files
      • CXIProtocol
      • CXIStore
    • Image transforms
      • Crop
      • Mirror
      • Downscale
    • Preprocessing and streak detection
      • CrystData
      • LSD
      • LSDetector
      • ModelDetector
    • CBD forward model
      • ScanSetup
      • Basis
      • Rotation
      • Sample
      • Streaks
      • CBDModel
    • Geometry refinement
      • CBCTable
      • FourierIndexer
      • SampleRefiner
      • SetupRefiner
      • ScanSamples
    • Intensity scaling
    • Low-level functions
      • FFTW
      • next_fast_len
      • fft_convolve
      • gaussian_filter
      • gaussian_gradient_magnitude
      • median
      • median_filter
      • maximum_filter
      • draw_line_image
      • draw_line_mask
      • draw_line_table
      • normalise_pattern
      • refine_pattern
      • subtract_background
      • project_effs
      • euler_angles
      • euler_matrix
      • tilt_angles
      • tilt_matrix
      • spherical_to_cartesian
      • cartesian_to_spherical
      • calc_source_lines
      • filter_hkl
      • ce_criterion
      • binterpolate
      • poisson_criterion
      • ls_criterion
      • kr_predict
      • kr_grid
      • unmerge_signal
    • Miscellaneous types
Back to top
Edit this page

subtract_background#

cbclib.bin.subtract_background(inp: numpy.ndarray, mask: numpy.ndarray, bgd: numpy.ndarray, num_threads: int = 1)[source]#

Subtract background from a set of 2D arrays inp.

Parameters
  • inp (numpy.ndarray) – A set of 2D arrays.

  • mask (numpy.ndarray) – A set of 2D masks.

  • bgd (numpy.ndarray) – A set of background arrays.

  • num_threads (int) – A number of threads used in the computations.

Returns

An output projection of eigen flat-fields.

Return type

numpy.ndarray

Next
project_effs
Previous
refine_pattern
Copyright © 2021, Nikolay Ivanov
Made with Sphinx and @pradyunsg's Furo