Reduction Parameters¶
Default Values¶
BIOSANS¶
{
"schemaStamp": "2020-04-15T21:09:52.745905",
"instrumentName": "BIOSANS",
"iptsNumber": None,
"dataDirectories": None,
"sample": {
"runNumber": None,
"thickness": 1.0,
"transmission": {
"runNumber": None,
"value": None
}
},
"background": {
"runNumber": None,
"transmission": {
"runNumber": None,
"value": None
}
},
"emptyTransmission": {
"runNumber": None,
"value": None
},
"beamCenter": {
"runNumber": None
},
"outputFileName": None,
"configuration": {
"outputDir": None,
"wavelength": None,
"wavelengthSpread": None,
"useTimeSlice": False,
"useTimeSliceTransmission": False,
"timeSliceInterval": None,
"useLogSlice": False,
"logSliceName": None,
"logSliceInterval": None,
"sampleOffset": None,
"sampleApertureSize": None,
"sampleDetectorDistance": None,
"sampleToSi": None,
"sourceApertureDiameter": None,
"usePixelCalibration": False,
"maskFileName": None,
"useDefaultMask": True,
"defaultMask": [
{
"Pixel": "1-18,239-256"
},
{
"Bank": "18-24,42-48"
}
],
"useMaskBackTubes": False,
"darkMainFileName": None,
"darkWingFileName": None,
"darkMidrangeFileName": None,
"normalization": "Monitor",
"normalizationResortToTime": False,
"sensitivityMainFileName": None,
"sensitivityWingFileName": None,
"sensitivityMidrangeFileName": None,
"useSolidAngleCorrection": True,
"blockedBeamRunNumber": None,
"useThetaDepTransCorrection": True,
"DBScalingBeamRadius": 40.0,
"mmRadiusForTransmission": None,
"absoluteScaleMethod": "standard",
"StandardAbsoluteScale": 2.17e-10,
"numMainQxQyBins": None,
"numWingQxQyBins": None,
"numMidrangeQxQyBins": None,
"1DQbinType": "wedge",
"QbinType": None,
"numMainQBins": None,
"numWingQBins": None,
"numMidrangeQBins": None,
"LogQBinsPerDecadeMain": None,
"LogQBinsPerDecadeWing": None,
"LogQBinsPerDecadeMidrange": None,
"useLogQBinsDecadeCenter": False,
"useLogQBinsEvenDecade": False,
"WedgeMinAngles": [
-45,
165
],
"WedgeMaxAngles": [
45,
190
],
"autoWedgeQmin": 0.003,
"autoWedgeQmax": 0.04,
"autoWedgeQdelta": 0.01,
"autoWedgeAzimuthalDelta": 1.0,
"autoWedgePeakWidth": 0.25,
"autoWedgeBackgroundWidth": 1.5,
"autoWedgeSignalToNoiseMin": 2.0,
"AnnularAngleBin": 1,
"useErrorWeighting": False,
"smearingPixelSizeX": None,
"smearingPixelSizeY": None,
"useSubpixels": False,
"subpixelsX": None,
"subpixelsY": None,
"QminMain": 0.02,
"QmaxMain": 0.125,
"QminWing": 0.06,
"QmaxWing": 1.0,
"QminMidrange": 0.06,
"QmaxMidrange": 1.0,
"overlapStitchIgnoreMidrange": False,
"overlapStitchQmin": None,
"overlapStitchQmax": None,
"wedge1QminMain": 0.02,
"wedge1QmaxMain": 0.09,
"wedge1QminWing": 0.08,
"wedge1QmaxWing": 0.09,
"wedge1QminMidrange": 0.08,
"wedge1QmaxMidrange": 0.09,
"wedge1overlapStitchQmin": None,
"wedge1overlapStitchQmax": None,
"wedge2QminMain": 0.02,
"wedge2QmaxMain": 0.125,
"wedge2QminWing": 0.06,
"wedge2QmaxWing": 1.0,
"wedge2QminMidrange": 0.06,
"wedge2QmaxMidrange": 1.0,
"wedge2overlapStitchQmin": None,
"wedge2overlapStitchQmax": None
}
}
EQSANS¶
{
"schemaStamp": "2020-04-15T21:09:52.745905",
"instrumentName": "EQSANS",
"iptsNumber": None,
"dataDirectories": None,
"sample": {
"runNumber": None,
"thickness": 1.0,
"transmission": {
"runNumber": None,
"value": None
}
},
"background": {
"runNumber": None,
"transmission": {
"runNumber": None,
"value": None
}
},
"emptyTransmission": {
"runNumber": None,
"value": None
},
"beamCenter": {
"runNumber": None
},
"outputFileName": None,
"configuration": {
"outputDir": None,
"instrumentConfigurationDir": "/SNS/EQSANS/shared/instrument_configurat"
"ion",
"useTimeSlice": False,
"timeSliceInterval": 300,
"timeSliceOffset": 0.0,
"timeSlicePeriod": None,
"useLogSlice": False,
"logSliceName": None,
"logSliceInterval": 10,
"cutTOFmin": 500.0,
"cutTOFmax": 2000.0,
"wavelengthStep": 0.1,
"wavelengthStepType": "constant Delta lambda",
"sampleOffset": 314.5,
"useDetectorOffset": True,
"detectorOffset": 80,
"sampleApertureSize": None,
"sourceApertureDiameter": None,
"usePixelCalibration": False,
"maskFileName": None,
"useDefaultMask": True,
"defaultMask": None,
"useMaskBackTubes": False,
"darkFileName": None,
"normalization": "Total charge",
"fluxMonitorRatioFile": None,
"beamFluxFileName": "/SNS/EQSANS/shared/instrument_configuration/bl6_fl"
"ux_at_sample",
"sensitivityFileName": None,
"useSolidAngleCorrection": True,
"useThetaDepTransCorrection": True,
"mmRadiusForTransmission": 25,
"absoluteScaleMethod": "standard",
"StandardAbsoluteScale": 1.0,
"numQxQyBins": 80,
"1DQbinType": "scalar",
"QbinType": "log",
"numQBins": None,
"LogQBinsPerDecade": None,
"useLogQBinsDecadeCenter": False,
"useLogQBinsEvenDecade": False,
"WedgeMinAngles": None,
"WedgeMaxAngles": None,
"autoWedgeQmin": 0.003,
"autoWedgeQmax": 0.04,
"autoWedgeQdelta": 0.01,
"autoWedgeAzimuthalDelta": 1.0,
"autoWedgePeakWidth": 0.25,
"autoWedgeBackgroundWidth": 1.5,
"autoWedgeSignalToNoiseMin": 2.0,
"AnnularAngleBin": 1.0,
"Qmin": None,
"Qmax": None,
"useErrorWeighting": False,
"smearingPixelSizeX": 0.011,
"smearingPixelSizeY": 0.007,
"useSubpixels": False,
"subpixelsX": None,
"subpixelsY": None,
"useSliceIDxAsSuffix": False,
"fitInelasticIncoh": False,
"incohfit_intensityweighted": False,
"incohfit_qmin": None,
"incohfit_qmax": None,
"incohfit_factor": None,
"outputWavelengthDependentProfile": False,
"elasticReference": {
"runNumber": None,
"thickness": 1.0,
"transmission": {
"runNumber": None,
"value": None
}
},
"elasticReferenceBkgd": {
"runNumber": None,
"transmission": {
"runNumber": None,
"value": None
}
},
"selectMinIncoh": False
}
}
GPSANS¶
{
"schemaStamp": "2020-04-15T21:09:52.745905",
"instrumentName": "GPSANS",
"iptsNumber": None,
"dataDirectories": None,
"sample": {
"runNumber": None,
"thickness": None,
"transmission": {
"runNumber": None,
"value": None
}
},
"background": {
"runNumber": None,
"transmission": {
"runNumber": None,
"value": None
}
},
"emptyTransmission": {
"runNumber": None,
"value": None
},
"beamCenter": {
"runNumber": None
},
"outputFileName": None,
"configuration": {
"outputDir": None,
"wavelength": None,
"wavelengthSpread": None,
"useTimeSlice": False,
"timeSliceInterval": 300,
"timeSliceOffset": 0.0,
"timeSlicePeriod": None,
"useLogSlice": False,
"logSliceName": None,
"logSliceInterval": None,
"sampleOffset": None,
"useDetectorOffset": True,
"detectorOffset": 0.0,
"sampleDetectorDistance": None,
"sampleToSi": None,
"sampleApertureSize": None,
"sourceApertureDiameter": None,
"usePixelCalibration": False,
"maskFileName": None,
"useDefaultMask": True,
"defaultMask": [
{
"Pixel": "1-10,247-256"
}
],
"useMaskBackTubes": False,
"darkFileName": None,
"normalization": "Monitor",
"normalizationResortToTime": False,
"sensitivityFileName": None,
"useSolidAngleCorrection": True,
"blockedBeamRunNumber": None,
"useThetaDepTransCorrection": True,
"DBScalingBeamRadius": None,
"mmRadiusForTransmission": None,
"absoluteScaleMethod": "direct_beam",
"StandardAbsoluteScale": 1.0,
"numQxQyBins": None,
"1DQbinType": "scalar",
"QbinType": "log",
"numQBins": None,
"LogQBinsPerDecade": None,
"useLogQBinsDecadeCenter": False,
"useLogQBinsEvenDecade": True,
"WedgeMinAngles": None,
"WedgeMaxAngles": None,
"autoWedgeQmin": 0.003,
"autoWedgeQmax": 0.04,
"autoWedgeQdelta": 0.01,
"autoWedgeAzimuthalDelta": 1.0,
"autoWedgePeakWidth": 0.25,
"autoWedgeBackgroundWidth": 1.5,
"autoWedgeSignalToNoiseMin": 2.0,
"autoWedgePeakSearchWindowSizeFactor": 0.6,
"AnnularAngleBin": 1.0,
"Qmin": None,
"Qmax": None,
"useErrorWeighting": False,
"smearingPixelSizeX": None,
"smearingPixelSizeY": None,
"useSubpixels": True,
"subpixelsX": 5,
"subpixelsY": 5
}
}
Descriptions¶
BIOSANS¶
{
"schemaStamp": "schema version as a time stamp in ISO 8601 format (YYYY-M"
"M-DDThh:mm:ssZ), in UTC time",
"instrumentName": "BIOSANS",
"iptsNumber": "The IPTS number for the data files. The path to datafiles "
"will be /SNS/EQSANS/IPTS-{iptsNumber}/nexus",
"dataDirectories": "Directories where to find events or histogram files",
"sample": {
"runNumber": "The run number(s) for the sample. More than one run numbe"
"r can be specified by passing a list or by passing a string containing the "
"run numbers separated by commas.",
"thickness": "The sample thickness in cm",
"transmission": {
"runNumber": "The run number(s) for the transmission sample. More tha"
"n one run number can be specified by passing a list or by passing a string "
"containing the run numbers separated by commas.",
"value": None
}
},
"background": {
"runNumber": "The run number(s) for the background run. More than one r"
"un number can be specified by passing a list or by passing a string contain"
"ing the run numbers separated by commas.",
"transmission": {
"runNumber": "The run number(s) for the transmission of the backgroun"
"d. The filename will be INSTRUMENTNAME_{runNumber}.nxs.h5",
"value": None
}
},
"emptyTransmission": {
"runNumber": "The run number(s) for the empty beam, used for transmissi"
"on calculation as a reference. More than one run number can be specified by"
" passing a list or by passing a string containing the run numbers separated"
" by commas.",
"value": None
},
"beamCenter": {
"runNumber": "The run number(s) for the beam center calculation. More t"
"han one run number can be specified by passing a list or by passing a strin"
"g containing the run numbers separated by commas."
},
"outputFileName": "The prefix for all output filenames, such as {outputFi"
"leName}_Iqxqy.png. It cannot be left empty.",
"configuration": {
"outputDir": "Output folder",
"wavelength": "Wave length in Angstrom",
"wavelengthSpread": "Wave length spread in Angstrom. `wavelength` must"
" be specified too",
"useTimeSlice": "Indicate whether the data should be processed as time "
"slices (incompatible with sample log slicing)",
"useTimeSliceTransmission": "Indicate whether the data should be proces"
"sed as time slices (incompatible with sample log slicing)",
"timeSliceInterval": "Interval for time slicing, in seconds",
"useLogSlice": "Indicate whether the data should be processed as sample"
" log slices (incompatible with time slicing)",
"logSliceName": "Sample log name for slicing",
"logSliceInterval": "Sample log interval for slicing",
"sampleOffset": "Sample offset in mm",
"sampleApertureSize": "Sample aperture diameter (mm)",
"sampleDetectorDistance": "Distance between the sample and the detector"
" array in mm",
"sampleToSi": None,
"sourceApertureDiameter": "Source aperture diameter (mm)",
"usePixelCalibration": "Flag to apply the barscan and tube-width calibr"
"ations",
"maskFileName": "Path to a saved file containing mask",
"useDefaultMask": "flag to use a mask that is run number dependent (sto"
"red in a database)",
"defaultMask": "mask as optional arguments to be passed on to function "
"drtsans.mask_utils.apply_mask()",
"useMaskBackTubes": "Flag whether to mask the tubes in the back",
"darkMainFileName": "Path to the dark measurement file",
"darkWingFileName": "Path to the dark measurement file",
"darkMidrangeFileName": "Path to the dark measurement file",
"normalization": "Normalization type. Allowed values 'Total charge', 'T"
"ime', 'Monitor'",
"normalizationResortToTime": "Carry out Time normalization if Monitor w"
"as selected but no monitor counts are found",
"sensitivityMainFileName": "Path to sensitivity measurement file",
"sensitivityWingFileName": "Path to sensitivity measurement file",
"sensitivityMidrangeFileName": "Path to sensitivity measurement file",
"useSolidAngleCorrection": "Flag whether to apply solid angle correctio"
"n",
"blockedBeamRunNumber": "Run number for the blocked beam run. More than"
" one run number can be specified by passing a list or by passing a string c"
"ontaining the run numbers separated by commas.",
"useThetaDepTransCorrection": "Flag whether to calculate a theta depend"
"ent transmission",
"DBScalingBeamRadius": "",
"mmRadiusForTransmission": "Integration radius (in mm) to be used for t"
"ransmission calculation",
"absoluteScaleMethod": "Absolute scaling method. Only 'standard' (multi"
"ply by a constant) is implemented for EQSANS",
"StandardAbsoluteScale": "Multiplicative scaling factor to transform in"
"tensity to absolute scale",
"numMainQxQyBins": "Number of bins in the x and y direction for 2D binn"
"ing",
"numWingQxQyBins": "Number of bins in the x and y direction for 2D binn"
"ing",
"numMidrangeQxQyBins": "Number of bins in the x and y direction for 2D "
"binning",
"1DQbinType": "Options for 1D binning: |Q|, azimuthal angle, or |Q| for"
" a particular wedge",
"QbinType": "1D binning type for scalar or wedge modes ('linear' or 'lo"
"g'). If 'linear' is selected, then 'numQbins' must be specified. If 'log' i"
"s selected, then either 'numQbins' or 'LogQBinsPerDecade' must be specified"
".",
"numMainQBins": "Number of 1D bins for scalar and wedge modes. If log b"
"inning is selected, then exactly one of numQBins and LogQBinsPerDecade must"
" be specified",
"numWingQBins": "Number of 1D bins for scalar and wedge modes. If log b"
"inning is selected, then exactly one of numQBins and LogQBinsPerDecade must"
" be specified",
"numMidrangeQBins": "Number of 1D bins for scalar and wedge modes. If l"
"og binning is selected, then exactly one of numQBins and LogQBinsPerDecade "
"must be specified",
"LogQBinsPerDecadeMain": "Number of 1D bins for scalar and wedge modes "
"in every decade (in logarithmic mode only). If log binning is selected, the"
"n exactly one of numQBins and LogQBinsPerDecade must be specified",
"LogQBinsPerDecadeWing": "Number of 1D bins for scalar and wedge modes "
"in every decade (in logarithmic mode only). If log binning is selected, the"
"n exactly one of numQBins and LogQBinsPerDecade must be specified",
"LogQBinsPerDecadeMidrange": "Number of 1D bins for scalar and wedge mo"
"des in every decade (in logarithmic mode only). If log binning is selected,"
" then exactly one of numQBins and LogQBinsPerDecade must be specified",
"useLogQBinsDecadeCenter": "Flag to specify that the min max |Q| is on"
" a bin center; Otherwise, they will be on bin boundary",
"useLogQBinsEvenDecade": "If true, the logarithmic binning is extended "
"such that it starts and ends on some power of 10",
"WedgeMinAngles": "Minimum angles for the wedges, from -90 to 270",
"WedgeMaxAngles": "Maximum angles for the wedges, from -90 to 270",
"autoWedgeQmin": "Minimum Q for automatic wedge fitting",
"autoWedgeQmax": "Maximum Q for automatic wedge fitting",
"autoWedgeQdelta": "Q step for automatic wedge fitting",
"autoWedgeAzimuthalDelta": "Azimuthal angle step for automatic wedge fi"
"tting",
"autoWedgePeakWidth": "Percent of full-width-half-max (FWHM) of the pea"
"k in automatic wedge fitting.",
"autoWedgeBackgroundWidth": "Percent of full-width-half-max (FWHM) of t"
"he background in automatic wedge fitting.",
"autoWedgeSignalToNoiseMin": "Minimum signal to noise ratio for the dat"
"a to be considered fittable in automatic wedge detection",
"AnnularAngleBin": "Angle bin size in degrees for annular binning",
"useErrorWeighting": "Flag whether to use error weighting of intensitie"
"s when calculating resolution in Q",
"smearingPixelSizeX": "Override nominal pixel width when calculating re"
"solution in Q",
"smearingPixelSizeY": "Override nominal pixel height when calculating r"
"esolution in Q",
"useSubpixels": "boolean flag for stating whether or not the data pixel"
"s are to be subdivided. Used for data rebinning in momentum transfer.",
"subpixelsX": "Divide pixel width an integer number of times when calcu"
"lating resolution in Q",
"subpixelsY": "Divide pixel heights width an integer number of times wh"
"en calculating resolution in Q",
"QminMain": "The minimum |Q| value for scalar, wedge, or annular binnin"
"g in the main detector",
"QmaxMain": "The maximum |Q| value for scalar, wedge, or annular binnin"
"g in the main detector",
"QminWing": "The minimum |Q| value for scalar, wedge, or annular binnin"
"g in the wing detector",
"QmaxWing": "The maximum |Q| value for scalar, wedge, or annular binnin"
"g in the wing detector",
"QminMidrange": "The minimum |Q| value for scalar, wedge, or annular bi"
"nning in the midrange detector",
"QmaxMidrange": "The maximum |Q| value for scalar, wedge, or annular bi"
"nning in the midrange detector",
"overlapStitchIgnoreMidrange": "If True, the combined I(q) will ignore "
"any data from the midrange detector and stitch the main detector to the win"
"g detector.",
"overlapStitchQmin": "The minimum |Q| value in the region(s) where inte"
"nsities for detectors overlap. Allowed overlaps are main with wing, main wi"
"th midrange, and midrange with wing detector.",
"overlapStitchQmax": "The maximum |Q| value in the region(s) where inte"
"nsities for detectors overlap. Allowed overlaps are main with wing, main wi"
"th midrange, and midrange with wing detector.",
"wedge1QminMain": None,
"wedge1QmaxMain": None,
"wedge1QminWing": None,
"wedge1QmaxWing": None,
"wedge1QminMidrange": None,
"wedge1QmaxMidrange": None,
"wedge1overlapStitchQmin": None,
"wedge1overlapStitchQmax": None,
"wedge2QminMain": None,
"wedge2QmaxMain": None,
"wedge2QminWing": None,
"wedge2QmaxWing": None,
"wedge2QminMidrange": None,
"wedge2QmaxMidrange": None,
"wedge2overlapStitchQmin": None,
"wedge2overlapStitchQmax": None
}
}
EQSANS¶
{
"schemaStamp": "schema version as a time stamp in ISO 8601 format (YYYY-M"
"M-DDThh:mm:ssZ), in UTC time",
"instrumentName": "EQSANS",
"iptsNumber": "The IPTS number for the data files. The path to datafiles "
"will be /SNS/EQSANS/IPTS-{iptsNumber}/nexus",
"dataDirectories": "Directories where to find events or histogram files",
"sample": {
"runNumber": "The run number(s) for the sample. The sample filename wil"
"l be EQSANS_{runNumber}.nxs.h5",
"thickness": "The sample thickness in cm",
"transmission": {
"runNumber": "The run number(s) for the transmission sample. The file"
"name will be EQSANS_{runNumber}.nxs.h5",
"value": None
}
},
"background": {
"runNumber": "The run number(s) for the background run. More than one r"
"un number can be specified by passing a list or by passing a string contain"
"ing the run numbers separated by commas.",
"transmission": {
"runNumber": "The run number(s) for the transmission of the backgroun"
"d. The filename will be INSTRUMENTNAME_{runNumber}.nxs.h5",
"value": None
}
},
"emptyTransmission": {
"runNumber": "The run number(s) for the empty beam, used for transmissi"
"on calculation as a reference. More than one run number can be specified by"
" passing a list or by passing a string containing the run numbers separated"
" by commas.",
"value": None
},
"beamCenter": {
"runNumber": "The run number(s) for the beam center calculation. More t"
"han one run number can be specified by passing a list or by passing a strin"
"g containing the run numbers separated by commas."
},
"outputFileName": "The prefix for all output filenames, such as {outputFi"
"leName}_Iqxqy.png. It cannot be left empty.",
"configuration": {
"outputDir": "Output folder",
"instrumentConfigurationDir": "additional configuration, such as mask, "
"slits, TOF cuts. Currently, only mask is used.",
"useTimeSlice": "Indicate whether the data should be processed as time "
"slices (incompatible with sample log slicing)",
"timeSliceInterval": "Interval for time slicing, in seconds",
"timeSliceOffset": "Offset for time slicing from the beginning of the r"
"un, in seconds. Default is no offset.",
"timeSlicePeriod": "Period for time slicing, in seconds and a multiple "
"of timeSliceInterval. Default is None, meaning no periodicity",
"useLogSlice": "Indicate whether the data should be processed as sample"
" log slices (incompatible with time slicing)",
"logSliceName": "Sample log name for slicing",
"logSliceInterval": "Sample log interval for slicing",
"cutTOFmin": "Add this to the minimum TOF in a given TOF frame",
"cutTOFmax": "Subtract this to the maximum TOF in a given frame",
"wavelengthStep": "Wavelength step. The loaded data files are transform"
"ed into wavelength in angstroms, then binned with this step",
"wavelengthStepType": "Type of binning. Options are 'constant Delta lam"
"bda' and 'constant Delta lambda/lambda. Currently only 'constant Delta lamb"
"da' is implemented.",
"sampleOffset": "Sample offset in mm",
"useDetectorOffset": "Flag whether to use the detector offset",
"detectorOffset": "Detector offset in mm",
"sampleApertureSize": "Sample aperture diameter (mm)",
"sourceApertureDiameter": "diameter of the source aperture (mm). Use t"
"he value to override the value determined form the three slit wheels.",
"usePixelCalibration": "Flag to apply the barscan and tube-width calibr"
"ations",
"maskFileName": "Path to a saved file containing mask",
"useDefaultMask": "flag to use a mask that is run number dependent (sto"
"red in a database)",
"defaultMask": "mask as optional arguments to be passed on to function "
"drtsans.mask_utils.apply_mask()",
"useMaskBackTubes": "Flag whether to mask the tubes in the back",
"darkFileName": "Path to the dark measurement file",
"normalization": "Normalization type. Allowed values 'Total charge', 'T"
"ime', 'Monitor'",
"fluxMonitorRatioFile": "Path to the monitor flux ratio file (used in n"
"ormalization by monitor)",
"beamFluxFileName": "Path to the flux file (used in normalization by pr"
"oton charge)",
"sensitivityFileName": "Path to sensitivity measurement file",
"useSolidAngleCorrection": "Flag whether to apply solid angle correctio"
"n",
"useThetaDepTransCorrection": "Flag whether to calculate a theta depend"
"ent transmission",
"mmRadiusForTransmission": "Integration radius (in mm) to be used for t"
"ransmission calculation",
"absoluteScaleMethod": "Absolute scaling method. Only 'standard' (multi"
"ply by a constant) is implemented for EQSANS",
"StandardAbsoluteScale": "Multiplicative scaling factor to transform in"
"tensity to absolute scale",
"numQxQyBins": "Number of bins in the x and y direction for 2D binning""
",
"1DQbinType": "Options for 1D binning: |Q|, azimuthal angle, or |Q| for"
" a particular wedge",
"QbinType": "1D binning type for scalar or wedge modes ('linear' or 'lo"
"g'). If 'linear' is selected, then 'numQbins' must be specified. If 'log' i"
"s selected, then either 'numQbins' or 'LogQBinsPerDecade' must be specified"
".",
"numQBins": "Number of 1D bins for scalar and wedge modes. If log binni"
"ng is selected, then exactly one of numQBins and LogQBinsPerDecade must be "
"specified",
"LogQBinsPerDecade": "Number of 1D bins for scalar and wedge modes in e"
"very decade (in logarithmic mode only). If log binning is selected, then ex"
"actly one of numQBins and LogQBinsPerDecade must be specified",
"useLogQBinsDecadeCenter": "Flag to specify that the min max |Q| is on"
" a bin center; Otherwise, they will be on bin boundary",
"useLogQBinsEvenDecade": "If true, the logarithmic binning is extended "
"such that it starts and ends on some power of 10",
"WedgeMinAngles": "Minimum angles for the wedges, from -90 to 270",
"WedgeMaxAngles": "Maximum angles for the wedges, from -90 to 270",
"autoWedgeQmin": "Minimum Q for automatic wedge fitting",
"autoWedgeQmax": "Maximum Q for automatic wedge fitting",
"autoWedgeQdelta": "Q step for automatic wedge fitting",
"autoWedgeAzimuthalDelta": "Azimuthal angle step for automatic wedge fi"
"tting",
"autoWedgePeakWidth": "Percent of full-width-half-max (FWHM) of the pea"
"k in automatic wedge fitting.",
"autoWedgeBackgroundWidth": "Percent of full-width-half-max (FWHM) of t"
"he background in automatic wedge fitting.",
"autoWedgeSignalToNoiseMin": "Minimum signal to noise ratio for the dat"
"a to be considered fittable in automatic wedge detection",
"AnnularAngleBin": "Angle bin size in degrees for annular binning",
"Qmin": "The minimum |Q| value for scalar, wedge, or annular binning",
"Qmax": "The maximum |Q| value for scalar, wedge, or annular binning",
"useErrorWeighting": "Flag whether to use error weighting of intensitie"
"s when calculating resolution in Q",
"smearingPixelSizeX": "Override nominal pixel width when calculating re"
"solution in Q",
"smearingPixelSizeY": "Override nominal pixel height when calculating r"
"esolution in Q",
"useSubpixels": "boolean flag for stating whether or not the data pixel"
"s are to be subdivided. Used for data rebinning in momentum transfer.",
"subpixelsX": "Divide pixel width an integer number of times when calcu"
"lating resolution in Q",
"subpixelsY": "Divide pixel heights width an integer number of times wh"
"en calculating resolution in Q",
"useSliceIDxAsSuffix": "If True, suffix is the slice index. If False, s"
"uffix is a composite (time, custom log values)",
"fitInelasticIncoh": "Enable inelastic incoherent scattering processing"
"",
"incohfit_intensityweighted": "If the intensity weighted method is used"
" to calculate incoherent scattering correction",
"incohfit_qmin": "manually set the QMin for incoherent scattering calcu"
"lation, if not set maximum valid range will be used",
"incohfit_qmax": "manually set the QMax for incoherent scattering calcu"
"lation, if not set maximum valid range will be used",
"incohfit_factor": "if set the qmin and qmax will be automatically dete"
"rmined by checking the intensity profile",
"outputWavelengthDependentProfile": "if true then output profiles for e"
"ach wavelength from before and after k and b correction",
"elasticReference": {
"runNumber": "The run number(s) for the sample. The sample filename w"
"ill be EQSANS_{runNumber}.nxs.h5",
"thickness": "The sample thickness in cm",
"transmission": {
"runNumber": "The run number(s) for the transmission sample. The fi"
"lename will be EQSANS_{runNumber}.nxs.h5",
"value": None
}
},
"elasticReferenceBkgd": {
"runNumber": "The run number(s) for the background run. More than one"
" run number can be specified by passing a list or by passing a string conta"
"ining the run numbers separated by commas.",
"transmission": {
"runNumber": "The run number(s) for the transmission of the backgro"
"und. The filename will be INSTRUMENTNAME_{runNumber}.nxs.h5",
"value": None
}
},
"selectMinIncoh": "use smallest wavelength as reference wavelength"
}
}
GPSANS¶
{
"schemaStamp": "schema version as a time stamp in ISO 8601 format (YYYY-M"
"M-DDThh:mm:ssZ), in UTC time",
"instrumentName": "GPSANS",
"iptsNumber": "The IPTS number for the data files. The path to datafiles "
"will be /SNS/EQSANS/IPTS-{iptsNumber}/nexus",
"dataDirectories": "Directories where to find events or histogram files",
"sample": {
"runNumber": "The run number(s) for the sample. More than one run numbe"
"r can be specified by passing a list or by passing a string containing the "
"run numbers separated by commas.",
"thickness": "The sample thickness in cm",
"transmission": {
"runNumber": "The run number(s) for the transmission sample. More tha"
"n one run number can be specified by passing a list or by passing a string "
"containing the run numbers separated by commas.",
"value": None
}
},
"background": {
"runNumber": "The run number(s) for the background run. More than one r"
"un number can be specified by passing a list or by passing a string contain"
"ing the run numbers separated by commas.",
"transmission": {
"runNumber": "The run number(s) for the transmission of the backgroun"
"d. The filename will be INSTRUMENTNAME_{runNumber}.nxs.h5",
"value": None
}
},
"emptyTransmission": {
"runNumber": "The run number(s) for the empty beam, used for transmissi"
"on calculation as a reference. More than one run number can be specified by"
" passing a list or by passing a string containing the run numbers separated"
" by commas.",
"value": None
},
"beamCenter": {
"runNumber": "The run number(s) for the beam center calculation. More t"
"han one run number can be specified by passing a list or by passing a strin"
"g containing the run numbers separated by commas."
},
"outputFileName": "The prefix for all output filenames, such as {outputFi"
"leName}_Iqxqy.png. It cannot be left empty.",
"configuration": {
"outputDir": "Output folder",
"wavelength": "Wave length in Angstrom",
"wavelengthSpread": "Wave length spread in Angstrom. `wavelength` must"
" be specified too",
"useTimeSlice": "Indicate whether the data should be processed as time "
"slices (incompatible with sample log slicing)",
"timeSliceInterval": "Interval for time slicing, in seconds",
"timeSliceOffset": "Offset for time slicing from the beginning of the r"
"un, in seconds. Default is no offset.",
"timeSlicePeriod": "Period for time slicing, in seconds and a multiple "
"of timeSliceInterval. Default is None, meaning no periodicity",
"useLogSlice": "Indicate whether the data should be processed as sample"
" log slices (incompatible with time slicing)",
"logSliceName": "Sample log name for slicing",
"logSliceInterval": "Sample log interval for slicing",
"sampleOffset": "Sample offset in mm",
"useDetectorOffset": "Flag whether to use the detector offset",
"detectorOffset": "Detector offset in mm",
"sampleDetectorDistance": "Distance between the sample and the detector"
" array in mm",
"sampleToSi": "distance from sample to the silica window, in mm",
"sampleApertureSize": "Sample aperture diameter (mm)",
"sourceApertureDiameter": "Source aperture diameter (mm)",
"usePixelCalibration": "Flag to apply the barscan and tube-width calibr"
"ations",
"maskFileName": "Path to a saved file containing mask",
"useDefaultMask": "flag to use a mask that is run number dependent (sto"
"red in a database)",
"defaultMask": "mask as optional arguments to be passed on to function "
"drtsans.mask_utils.apply_mask()",
"useMaskBackTubes": "Flag whether to mask the tubes in the back",
"darkFileName": "Path to the dark measurement file",
"normalization": "Normalization type. Allowed values 'Total charge', 'T"
"ime', 'Monitor'",
"normalizationResortToTime": "Carry out Time normalization if Monitor w"
"as selected but no monitor counts are found",
"sensitivityFileName": "Path to sensitivity measurement file",
"useSolidAngleCorrection": "Flag whether to apply solid angle correctio"
"n",
"blockedBeamRunNumber": "Run number for the blocked beam run. More than"
" one run number can be specified by passing a list or by passing a string c"
"ontaining the run numbers separated by commas.",
"useThetaDepTransCorrection": "Flag whether to calculate a theta depend"
"ent transmission",
"DBScalingBeamRadius": "",
"mmRadiusForTransmission": "Integration radius (in mm) to be used for t"
"ransmission calculation",
"absoluteScaleMethod": "Absolute scaling method. Only 'standard' (multi"
"ply by a constant) is implemented for EQSANS",
"StandardAbsoluteScale": "Multiplicative scaling factor to transform in"
"tensity to absolute scale",
"numQxQyBins": "Number of bins in the x and y direction for 2D binning""
",
"1DQbinType": "Options for 1D binning: |Q|, azimuthal angle, or |Q| for"
" a particular wedge",
"QbinType": "1D binning type for scalar or wedge modes ('linear' or 'lo"
"g'). If 'linear' is selected, then 'numQbins' must be specified. If 'log' i"
"s selected, then either 'numQbins' or 'LogQBinsPerDecade' must be specified"
".",
"numQBins": "Number of 1D bins for scalar and wedge modes. If log binni"
"ng is selected, then exactly one of numQBins and LogQBinsPerDecade must be "
"specified",
"LogQBinsPerDecade": "Number of 1D bins for scalar and wedge modes in e"
"very decade (in logarithmic mode only). If log binning is selected, then ex"
"actly one of numQBins and LogQBinsPerDecade must be specified",
"useLogQBinsDecadeCenter": "Flag to specify that the min max |Q| is on"
" a bin center; Otherwise, they will be on bin boundary",
"useLogQBinsEvenDecade": "If true, the logarithmic binning is extended "
"such that it starts and ends on some power of 10",
"WedgeMinAngles": "Minimum angles for the wedges, from -90 to 270",
"WedgeMaxAngles": "Maximum angles for the wedges, from -90 to 270",
"autoWedgeQmin": "Minimum Q for automatic wedge fitting",
"autoWedgeQmax": "Maximum Q for automatic wedge fitting",
"autoWedgeQdelta": "Q step for automatic wedge fitting",
"autoWedgeAzimuthalDelta": "Azimuthal angle step for automatic wedge fi"
"tting",
"autoWedgePeakWidth": "Percent of full-width-half-max (FWHM) of the pea"
"k in automatic wedge fitting.",
"autoWedgeBackgroundWidth": "Percent of full-width-half-max (FWHM) of t"
"he background in automatic wedge fitting.",
"autoWedgeSignalToNoiseMin": "Minimum signal to noise ratio for the dat"
"a to be considered fittable in automatic wedge detection",
"autoWedgePeakSearchWindowSizeFactor": "Window size to search peak. Re"
"al size = 360 / num_peaks * autoWedgeWindowSize",
"AnnularAngleBin": "Angle bin size in degrees for annular binning",
"Qmin": "The minimum |Q| value for scalar, wedge, or annular binning",
"Qmax": "The maximum |Q| value for scalar, wedge, or annular binning",
"useErrorWeighting": "Flag whether to use error weighting of intensitie"
"s when calculating resolution in Q",
"smearingPixelSizeX": "Override nominal pixel width when calculating re"
"solution in Q",
"smearingPixelSizeY": "Override nominal pixel height when calculating r"
"esolution in Q",
"useSubpixels": "boolean flag for stating whether or not the data pixel"
"s are to be subdivided. Used for data rebinning in momentum transfer.",
"subpixelsX": "Divide pixel width an integer number of times when calcu"
"lating resolution in Q",
"subpixelsY": "Divide pixel heights width an integer number of times wh"
"en calculating resolution in Q"
}
}