Click or drag to resize

ProcessingConfiguration Class

Defines all the parameters related to the reconstruction process.
Inheritance Hierarchy
SystemObject
  LynceeTec.InterfaceProcessingV2.ConfigurationsProcessingConfiguration

Namespace: LynceeTec.InterfaceProcessingV2.Configurations
Assembly: LynceeTec.InterfaceProcessingV2 (in LynceeTec.InterfaceProcessingV2.dll) Version: 0.0.0.0
Syntax
Copy
public class ProcessingConfiguration : IEquatable<ProcessingConfiguration>, 
	IDisposable

The ProcessingConfiguration type exposes the following members.

Constructors
 NameDescription
Public methodProcessingConfigurationInitializes a new instance of the ProcessingConfiguration class
Top
Properties
 NameDescription
Public propertyAutoFocusDeltaDistance_m Gets or sets the distance around the current reconstruction distance in which the auto-focus search is performed.
Public propertyAutoFocusTolerance_m Gets or sets the tolerance of the auto-focus method.
Public propertyMaximizeAutoFocusContrast Enables or disables the contrast maximization during auto-focus process.
Public propertyPhaseCalibrationDegree Gets or sets the phase correction degree for calibration mode.
Public propertyPhaseCorrectionDegree Gets or sets the correction degree for the phase fitting.
Public propertyPhaseCorrectionDegrees Gets or sets specific correction degrees for the phase fitting.
Public propertyPhaseFittingTool Gets or sets the phase fitting tool used to perform phase correction.
Public propertyPhaseSegmentFittingMethod Gets or sets the phase fitting method used with segments correction.
Public propertyPhaseZoneFittingPolynomialBasis Gets or sets the phase fitting polynomial basis to perform phase correction using zones only.
Public propertyReconstructionDistance_m Gets or sets the reconstruction distance in meter.
Public propertyRollingTemporalAveragingWindowSize Enables or disables rolling temporal averaging.
Public propertySaveFrequencySpectrum Enables or disables the export of frequency spectrum image.
Public propertySaveReconstructedPhaseIntensity Enables or disables the export of reconstructed phase and intensity images. Those images are extracted before the post-processing.
Public propertySpectrumCenteringKx Defines the Kx parameter centering the frequency spectrum in width direction.
Public propertySpectrumCenteringKy Defines the Ky parameter centering the frequency spectrum in height direction.
Public propertySpectrumCenteringMethod Gets or sets the frequency spectrum centering method when no reference hologram is used.
Public propertyUpdateConfigurationCoefficients Enables or disables the application of coefficients to the config.
Public propertyUseAmplitudeDivision Enables or disables amplitude division of the reference hologram in reconstruction process.
Public propertyUseAutoFocus Enables or disables the auto-focus for each reconstructed hologram.
Public propertyUseAutoSpectrumCentering Enables or disables the automatic frequency spectrum centering when no reference hologram is used.
Public propertyUseCalibrationPhaseCorrection Enables or disables calibration phase correction which performs phase correction independently on each source.
Public propertyUseContinuousPhaseCorrection Enables or disables continuous phase correction which performs phase correction on each frame.
Public propertyUseManualFrequencySpectrumFiltering Enables or disables the manual frequency spectrum filter defined by the user.
Public propertyUsePhaseAutoFocus Uses the phase when performing the auto-focus.
Public propertyUseReferenceHologram Enables or disables reference hologram in reconstruction process.
Public propertyUseRollingTemporalAveraging Sets the window size for rolling temporal averaging. Default value is 1 (which disables the averaging).
Public propertyUseShortSyntheticWavelength Enables or disables the short synthetic wavelength computation.
Top
Methods
 NameDescription
Public methodAddFrequencySpectrumFilterShape Adds a shape to the list of shapes defining the frequency spectrum filter for the specified source.
Public methodAddPhaseCorrectionSegment Adds a phase correction segment to the existing ones.
Public methodAddPhaseCorrectionZone Adds a phase correction zone to the existing ones.
Public methodDisposeReleases all resources used by the ProcessingConfiguration
Public methodEqualsIndicates whether the current object is equal to another object of the same type.
Public methodGetAutoFocusDistance_m Gets auto focus reconstruction distance at index position in the scan
Public methodGetAutoFocusMean Gets auto focus Mean at index position in the scan
Public methodGetAutoFocusNumberOfSteps Gets the number of steps in the auto focus scan
Public methodGetAutoFocusRoi Gets the region of interest in which the auto-focus must be performed.
Public methodGetAutoFocusSTD Gets auto focus STD at index position in the scan
Public methodGetFrequencySpectrumFilterShapes Gets the list of shapes defining the frequency spectrum filter for the specified source.
Public methodGetPhaseCalibrationCoefficient Gets the calibration phase correction coefficient for the specified order.
Public methodGetPhaseContinuousCoefficient Gets the user phase continuous coefficient for the specified order.
Public methodGetPhaseCorrectionCoefficient Gets the user phase correction coefficient for the specified order.
Public methodGetPhaseCorrectionSegments Gets an array containing the user defined phase correction segments.
Public methodGetPhaseCorrectionZones Gets an array containing the user defined phase correction zones.
Public methodGetRoi Gets the region of interest (ROI) defined on phase and intensity images.
Public methodLoadReferenceHologram(PhysicalLaserSource, String) Loads the reference hologram for the specified source from a path location.
Public methodLoadReferenceHologram(PhysicalLaserSource, Byte, Int32, Int32) Loads the reference hologram for the specified source from byte array.
Public methodResetAutoFocusRoi Resets the region of interest to the maximum size.
Public methodResetFrequencySpectrumFilterShapes Erases all the shapes added to the list of shapes defining the frequency spectrum filter for the specified source.
Public methodResetPhaseCalibrationCoefficients Removes all phase calibration coefficients.
Public methodResetPhaseContinuousCoefficients Removes all phase continuous coefficients.
Public methodResetPhaseCorrectionCoefficients Removes all phase correction coefficients.
Public methodResetPhaseCorrectionSegments Deletes all the phase correction segments.
Public methodResetPhaseCorrectionZones Deletes all the phase correction segments.
Public methodSaveReferenceHologram Saves the reference hologram for the specified source to a .bin file.
Public methodSetAutoFocusRoi Sets the region of interest in which the auto-focus must be performed.
Public methodSetFrequencySpectrumFilterShapes Sets the list of shapes defining the frequency spectrum filter for the specified source.
Public methodSetPhaseCalibrationCoefficient Sets the calibration phase correction coefficient for the specified order.
Public methodSetPhaseContinuousCoefficient Sets the user phase continuous coefficient for the specified order.
Public methodSetPhaseCorrectionCoefficient Sets the user phase correction coefficient for the specified order.
Public methodSetPhaseCorrectionSegments Sets an array containing the user defined phase correction segments.
Public methodSetPhaseCorrectionZones Sets an array containing the user defined phase correction zones.
Public methodSetRoi Sets the region of interest (ROI) to be extracted on phase and intensity images.
Public methodUndoFrequencySpectrumFilterShape Removes the last shape added to the list of shapes defining the frequency spectrum filter for the specified source.
Public methodUndoPhaseCorrectionSegment Remove the last phase correction segment added.
Public methodUndoPhaseCorrectionZone Remove the last phase correction zone added.
Public methodUseOneShotPhaseCorrection Enables OneShot phase correction for next reconstruction.
Top
See Also