def run(config, tim=None):
"""
This method is where the data reduction process gets done.
@param config: Object containing the data reduction configuration
information.
@type config: L{hlr_utils.Configure}
@param tim: (OPTIONAL) Object that will allow the method to perform
timing evaluations.
@type tim: C{sns_time.DiffTime}
"""
import dr_lib
import DST
if tim is not None:
tim.getTime(False)
old_time = tim.getOldTime()
if config.data is None:
raise RuntimeError("Need to pass a data filename to the driver "\
+"script.")
# Read in geometry if one is provided
if config.inst_geom is not None:
if config.verbose:
print "Reading in instrument geometry file"
inst_geom_dst = DST.getInstance("application/x-NxsGeom",
config.inst_geom)
else:
inst_geom_dst = None
# Perform Steps 1-11 on sample data
d_som1 = dr_lib.process_sas_data(config.data, config, timer=tim,
inst_geom_dst=inst_geom_dst,
bkg_subtract=config.bkg_coeff,
acc_down_time=config.data_acc_down_time.toValErrTuple(),
bkg_scale=config.bkg_scale,
trans_data=config.data_trans)
# Perform Steps 1-11 on buffer/solvent only data
if config.solv is not None:
s_som1 = dr_lib.process_sas_data(config.solv, config, timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type="solvent",
bkg_subtract=config.bkg_coeff,
acc_down_time=config.solv_acc_down_time.toValErrTuple(),
bkg_scale=config.bkg_scale,
trans_data=config.solv_trans)
else:
s_som1 = None
# Step 12: Subtract buffer/solvent only spectrum from sample spectrum
d_som2 = dr_lib.subtract_bkg_from_data(d_som1, s_som1,
verbose=config.verbose,
timer=tim,
dataset1="data",
dataset2="solvent")
del s_som1, d_som1
# Perform Steps 1-11 on empty-can data
if config.ecan is not None:
e_som1 = dr_lib.process_sas_data(config.ecan, config, timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type="empty_can",
bkg_subtract=config.bkg_coeff,
acc_down_time=config.ecan_acc_down_time.toValErrTuple(),
bkg_scale=config.bkg_scale,
trans_data=config.ecan_trans)
else:
e_som1 = None
# Step 13: Subtract empty-can spectrum from sample spectrum
d_som3 = dr_lib.subtract_bkg_from_data(d_som2, e_som1,
verbose=config.verbose,
timer=tim,
dataset1="data",
dataset2="empty_can")
del e_som1, d_som2
# Perform Steps 1-11 on open beam data
if config.open is not None:
o_som1 = dr_lib.process_sas_data(config.open, config, timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type="open_beam",
bkg_subtract=config.bkg_coeff,
acc_down_time=config.open_acc_down_time.toValErrTuple(),
bkg_scale=config.bkg_scale)
else:
o_som1 = None
# Step 14: Subtract open beam spectrum from sample spectrum
d_som4 = dr_lib.subtract_bkg_from_data(d_som3, o_som1,
verbose=config.verbose,
timer=tim,
dataset1="data",
dataset2="open_beam")
del o_som1, d_som3
# Perform Steps 1-11 on dark current data
if config.dkcur is not None:
dc_som1 = dr_lib.process_sas_data(config.open, config, timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type="dark_current",
bkg_subtract=config.bkg_coeff)
else:
dc_som1 = None
# Step 15: Subtract dark current spectrum from sample spectrum
d_som5 = dr_lib.subtract_bkg_from_data(d_som4, dc_som1,
verbose=config.verbose,
timer=tim,
dataset1="data",
dataset2="dark_current")
del dc_som1, d_som4
# Create 2D distributions is necessary
if config.dump_Q_r:
d_som5_1 = dr_lib.create_param_vs_Y(d_som5, "radius", "param_array",
config.r_bins.toNessiList(),
rebin_axis=config.Q_bins.toNessiList(),
binnorm=True,
y_label="S",
y_units="Counts / A^-1 m",
x_labels=["Radius", "Q"],
x_units=["m", "1/Angstroms"])
hlr_utils.write_file(config.output, "text/Dave2d", d_som5_1,
output_ext="qvr", verbose=config.verbose,
data_ext=config.ext_replacement,
path_replacement=config.path_replacement,
message="S(r, Q) information")
del d_som5_1
if config.dump_Q_theta:
d_som5_1 = dr_lib.create_param_vs_Y(d_som5, "polar", "param_array",
config.theta_bins.toNessiList(),
rebin_axis=config.Q_bins.toNessiList(),
binnorm=True,
y_label="S",
y_units="Counts / A^-1 rads",
x_labels=["Polar Angle", "Q"],
x_units=["rads", "1/Angstroms"])
hlr_utils.write_file(config.output, "text/Dave2d", d_som5_1,
output_ext="qvt", verbose=config.verbose,
data_ext=config.ext_replacement,
path_replacement=config.path_replacement,
message="S(theta, Q) information")
del d_som5_1
# Steps 16 and 17: Rebin and sum all spectra
if config.verbose:
print "Rebinning and summing for final spectrum"
if tim is not None:
tim.getTime(False)
if config.dump_frac_rebin:
set_conf = config
else:
set_conf = None
d_som6 = dr_lib.sum_by_rebin_frac(d_som5, config.Q_bins.toNessiList(),
configure=set_conf)
if tim is not None:
tim.getTime(msg="After rebinning and summing for spectrum")
del d_som5
if config.facility == "LENS":
# Step 18: Scale final spectrum by Q bin centers
if config.verbose:
print "Scaling final spectrum by Q centers"
if tim is not None:
tim.getTime(False)
d_som7 = dr_lib.fix_bin_contents(d_som6, scale=True, width=True,
units="1/Angstroms")
if tim is not None:
tim.getTime(msg="After scaling final spectrum")
else:
d_som7 = d_som6
del d_som6
# If rescaling factor present, rescale the data
if config.rescale_final is not None:
import common_lib
d_som8 = common_lib.mult_ncerr(d_som7, (config.rescale_final, 0.0))
else:
d_som8 = d_som7
del d_som7
hlr_utils.write_file(config.output, "text/Spec", d_som8,
verbose=config.verbose,
replace_path=False,
replace_ext=False,
message="combined S(Q) information")
# Create 1D canSAS file
hlr_utils.write_file(config.output, "text/canSAS", d_som8,
verbose=config.verbose,
output_ext="xml",
data_ext=config.ext_replacement,
path_replacement=config.path_replacement,
message="combined S(Q) information")
d_som8.attr_list["config"] = config
hlr_utils.write_file(config.output, "text/rmd", d_som8,
output_ext="rmd",
data_ext=config.ext_replacement,
path_replacement=config.path_replacement,
verbose=config.verbose,
message="metadata")
if tim is not None:
tim.setOldTime(old_time)
tim.getTime(msg="Total Running Time")
def run(config, tim=None):
"""
This method is where the data reduction process gets done.
@param config: Object containing the data reduction configuration
information.
@type config: L{hlr_utils.Configure}
@param tim: (OPTIONAL) Object that will allow the method to perform
timing evaluations.
@type tim: C{sns_time.DiffTime}
"""
import common_lib
import dr_lib
import DST
if tim is not None:
tim.getTime(False)
old_time = tim.getOldTime()
if config.data is None:
raise RuntimeError("Need to pass a data filename to the driver "\
+"script.")
# Read in geometry if one is provided
if config.inst_geom is not None:
if config.verbose:
print "Reading in instrument geometry file"
inst_geom_dst = DST.getInstance("application/x-NxsGeom",
config.inst_geom)
else:
inst_geom_dst = None
only_background = False
data_type = "transmission"
# Perform Steps 1,6-7 or 1,3,5-7 on sample data
d_som1 = dr_lib.process_sas_data(config.data, config, timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type=data_type,
transmission=True,
get_background=only_background)
# Perform Steps 1,6-7 on background data
if config.back is not None:
b_som1 = dr_lib.process_sas_data(config.back, config, timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type="trans_bkg",
transmission=True)
else:
b_som1 = None
# Put the datasets on the same axis
d_som2 = dr_lib.sum_by_rebin_frac(d_som1, config.lambda_bins.toNessiList())
del d_som1
if b_som1 is not None:
b_som2 = dr_lib.sum_by_rebin_frac(b_som1,
config.lambda_bins.toNessiList())
else:
b_som2 = None
del b_som1
# Divide the data spectrum by the background spectrum
if b_som2 is not None:
d_som3 = common_lib.div_ncerr(d_som2, b_som2)
else:
d_som3 = d_som2
del d_som2, b_som2
# Reset y units to dimensionless for the tranmission due to ratio
if config.back is not None:
d_som3.setYLabel("Ratio")
d_som3.setYUnits("")
write_message = "transmission spectrum"
else:
write_message = "spectrum for background estimation"
# Write out the transmission spectrum
hlr_utils.write_file(config.output, "text/Spec", d_som3,
verbose=config.verbose,
replace_path=False,
replace_ext=False,
message=write_message)
d_som3.attr_list["config"] = config
hlr_utils.write_file(config.output, "text/rmd", d_som3,
output_ext="rmd",
data_ext=config.ext_replacement,
path_replacement=config.path_replacement,
verbose=config.verbose,
message="metadata")
if tim is not None:
tim.setOldTime(old_time)
tim.getTime(msg="Total Running Time")
def run(config, tim=None):
"""
This method is where the data reduction process gets done.
@param config: Object containing the data reduction configuration
information.
@type config: L{hlr_utils.Configure}
@param tim: (OPTIONAL) Object that will allow the method to perform
timing evaluations.
@type tim: C{sns_time.DiffTime}
"""
import common_lib
import dr_lib
import DST
if tim is not None:
tim.getTime(False)
old_time = tim.getOldTime()
if config.data is None:
raise RuntimeError("Need to pass a data filename to the driver "\
+"script.")
# Read in geometry if one is provided
if config.inst_geom is not None:
if config.verbose:
print "Reading in instrument geometry file"
inst_geom_dst = DST.getInstance("application/x-NxsGeom",
config.inst_geom)
else:
inst_geom_dst = None
only_background = False
data_type = "transmission"
# Perform Steps 1,6-7 or 1,3,5-7 on sample data
d_som1 = dr_lib.process_sas_data(config.data,
config,
timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type=data_type,
transmission=True,
get_background=only_background)
# Perform Steps 1,6-7 on background data
if config.back is not None:
b_som1 = dr_lib.process_sas_data(config.back,
config,
timer=tim,
inst_geom_dst=inst_geom_dst,
dataset_type="trans_bkg",
transmission=True)
else:
b_som1 = None
# Put the datasets on the same axis
d_som2 = dr_lib.sum_by_rebin_frac(d_som1, config.lambda_bins.toNessiList())
del d_som1
if b_som1 is not None:
b_som2 = dr_lib.sum_by_rebin_frac(b_som1,
config.lambda_bins.toNessiList())
else:
b_som2 = None
del b_som1
# Divide the data spectrum by the background spectrum
if b_som2 is not None:
d_som3 = common_lib.div_ncerr(d_som2, b_som2)
else:
d_som3 = d_som2
del d_som2, b_som2
# Reset y units to dimensionless for the tranmission due to ratio
if config.back is not None:
d_som3.setYLabel("Ratio")
d_som3.setYUnits("")
write_message = "transmission spectrum"
else:
write_message = "spectrum for background estimation"
# Write out the transmission spectrum
hlr_utils.write_file(config.output,
"text/Spec",
d_som3,
verbose=config.verbose,
replace_path=False,
replace_ext=False,
message=write_message)
d_som3.attr_list["config"] = config
hlr_utils.write_file(config.output,
"text/rmd",
d_som3,
output_ext="rmd",
data_ext=config.ext_replacement,
path_replacement=config.path_replacement,
verbose=config.verbose,
message="metadata")
if tim is not None:
tim.setOldTime(old_time)
tim.getTime(msg="Total Running Time")