Click or drag to resize

IReconstruction Methods

The IReconstruction type exposes the following members.

Methods
 NameDescription
Public methodAddPhaseCorrectionSegment Adds a new vertical or horizontal segment. One must call AutoComputePhaseMaskUsingSegments(windowsList, phaseFitMethod, Int32, Boolean) to update the phase correction mask before recomputing the phase image.
Public methodAddPhaseCorrectionZone Adds a phase correction rectangular zone. One must call AutoComputePhaseMaskUsingZones(windowsList, phaseFitPolyBase, Int32, Boolean) to update the phase correction mask before recomputing the phase image.
Public methodAddPhaseMonitorZone 
Public methodAddPhaseOffsetAdjustmentZone Adds a phase offset correction zone. (Valid only for the multi-zone phase offset method)
Public methodAutoComputePhaseMaskUsingSegments Compute the phase correction coefficients related to the specified method using segments. Then, recompute the phase correction mask using ComputePhaseMask
Public methodAutoComputePhaseMaskUsingZones Compute the phase correction coefficients related to the specified method using zones. Then, recompute the phase correction mask using ComputePhaseMask
Public methodComputePhaseHistogram Computes the histogram of the phase image (or of its ROI). Call getPhaseHistogram to get the result.
Public methodComputePhaseMask Recomputes the phase correction mask using the existing correction coefficients.
Public methodComputePhaseStdDev Computes the mean value and standard deviation of the phase image (or its region of interest if one is defined). Use PhaseMeanValue and PhaseStdDev to read the result.
Public methodConfigureProcessing 
Public methodCopyAmp32fToMemStream 
Public methodCopyAmpToMemStream 
Public methodCopyHoloToMemStream 
Public methodCopyHoloToRH Copies the current hologram known by the reconstruction to the array of holograms used as reference. Prefer a copy to array using GetAvgRHBufHolo(Int32) when using several avaraged holograms
Public methodCopyImg32fResult(Single, Int32, windowsList) Copies the floating point image result of processing in a local buffer.
Public methodCopyImg32fResult(Single, Int32, windowsList, Boolean) Copies the floating point image result of processing in a local buffer.
Public methodCopyImgResult Copies the image result of processing in a local buffer.
Public methodCopyPhase32fToMemStream 
Public methodCopyPhaseToMemStream 
Public methodCreateStitching
(Inherited from IStitchingFactory)
Public methodCutNewEllFourierRegion 
Public methodCutNewRectFourierRegion 
Public methodDoAutoPhaseCorrectionNoCT 
Public methodDoMonitorPhaseZone 
Public methodExtractArbitraryIntensityProfile Extracts a profile in the intensity (amplitude) image. Use AmpProfile to get the result.
Public methodExtractArbitraryPhaseProfile Extracts a profile in the phase image. Use PhaseProfile to get the result.
Public methodExtractProfile 
Public methodExtractROI Sets a region of interest in the phase and intensity images.
Public methodGetAmp32f 
Public methodGetAvgBufHolo 
Public methodGetAvgRHBufHolo Gets a reference to the byte array to copy the reference hologram data when using several averaged holograms
Public methodGetDistance Gets the reconstruction distance for one of the laser source, in [m]. The value must include the Objective-Source Correction. The new value will be used on the next processed image. To reprocess the last hologram, call OnDistanceChange(windowsList) after setting the value.
Public methodGetNumFourierFilters 
Public methodGetOplValue 
Public methodGetPhase32f 
Public methodGetPhaseCorrectionCoefficient 
Public methodgetPhaseHistogram Gets the phase histogram. Call ComputePhaseHistogram to compute it.
Public methodGetPhaseValue 
Public methodInitProcessingChain 
Public methodLoadFourierRegion 
Public methodLoadPhaseOffsetAdjustmentZones 
Public methodLoadRefHolo 
Public methodOnDistanceChange Recomputes the phase mask and redoes the Fresnel transform, then process the images defined in visMask. Call after changing SetDistance(Int32, Double).
Public methodOnNewImage(windowsList) Signals that a new image is available in the memory pointed by ImgHolo, gives it to the processing chain and processes it.
Public methodOnNewImage(Hologram, windowsList) Gives a new image to the processing chain and processes it.
Public methodParsePhaseOffsetAdjustmentZones 
Public methodPerformAutoFocus Compute the focus position.
Public methodCode examplePhaseToHeightNmConversionFactor Returns the phase [rad] to height [nm] conversion factor.
Public methodProcess Reconstructs the image pointed by ImgHolo
Public methodRecomputePostProcessing Recompute the phase and intensity post processing, including non-measured points mask
Public methodRecomputeSpectrumKxKy 
Public methodReconstructFile 
Public methodReconstructSequence 
Public methodRedoFourierFilter 
Public methodRefreshAmplitude 
Public methodRefreshFourier 
Public methodRefreshIntensityPhase 
Public methodRefreshPhase 
Public methodRemoveLastFourierFilter 
Public methodResetFourierRegions 
Public methodResetPhaseCorrectionSegments Removes all phase correction segments. One must call AutoComputePhaseMaskUsingSegments(windowsList, phaseFitMethod, Int32, Boolean) to update the phase correction mask before recomputing the phase image.
Public methodResetPhaseCorrectionZones Removes all phase correction zones. One must call AutoComputePhaseMaskUsingZones(windowsList, phaseFitPolyBase, Int32, Boolean) to update the phase correction mask before recomputing the phase image.
Public methodResetPhaseMask 
Public methodResetPhaseMonitorData 
Public methodResetPhaseMonitorZones 
Public methodResetPhaseOffsetAdjustmentZones 
Public methodResetROI Removes the region of interest for the phase and amplitude images.
Public methodResetTemporalPhaseAverage Resets the temporal averaging count. The next reconstructed hologram will be the first of the next averaging process.
Public methodSaveFourierRegion 
Public methodSaveImage Saves an image in TIFF format
Public methodSaveImageFloat(windowsList, String, Single, Boolean) Saves an image as floating-point values in a binary or text file
Public methodSaveImageFloat(windowsList, String, Single, Boolean, Boolean) 
Public methodSavePhaseOffsetAdjustmentZones 
Public methodSaveRefHolo Saves the current reference hologram (reference holograms are NOT saved in the same format as standard hologram)
Public methodSetDistance Sets the reconstruction distance for one of the laser source, in [m]. The value must include the Objective-Source Correction. The new value will be used on the next processed image. To reprocess the last hologram, call OnDistanceChange(windowsList) after setting the value.
Public methodSetHoloListSize 
Public methodSetHoloRHListSize Define the number of holograms which will be averaged to produce the reference hologram
Public methodSetMaximumNumberOfSamplesForPhaseMonitor 
Public methodSetPhaseCorrectionCoefficient 
Public methodSetSpectrumKxKy 
Public methodSetSpTilt 
Public methodSetWavelengthFilterParameters Configures a filter applied to the complex wavefront (it influences both the phase and the amplitude image).
Public methodSignalNewImage 
Public methodUndoPhaseCorrectionSegment Removes the last phase correction segment added for a certain orientation. One must call AutoComputePhaseMaskUsingSegments(windowsList, phaseFitMethod, Int32, Boolean) to update the phase correction mask before recomputing the phase image.
Public methodCode exampleUseCurrentHoloAsRef Define how to use the reference hologram. Call CopyHoloToRH(Int32) or SetHoloRHListSize(Int32) and Array.Copy before. (See example code below)
Top
See Also