MeasurementDirectory | All selected files in this directory are loaded as available data for the measurement. |
FrequencyList | An iterable of modulation frequencies in Hz (not MHz). The function attempts to produce moment images for each of these frequencies. If data is missing for one of these frequencies, the entire function fails. For biasing it is assumed, that FrequencyList[i]==i*FrequencyList[1]. |
CalibrationDirectory | It is assumed that the files in the given directory contain measurements taken with the same configuration as the measurement but on a different scene. The scene should produce the impulse response given by ReferenceDistribution on every pixel. This is typically achieved by pointing the light source directly at the sensor without lens and passing a Dirac-delta for ReferenceDistribution. |
ReferenceDistribution | This parameter is forwarded to CTrigonometricMomentImageStack.GetPerPixelCalibration(). |
OutputDirectory | The path to a directory to be filled with images by means of CTrigonometricMomentImageStack.Store(). Alternatively, this can be a list of file names. |
KeywordArguments | The following keyword arguments exist: |
PhaseSet | If this is a set of phase values in radians, all processing steps consider solely images corresponding to phase shifts in this set. However, the four taps belonging to a single phase shift are still considered. By default all phase shifts available in the measurement are used. |
Exposure | The exposure time of the measurements which are to be used in seconds. Pass None to combine all exposures (default). Note that they are combined in a very naive fashion. |
MeasurementFilterFunction | A function like that passed to CMeasurement.AddCaptureData() that can be used to define which files should be loaded from the measurement. It works on top of the other corresponding options. Pass None to avoid additional filtering (default). |
CalibrationFilterFunction | Like MeasurementFilterFunction but for the calibration measurement. |
SubtractImages | If this parameter is True, images with a relative phase offset of pi are not handled separately but subtracted from one another immediately (default True). |
IgnoreTaps | If this parameter is True, all procedures will only use the first phase tap stored in each file (default False). |
FractionToKeep | For measurements where whole images are outliers it can be necessary to remove some takes. This parameter defines the fraction of images to keep (per frequency, phase, tap and exposure). Pass None or 1.0 to keep all data (default). |
FinalSmoothing | The standard deviation in pixels of the Gaussian blur applied to the calibrated moment image right before biasing (default 0.0, i.e. no smoothing). |
BiasingThreshold | The minimal value of an Eigenvalue of a normalized Toeplitz matrix (default 0.003). Intuitively, greater values employ more biasing to enforce smoother impulse responses. Pass a negative value to disable biasing entirely. |
BiasingMode | Forwards to CTrigonometricMomentImageStack.ApplyBiasing(). |
EnablePlotting | If this is True (default) various matplotlib plots will be generated to ease analysis of the output. |
ShowMomentImages | If this is True, all measured images are plotted (default False). This can be time-consuming. |
ShowScatterPlots,ShowGraphPlots,ShowFourierPlots,ShowExposurePlots | Forwards to CMeasurement.PlotPixelData() (default True,False,False, False). |
ShowPisarenkoEstimate | If this boolean is True (default) the Pisarenko estimate for the final moment images is shown. |
PixelDataX,PixelDataY | Forwards to CMeasurement.PlotPixelData() as X and Y (default None,None, i.e. a random pixel). |
BrightnessFactor | The factor by which the magnitude of the moment images is multiplied. |