 | IReconstruction Interface |
Namespace: LynceeTec.Interfaces
Assembly: LynceeTec.Interfaces (in LynceeTec.Interfaces.dll) Version: 10.2.3317.0 , built 2025-03-17 14:03:43 UTC
SyntaxThe IReconstruction type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AmplDivRefHolo | Enables or disables the normalization for each pixel of the reconstructed intensity images with the intensity of each corresponding pixel of the reference hologram |
| AmpProfile | Gets the last amplitude (intensity) profile extracted. See ExtractArbitraryIntensityProfile(Int32, Int32, Int32, Int32, Boolean, Single, Single). |
| Bpp | Gets or sets the number of BITS per pixel. Either 8 or 16. |
| CanRefresh | |
| deltaN | Gets or sets the difference of refractive index (used for phase->height conversion). |
| EffBpp | Gets or sets the number of useful bits per pixel. It might differ from Bpp. |
| FinalPhaseImage | |
| HasROI | Gets a value indicating whether a region of interest is defined. |
| ImageHeight | Gets the height of the current hologram image. |
| ImageWidth | Gets the width of the current hologram image. |
| ImgAmp | Gets a pointer to the processed amplitude (intensity) image. |
| ImgFFT | Gets a pointer to the processed amplitude image of the 2D Fourier transform. |
| ImgHolo | Gets a pointer to the raw hologram image (acquired from a camera). |
| ImgPhase | Gets a pointer to the processed phase image. |
| lambda | Gets or sets the wavelength. |
| LockPhaseScale | |
| Mask | |
| MaskArray | |
| MaskVisibility | Toggles the mask visibility on the output image. |
| NonMeasuredAreasFillingRadius | Gets or sets the pixel radius for the non-measured areas filling feature. |
| OplMax | |
| OplMin | |
| PhaseColormap | |
| PhaseCorrectionDegree | |
| PhaseMeanValue | Gets the mean value of the phase image (or its ROI). Call ComputePhaseStdDev first to compute it. |
| PhaseMonitor | |
| PhaseOffset | Gets or sets the offset of the phase mask, i.e., the value of the phase image considered as 0, in [°]. |
| PhaseProfile | Gets the last phase profile extracted. See ExtractArbitraryPhaseProfile(Int32, Int32, Int32, Int32, Int32, Boolean, Boolean, Boolean, Single, Single). |
| PhaseROIHeight | Gets the height of the region of interest on the phase and amplitude images. If no ROI is defined, returns the height of the image. |
| PhaseROILeft | Gets the offset of the region of interest from the left of the image. (X coordinate of the top left corner of the ROI). |
| PhaseROIStride | Gets the stride of the region of interest (distance in bytes between two lines of the image) for float amplitude or phase images. If no ROI is defined, returns the stride of the image. Stride is always a multiple of 4. |
| PhaseROITop | Gets the offset of the region of interest from the top of the image. (Y coordinate of the top left corner of the ROI). |
| PhaseROIWidth | Gets the width of the region of interest on the phase and amplitude images. If no ROI is defined, returns the width of the image. |
| PhaseStdDev | Gets the standard deviation of the phase image (or its ROI). Call ComputePhaseStdDev first to compute it. |
| PhaseUnit | |
| PhMax | |
| PhMin | |
| ReconstructedPhase | |
| RefHoloUse | Enables or disables the usage of a reference hologram for reconstruction |
| ResolutionDivider | Gets the resolution division value of the current hologram image. |
| SpectrumKx | |
| SpectrumKy | |
| StepAmpPhase | |
| StepFinalPhaseImage | |
| StepReconstructedPhase | |
| TemporalPhaseAverageFramesNumber | Gets of sets the number of frames to be averaged during the temporal averaging process. |
| TransMicroscope | Gets or sets the type of the miscroscope. |
| Unwrap2D | Toggles the 2D unwrapping. |
| Unwrap2DMethod | Gets or sets the method for unwrapping in 2D. |
| UnwrapPhaseMonitorZones | |
| UseHalfResolution | Gets or sets the activation state of the half resolution feature. |
| UseSpatialPhaseAverage | Gets or sets the activation state of the spatial phase averaging. |
| UseTemporalPhaseAverage | Gets or sets the activation state of the temporal phase averaging. true adds the given holograms in the reconstruction object until TemporalPhaseAverageFramesNumber is reached. The last reconstructed phase is averaged. |
| UseWavelengthFilter | Gets the value indicating whether a wavelength filter is enabled. |
Methods| Name | Description | |
|---|---|---|
 | AddPhaseCorrectionSegment | 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. |
| AddPhaseCorrectionZone | 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. |
| AddPhaseMonitorZone | |
| AddPhaseOffsetAdjustmentZone | Adds a phase offset correction zone. (Valid only for the multi-zone phase offset method) |
| AutoComputePhaseMaskUsingSegments | Compute the phase correction coefficients related to the specified method using segments. Then, recompute the phase correction mask using ComputePhaseMask |
| AutoComputePhaseMaskUsingZones | Compute the phase correction coefficients related to the specified method using zones. Then, recompute the phase correction mask using ComputePhaseMask |
| ComputePhaseHistogram | Computes the histogram of the phase image (or of its ROI). Call getPhaseHistogram to get the result. |
| ComputePhaseMask | Recomputes the phase correction mask using the existing correction coefficients. |
| ComputePhaseStdDev | 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. |
| ConfigureProcessing | |
| CopyAmp32fToMemStream | |
| CopyAmpToMemStream | |
| CopyHoloToMemStream | |
| CopyHoloToRH | 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 |
| CopyImg32fResult(Single, Int32, windowsList) | Copies the floating point image result of processing in a local buffer. |
| CopyImg32fResult(Single, Int32, windowsList, Boolean) | Copies the floating point image result of processing in a local buffer. |
| CopyImgResult | Copies the image result of processing in a local buffer. |
| CopyPhase32fToMemStream | |
| CopyPhaseToMemStream | |
| CreateStitching | (Inherited from IStitchingFactory) |
| CutNewEllFourierRegion | |
| CutNewRectFourierRegion | |
| DoAutoPhaseCorrectionNoCT | |
| DoMonitorPhaseZone | |
| ExtractArbitraryIntensityProfile | Extracts a profile in the intensity (amplitude) image. Use AmpProfile to get the result. |
| ExtractArbitraryPhaseProfile | Extracts a profile in the phase image. Use PhaseProfile to get the result. |
| ExtractProfile | |
| ExtractROI | Sets a region of interest in the phase and intensity images. |
| GetAmp32f | |
| GetAvgBufHolo | |
| GetAvgRHBufHolo | Gets a reference to the byte array to copy the reference hologram data when using several averaged holograms |
| GetDistance | 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. |
| GetNumFourierFilters | |
| GetOplValue | |
| GetPhase32f | |
| GetPhaseCorrectionCoefficient | |
| getPhaseHistogram | Gets the phase histogram. Call ComputePhaseHistogram to compute it. |
| GetPhaseValue | |
| InitProcessingChain | |
| LoadFourierRegion | |
| LoadPhaseOffsetAdjustmentZones | |
| LoadRefHolo | |
| OnDistanceChange | Recomputes the phase mask and redoes the Fresnel transform, then process the images defined in visMask. Call after changing SetDistance(Int32, Double). |
| OnNewImage(windowsList) | Signals that a new image is available in the memory pointed by ImgHolo, gives it to the processing chain and processes it. |
| OnNewImage(Hologram, windowsList) | Gives a new image to the processing chain and processes it. |
| ParsePhaseOffsetAdjustmentZones | |
| PerformAutoFocus | Compute the focus position. |
 | PhaseToHeightNmConversionFactor | Returns the phase [rad] to height [nm] conversion factor. |
| Process | Reconstructs the image pointed by ImgHolo |
| RecomputePostProcessing | Recompute the phase and intensity post processing, including non-measured points mask |
| RecomputeSpectrumKxKy | |
| ReconstructFile | |
| ReconstructSequence | |
| RedoFourierFilter | |
| RefreshAmplitude | |
| RefreshFourier | |
| RefreshIntensityPhase | |
| RefreshPhase | |
| RemoveLastFourierFilter | |
| ResetFourierRegions | |
| ResetPhaseCorrectionSegments | Removes all phase correction segments. One must call AutoComputePhaseMaskUsingSegments(windowsList, phaseFitMethod, Int32, Boolean) to update the phase correction mask before recomputing the phase image. |
| ResetPhaseCorrectionZones | Removes all phase correction zones. One must call AutoComputePhaseMaskUsingZones(windowsList, phaseFitPolyBase, Int32, Boolean) to update the phase correction mask before recomputing the phase image. |
| ResetPhaseMask | |
| ResetPhaseMonitorData | |
| ResetPhaseMonitorZones | |
| ResetPhaseOffsetAdjustmentZones | |
| ResetROI | Removes the region of interest for the phase and amplitude images. |
| ResetTemporalPhaseAverage | Resets the temporal averaging count. The next reconstructed hologram will be the first of the next averaging process. |
| SaveFourierRegion | |
| SaveImage | Saves an image in TIFF format |
| SaveImageFloat(windowsList, String, Single, Boolean) | Saves an image as floating-point values in a binary or text file |
| SaveImageFloat(windowsList, String, Single, Boolean, Boolean) | |
| SavePhaseOffsetAdjustmentZones | |
| SaveRefHolo | Saves the current reference hologram (reference holograms are NOT saved in the same format as standard hologram) |
| SetDistance | 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. |
| SetHoloListSize | |
| SetHoloRHListSize | Define the number of holograms which will be averaged to produce the reference hologram |
| SetMaximumNumberOfSamplesForPhaseMonitor | |
| SetPhaseCorrectionCoefficient | |
| SetSpectrumKxKy | |
| SetSpTilt | |
| SetWavelengthFilterParameters | Configures a filter applied to the complex wavefront (it influences both the phase and the amplitude image). |
| SignalNewImage | |
| UndoPhaseCorrectionSegment | 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. |
| UseCurrentHoloAsRef | Define how to use the reference hologram. Call CopyHoloToRH(Int32) or SetHoloRHListSize(Int32) and Array.Copy before. (See example code below) |
See Also