Click or drag to resize

SingleWavelengthReconstruction Class

Reconstruction object for single wavelength configuration
Inheritance Hierarchy
SystemObject
  LynceeTec.Processing.HolographySingleWavelengthReconstruction

Namespace: LynceeTec.Processing.Holography
Assembly: LynceeTec.InterfaceProcessing (in LynceeTec.InterfaceProcessing.dll) Version: 0.0.0.0
Syntax
public class SingleWavelengthReconstruction : IDisposable, 
	IReconstruction

The SingleWavelengthReconstruction type exposes the following members.

Constructors
 NameDescription
Public methodSingleWavelengthReconstructionInitializes a new instance of the SingleWavelengthReconstruction class
Top
Properties
 NameDescription
Public propertyAmplDivRefHolo Enables or disables the normalization for each pixel of the reconstructed intensity images with the intensity of each corresponding pixel of the reference hologram
Public propertyAmpProfile Gets the last amplitude (intensity) profile extracted. See ExtractArbitraryIntensityProfile(Int32, Int32, Int32, Int32, Boolean, Single, Single).
Public propertyBpp Gets or sets the number of BITS per pixel. Either 8 or 16.
Public propertyCanRefresh 
Public propertydeltaN Gets or sets the difference of refractive index (used for phase->height conversion).
Public propertyEffBpp Gets or sets the number of useful bits per pixel. It might differ from Bpp.
Public propertyFinalPhaseImage 
Public propertyHasROI Gets a value indicating whether a region of interest is defined.
Public propertyImageHeight Gets the height of the current hologram image.
Public propertyImageWidth Gets the width of the current hologram image.
Public propertyImgAmp Gets a pointer to the processed amplitude (intensity) image.
Public propertyImgFFT Gets a pointer to the processed amplitude image of the 2D Fourier transform.
Public propertyImgHolo Gets a pointer to the raw hologram image (acquired from a camera).
Public propertyImgPhase Gets a pointer to the processed phase image.
Public propertylambda Gets or sets the wavelength.
Public propertyLockPhaseScale 
Public propertyMask 
Public propertyMaskArray 
Public propertyMaskVisibility Gets or sets the mask visibility on the final image
Public propertyNonMeasuredAreasFillingRadius Gets or sets the pixel radius for the non-measured areas filling feature.
Public propertyOplMax 
Public propertyOplMin 
Public propertyPhaseColormap Gets or sets the color map of the phase image.
Public propertyPhaseCorrectionDegree 
Public propertyPhaseMeanValue Gets the mean value of the phase image (or its ROI). Call ComputePhaseStdDev first to compute it.
Public propertyPhaseMonitor 
Public propertyPhaseOffset Gets or sets the offset of the phase mask.
Public propertyPhaseProfile Gets the last phase profile extracted. See ExtractArbitraryPhaseProfile(Int32, Int32, Int32, Int32, Int32, Boolean, Boolean, Boolean, Single, Single).
Public propertyPhaseROIHeight 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.
Public propertyPhaseROILeft Gets the offset of the region of interest from the left of the image. (X coordinate of the top left corner of the ROI).
Public propertyPhaseROIStride 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.
Public propertyPhaseROITop Gets the offset of the region of interest from the top of the image. (Y coordinate of the top left corner of the ROI).
Public propertyPhaseROIWidth 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.
Public propertyPhaseStdDev Gets the standard deviation of the phase image (or its ROI). Call ComputePhaseStdDev first to compute it.
Public propertyPhaseUnit 
Public propertyPhMax 
Public propertyPhMin 
Public propertyReconstructedPhase 
Public propertyRefHoloUse Enables or disables the usage of a reference hologram for reconstruction
Public propertyResolutionDivider Gets the resolution division value of the current hologram image.
Public propertySpectrumKx 
Public propertySpectrumKy 
Public propertyStepAmpPhase 
Public propertyStepFinalPhaseImage 
Public propertyStepReconstructedPhase 
Public propertyTemporalPhaseAverageFramesNumber Gets of sets the number of frames to be averaged during the temporal averaging process.
Public propertyTransMicroscope Gets or sets the type of the miscroscope.
Public propertyUnwrap2D Toggles the 2D unwrapping.
Public propertyUnwrap2DMethod Gets or sets the method for unwrapping in 2D.
Public propertyUnwrapPhaseMonitorZones 
Public propertyUseHalfResolution Gets or sets the activation state of the half resolution feature.
Public propertyUseSpatialPhaseAverage Gets or sets the activation state of the spatial phase averaging.
Public propertyUseTemporalPhaseAverage 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.
Public propertyUseWavelengthFilter Gets a value indicating whether a wavelength filter is enabled.
Top
Methods
 NameDescription
Public methodAddPhaseCorrectionSegment Adds a new vertical or horizontal segment for the phase mask adjustment, then recomputes the fit. (Only for multi-segment phase correction method. The method needs at least one vertical and one horizontal segment). Call ComputePhaseMask to apply.
Public methodAddPhaseCorrectionZone Adds a phase correction zone, either rectangular or an ellipse. Call ComputePhaseMask to apply.
Public methodAddPhaseMonitorZone 
Public methodAddPhaseOffsetAdjustmentZone Adds a phase offset correction zone. (Valid only for the multi-zone phase offset method)
Public methodAutoComputePhaseMaskUsingSegments Performs an automatic adjustment of phase parameters, including crossed-terms, using an iterative method.
Public methodAutoComputePhaseMaskUsingZones Perform a 2D phase fit on a rectangular zone.
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.
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 
Public methodCutNewEllFourierRegion 
Public methodCutNewRectFourierRegion 
Public methodDisposeReleases all resources used by the SingleWavelengthReconstruction
Public methodDoAutoPhaseCorrectionNoCT 
Public methodDoMonitorPhaseZone 
Public methodDumpPhaseMonitor 
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 methodGetAvgRHBufHolo Gets a reference to the byte array to copy the reference hologram data when using several averaged holograms
Public methodCode exampleGetDistance Gets or 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 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 the reconstruction distance (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. Call AutoComputePhaseMaskUsingSegments(windowsList, phaseFitMethod, Int32, Boolean) to apply.
Public methodResetPhaseCorrectionZones Removes all phase correction zones. Call AutoComputePhaseMaskUsingZones(windowsList, phaseFitPolyBase, Int32, Boolean) to apply.
Public methodResetPhaseMask 
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 methodStatic memberSaveHologram(Hologram, String) Saves a hologram in TIFF format
Public methodStatic memberSaveHologram(Hologram, String, IHardwareConfiguration, IHolographicMeasurementConfig, Int32) Saves a hologram in TIFF format
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 methodCode exampleSetDistance 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 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 Enables/Disables and configures a filter applied to the complex wavefront (it influences both the phase and the amplitude image).
Public methodSignalNewImage 
Public methodSignalNewImage(Int32) 
Public methodUndoPhaseCorrectionSegment Removes the last phase correction segment added for a certain orientation, method and fitting degree, then recomputes the fit on the remaining segments. Call AutoComputePhaseMaskUsingSegments(windowsList, phaseFitMethod, Int32, Boolean) to apply.
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