neutronpy.data.data.Data.subtract_background

Data.subtract_background(background_data, x=None, ret=True)

Subtract background data.

Parameters:

background_data : Data object

Data object containing the data wishing to be subtracted

x : str, optional

data_column key of x-axis values over which background should be subtracted. Used for cases where background data is not taken at exactly same points as data being subtracted. Default: None

ret : bool, optional

Set False if background should be subtracted in place. Default: True

Returns:

data : Data object

Data object contained subtracted data