The CalFile is a calibration file originally created for use in the Ariel powder diffraction data reduction package.
Files using this format with the .cal extension are still used by several algorithms in Mantid.
The file is a simple text file with the following format
# number UDET offset select group
0 611 0.0000000 1 0
1 612 0.0000000 1 0
2 601 0.0000000 0 0
...
19 101001 -0.0497075 1 2
20 101002 -0.3515893 1 2
21 101003 -0.2803879 0 2
...
349 201001 0.0525040 1 3
350 201002 0.0538936 1 3
351 201003 0.0535027 1 3
...
number: ignoredUDET: detector IDoffset: calibration offset used in :ref:`AlignDetectors <algm-AlignDetectors>`. Comes from theOffsetsWorkspace, or 0.0 if none is given.select: 1 if selected (use the pixel). Comes from theMaskWorkspace, or 1 if none is given.group: what group to focus to in :ref:`DiffractionFocussing <algm-DiffractionFocussing>`. Comes from theGroupingWorkspace, or 1 if none is given. Setting the group as 0 specifies the detector as not to be grouped, effectively masking it.
See :ref:`here <Powder Diffraction Calibration>` for information on CalFile in the greater context of time-of-flight powder diffraction calibration.
In addition to algorithms mentioned in :ref:`powder diffraction calibration <Powder Diffraction Calibration>` there are some algorithms specifically for CalFiles.
- :ref:`LoadCalFile <algm-LoadCalFile>` will load the CalFile into separate offset, masking and grouping workspaces.
- :ref:`SaveCalFile <algm-SaveCalFile>` will save a CalFile from separate offset, masking and grouping workspaces.
- :ref:`MaskWorkspaceToCalFile<algm-MaskWorkspaceToCalFile>` will save a mask workspace as a CalFile.
- :ref:`ReadGroupsFromFile<algm-ReadGroupsFromFile>` Reads the groups from a CalFile, and output a 2D workspace containing on the Y-axis the values of the Group each detector belongs to. This is used to visualize the grouping scheme for powder diffractometers.
- :ref:`CreateCalFileByNames<algm-CreateCalFileByNames>` will create a CalFile with the grouping column set according to a list of bank names.
- :ref:`CreateDummyCalFile<algm-CreateDummyCalFile>` creates a CalFile from a workspace. All of the offsets will be zero, and the pixels will be all grouped into one group.
- :ref:`MergeCalFiles<algm-MergeCalFiles>` combines the data contained in two CalFiles, based on the selections offsets, selections and groups can be merged. The matching rows are determined by UDET. Any unmatched records are added at the end of the file.
.. categories:: Calibration