Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagepy
themeRDark
titleazav_pyfai documentation
	"""
    Parameters
    ----------
    name: str
        Function name
    
    mask: array, optional
        User defined mask. 1 for valid pixels.
    
    return2d: bool, optional
        Return a 2d (q,phi). Default: False
    
    poni_file: str, Path object, optional
        Path to a pyFAI calibration file
    
    ai_kwargs: dict, optional
        Arguments to pyFAI.AzimuthalIntegrator. Either this parameter or a calib file is necessary
        For arguments see: https://pyfai.readthedocs.io/en/master/api/pyFAI.html#module-pyFAI.azimuthalIntegrator
    
    pol_factor: float, optional
        Polarization factor. Default 1. Passed to integrate1d or integrate2d.
        
    npts_radial: int, optional
        Number of points for the radial binning. Default 256.
    
    npts_az: int, optional
        Number of points for the azimuthal binning. Default 360. Only used for the 2d integration.
        
    azav_kwargs: dict, optional
        Additonal arguments to pass to integrate1d or integrate2d.
        See https://pyfai.readthedocs.io/en/master/api/pyFAI.html#pyFAI.azimuthalIntegrator.AzimuthalIntegrator.integrate1d
    """

Fourier transform

TBD

Autocorrelation

TBD