\(\renewcommand\AA{\unicode{x212B}}\)
EstimateScatteringVolumeCentreOfMass v1¶
Summary¶
Estimate the centre of mass of the illuminated volume of the sample
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
Input Workspace |
|
CentreOfMass |
Output |
dbl list |
Estimated centre of mass of illuminated sample volume |
|
ElementSize |
Input |
number |
1 |
The size of one side of an integration element cube in {ElementUnits} |
ElementUnits |
Input |
string |
mm |
The units which ElementSize has been provided in. Allowed values: [‘m’, ‘cm’, ‘mm’] |
Description¶
Takes a workspace with either just a sample or a sample and gauge volume defined and returns an estimation for the centre of mass of the illuminated region of sample.
Under the hood this algorithm uses the same basic logic as AbsorptionCorrection v1 to rasterize the sample shape (or any defined gauge volume). It then calculates the average position of all the raster elements which are inside both shapes.
Categories: AlgorithmIndex | CorrectionFunctions\EstimateScatteringVolumeCentreOfMass
Source¶
C++ header: EstimateScatteringVolumeCentreOfMass.h
C++ source: EstimateScatteringVolumeCentreOfMass.cpp