3.5

SetupHFIRReduction v1

../_images/SetupHFIRReduction-v1_dlg.png

SetupHFIRReduction dialog.

Table of Contents

Summary

Set up HFIR SANS reduction options.

Properties

Name Direction Type Default Description
SampleDetectorDistance Input number Optional Sample to detector distance to use (overrides meta data), in mm
SampleDetectorDistanceOffset Input number Optional Offset to the sample to detector distance (use only when using the distance found in the meta data), in mm
SolidAngleCorrection Input boolean True If true, the solid angle correction will be applied to the data
DetectorTubes Input boolean False If true, the solid angle correction for tube detectors will be applied
Wavelength Input number Optional Wavelength value to use when loading the data file (Angstrom).
WavelengthSpread Input number 0.1 Wavelength spread to use when loading the data file (default 0.0)
BeamCenterMethod Input string None Method for determining the data beam center. Allowed values: [‘None’, ‘Value’, ‘DirectBeam’, ‘Scattering’]
BeamCenterX Input number Optional Position of the beam center, in pixel
BeamCenterY Input number Optional Position of the beam center, in pixel
BeamCenterFile Input string   The name of the input data file to load. Allowed extensions: [‘.xml’]
BeamRadius Input number Optional Radius of the beam area used the exclude the beam when calculating the center of mass of the scattering pattern [pixels]. Default=3.0
Normalisation Input string Monitor Options for data normalisation. Allowed values: [‘None’, ‘Monitor’, ‘Timer’]
DarkCurrentFile Input string   The name of the input data file to load as dark current. Allowed extensions: [‘.xml’]
SensitivityFile Input string   Flood field or sensitivity file. Allowed extensions: [‘.xml’]
MinEfficiency Input number Optional Minimum efficiency for a pixel to be considered (default: no minimum).
MaxEfficiency Input number Optional Maximum efficiency for a pixel to be considered (default: no maximum).
UseDefaultDC Input boolean True If true, the dark current subtracted from the sample data will also be subtracted from the flood field.
SensitivityDarkCurrentFile Input string   The name of the input file to load as dark current. Allowed extensions: [‘.xml’]
SensitivityBeamCenterMethod Input string None Method for determining the sensitivity data beam center. Allowed values: [‘None’, ‘Value’, ‘DirectBeam’, ‘Scattering’]
SensitivityBeamCenterX Input number Optional Sensitivity beam center location in X [pixels]
SensitivityBeamCenterY Input number Optional Sensitivity beam center location in Y [pixels]
SensitivityBeamCenterFile Input string   The name of the input data file to load. Allowed extensions: [‘.xml’]
SensitivityBeamCenterRadius Input number Optional Radius of the beam area used the exclude the beam when calculating the center of mass of the scattering pattern [pixels]. Default=3.0
OutputSensitivityWorkspace Output MatrixWorkspace    
TransmissionMethod Input string Value Transmission determination method. Allowed values: [‘Value’, ‘DirectBeam’, ‘BeamSpreader’]
TransmissionValue Input number Optional Transmission value.
TransmissionError Input number Optional Transmission error.
TransmissionBeamRadius Input number 3 Radius of the beam area used to compute the transmission [pixels]
TransmissionSampleDataFile Input string   Sample data file for transmission calculation. Allowed extensions: [‘.xml’]
TransmissionEmptyDataFile Input string   Empty data file for transmission calculation. Allowed extensions: [‘.xml’]
TransmissionBeamCenterMethod Input string None Method for determining the transmission data beam center. Allowed values: [‘None’, ‘Value’, ‘DirectBeam’, ‘Scattering’]
TransmissionBeamCenterX Input number Optional Transmission beam center location in X [pixels]
TransmissionBeamCenterY Input number Optional Transmission beam center location in Y [pixels]
TransmissionBeamCenterFile Input string   The name of the input data file to load. Allowed extensions: [‘.xml’]
TransSampleSpreaderFilename Input string   Allowed extensions: [‘.xml’]
TransDirectSpreaderFilename Input string   Allowed extensions: [‘.xml’]
TransSampleScatteringFilename Input string   Allowed extensions: [‘.xml’]
TransDirectScatteringFilename Input string   Allowed extensions: [‘.xml’]
SpreaderTransmissionValue Input number 1 Beam spreader transmission value
SpreaderTransmissionError Input number 0 Beam spreader transmission error
TransmissionDarkCurrentFile Input string   The name of the input data file to load as transmission dark current. Allowed extensions: [‘.xml’]
TransmissionUseSampleDC Input boolean True If true, the sample dark current will be used IF a dark current file isnot set.
ThetaDependentTransmission Input boolean True If true, a theta-dependent transmission correction will be applied.
BackgroundFiles Input string   Background data files
BckTransmissionMethod Input string Value Transmission determination method. Allowed values: [‘Value’, ‘DirectBeam’, ‘BeamSpreader’]
BckTransmissionValue Input number Optional Transmission value.
BckTransmissionError Input number Optional Transmission error.
BckTransmissionBeamRadius Input number 3 Radius of the beam area used to compute the transmission [pixels]
BckTransmissionSampleDataFile Input string   Sample data file for transmission calculation. Allowed extensions: [‘.xml’]
BckTransmissionEmptyDataFile Input string   Empty data file for transmission calculation. Allowed extensions: [‘.xml’]
BckTransmissionBeamCenterMethod Input string None Method for determining the transmission data beam center. Allowed values: [‘None’, ‘Value’, ‘DirectBeam’, ‘Scattering’]
BckTransmissionBeamCenterX Input number Optional Transmission beam center location in X [pixels]
BckTransmissionBeamCenterY Input number Optional Transmission beam center location in Y [pixels]
BckTransmissionBeamCenterFile Input string   The name of the input data file to load. Allowed extensions: [‘.xml’]
BckTransSampleSpreaderFilename Input string   Allowed extensions: [‘.xml’]
BckTransDirectSpreaderFilename Input string   Allowed extensions: [‘.xml’]
BckTransSampleScatteringFilename Input string   Allowed extensions: [‘.xml’]
BckTransDirectScatteringFilename Input string   Allowed extensions: [‘.xml’]
BckSpreaderTransmissionValue Input number 1 Beam spreader transmission value
BckSpreaderTransmissionError Input number 0 Beam spreader transmission error
BckTransmissionDarkCurrentFile Input string   The name of the input data file to load as background transmission dark current. Allowed extensions: [‘.xml’]
BckThetaDependentTransmission Input boolean True If true, a theta-dependent transmission correction will be applied.
SampleThickness Input number Optional Sample thickness [cm]
MaskedDetectorList Input int list   List of detector IDs to be masked
MaskedEdges Input int list   Number of pixels to mask on the edges: X-low, X-high, Y-low, Y-high
MaskedSide Input string None Mask one side of the detector. Allowed values: [‘None’, ‘Front’, ‘Back’]
AbsoluteScaleMethod Input string None Absolute scale correction method. Allowed values: [‘None’, ‘Value’, ‘ReferenceData’]
AbsoluteScalingFactor Input number 1 Absolute scaling factor
AbsoluteScalingReferenceFilename Input string   Allowed extensions: [‘.xml’]
AbsoluteScalingBeamDiameter Input number 0 Beamstop diameter for computing the absolute scale factor [mm]. Read from file if not supplied.
AbsoluteScalingAttenuatorTrans Input number 1 Attenuator transmission value for computing the absolute scale factor
AbsoluteScalingApplySensitivity Input boolean False Apply sensitivity correction to the reference data when computing the absolute scale factor
DoAzimuthalAverage Input boolean True  
IQBinning Input dbl list    
IQNumberOfBins Input number 100 Number of I(q) bins when binning is not specified.
IQLogBinning Input boolean False I(q) log binning when binning is not specified.
IQAlignLogWithDecades Input boolean False If true and log binning was selected, the bins will be aligned to log decades and the number of bins will be used as the number of bins per decade.
NumberOfSubpixels Input number 1 Number of sub-pixels used for each detector pixel in each direction.The total number of sub-pixels will be NPixelDivision*NPixelDivision.
ErrorWeighting Input boolean False Choose whether each pixel contribution will be weighted by 1/error^2.
NumberOfWedges Input number 2 Number of wedges to calculate.
WedgeAngle Input number 30 Opening angle of each wedge, in degrees.
WedgeOffset Input number 0 Angular offset for the wedges, in degrees.
Do2DReduction Input boolean True  
IQ2DNumberOfBins Input number 100 Number of I(qx,qy) bins.
ProcessInfo Input string   Additional process information
OutputDirectory Input string   Directory to put the output files in
OutputMessage Output string    
ReductionProperties Input string __sans_reduction_properties  

Description

Create a PropertyManager object setting the reduction options for HFIR SANS. The property manager object is then added to the PropertyManagerDataService.

See HFIRSANSReduction for details.

Categories: Algorithms | Workflow | SANS