Page tree

This plug-in subtracts the 2D detector background and (or) dark current image, if there is background or current image, and integrates 2D detector images in azimuthal (Figure 1) or radial (Figure 2) direction using pyFAI integrate1d and integrate2d modules.


 Figure 1 Left: Radial plot. Right: Scheme of the binning (red dashed line) in azimuthal direction.

 Figure 2 Left: Azimuthal plot. Right: Scheme of the binning (red dashed line) in radial direction. 

Figure 3: Screenshot of the plugin ImageIntegration1d

Figure 4: Screenshot of the example Direct Transmission File.



Parameters

  1.  Profile: Select “Radial” if you want to have radial result I = I(q), otherwise select “Azimuthal” if you want to have azimuthal result I = I(χ).
  2. Pixel Size X: The horizontal dimension of image pixels in µm.
  3. Pixel Size Y: The vertical dimension of image pixels in µm.
  4. Beam Center X: The horizontal pixel coordinates of direct beam center in pixel unit.
  5. Beam Center Y: The vertical pixel coordinates of direct beam center in pixel unit.
  6. Rotation: The rotation angle of a plane in which the angle of tilt is defined in degrees.
  7. Tilt: The angle of detector tilt within the tilt plane in degrees.
  8. Detector Distance: The distance from sample to detector in unit mm.
  9. Wavelength: The X-ray wavelength in unit angstrom.
  10. Start Azimuth: The azimuth angle for start of region to be integrated.
  11. End Azimuth: The azimuth angle for end of region to be integrated.
  12. Inner Radius: The radius for inner radial limit of region to be integrated.
  13. Outer Radius: The radius for outer radial limit of region to be integrated.
  14. Bins: Defines the number of output bins around the azimuth or around the radial direction (depends on output “Profile” type).
  15. Geometry Correction: If set to 'ON' will corrects a flat 'scan' to the equivalent of a 2-theta or a Q-space scan. These are effect of distance and obliqueness at higher angle for the flat image plane compared to a detector on a 2-theta arm, always facing the sample.
  16. Scan Type: Select type of output 1-D scan for only radial profile type: "Q-SPACE_nm^-1", "2-THETA_deg", "2-THETA_rad", "RADIAL_mm". Note: This option has only effect if the profile type is selected as “Radial”.
  17. Polarisation Correction: If set to ‘ON’, it will read the ‘Polarisation Factor’ and apply a polarization effect intensity correction.
  18. Polarisation Factor: Put a value to do the polarisation correction (range: -1 to 1, default value: 0.99). Note: If the polarisation factor is 0, that doesn’t mean no polarisation correction, it will do circular polarization, the correction correspond to (1+(cos2?)^2)/2.
  19. ImageIntegrationOutputDirectory: Output directory for integration result in ACSII format. This field is optional.
  20. ErrorModel: An error model for error calculation: “poisson” means variance = I, “data variance” means variance = (I-<I>)^2.
  21. Mask File Name: Browse the mask file name which is saved in “Fit2D” mask format. This field is optional.
  22. DummyValue: Value for dead/masked pixels. This field is optional.
  23. delta_dummy_value: Precision for dummy value. This field is optional.
  24. Flat_FieldImageFileName: Flat field image. This field is optional.
  25. IntegrationMethod: The integration method (algorithm), can be selected following method: "numpy", "cython", "BBox", "splitpixel", "lut", "csr", "lut_ocl", "csr_ocl". The default option is “lut”.
  26. Safe: Do some extra checks to ensure LUT/CSR is still valid. False is faster.
  27. Normalization Factor: Value of a normalization monitor. This field is optional.
  28. Spline_File_Name: The file name containing the spline. This field is optional.
  29. BackgroundImageFileName: The background image file name.
  30. DarkCurrentImageFileName: The detector dark current image file name.
  31. DirectTransmissionFileName: The transmission file name, which created by user manually. This parameter is optional, but if this parameter is given, the following 4 parameters (that are: “SpecFileNameForTransmission”, “SpecScanNumberForTransmission”, “EmptyBeamScanNumberForTransmission” and “SpecCounterNameForTransmission”) will be ignored.
  32. SpecFileNameForTransmission: The file name of the spec control program measured at beam line.
  33. SpecScanNumberForTransmission: The scan number in the spec data file measured as transmission scan.
  34. EmptyBeamScanNumberForTransmission: The scan number in the spec data file measured as empty beam (without sample) scan.
  35. SpecCounterNameForTransmission: The counter name in the spec file used for sample transmission measurement.
  36. FirstImageFileNumberInTheScan: The first image (2D pattern) file number in the measurement scan, in order to determine the sequence for transmission file or transmission scans. This parameter is optional.

Inputs

  • image: The path to the detector image.

Outputs

  • q[chi]: q values if Profile is set to Radial, chi values if Profile is set to Azimuthal.
  • I: The integrated intensity data.
  • error: error estimation of the image integration.


  • No labels