Lyncee Tec SDK Documentation
LynceeTec.Processing.Holography
SingleWavelengthReconstruction Class
SingleWavelengthReconstruction Methods
AddPhaseCorrectionSegment Method
AddPhaseCorrectionZone Method
AddPhaseMonitorZone Method
AddPhaseOffsetAdjustmentZone Method
AutoComputePhaseMaskUsingSegments Method
AutoComputePhaseMaskUsingZones Method
ComputePhaseHistogram Method
ComputePhaseMask Method
ComputePhaseStdDev Method
ConfigureProcessing Method
CopyAmp32fToMemStream Method
CopyAmpToMemStream Method
CopyHoloToMemStream Method
CopyHoloToRH Method
CopyImg32fResult Method
CopyImgResult Method
CopyPhase32fToMemStream Method
CopyPhaseToMemStream Method
CreateStitching Method
CutNewEllFourierRegion Method
CutNewRectFourierRegion Method
Dispose Method
DoAutoPhaseCorrectionNoCT Method
DoMonitorPhaseZone Method
DumpPhaseMonitor Method
ExtractArbitraryIntensityProfile Method
ExtractArbitraryPhaseProfile Method
ExtractProfile Method
ExtractROI Method
GetAmp32f Method
GetAvgRHBufHolo Method
GetDistance Method
GetNumFourierFilters Method
GetOplValue Method
GetPhase32f Method
GetPhaseCorrectionCoefficient Method
getPhaseHistogram Method
GetPhaseValue Method
InitProcessingChain Method
LoadFourierRegion Method
LoadPhaseOffsetAdjustmentZones Method
LoadRefHolo Method
OnDistanceChange Method
OnNewImage Method
ParsePhaseOffsetAdjustmentZones Method
PerformAutoFocus Method
PhaseToHeightNmConversionFactor Method
Process Method
RecomputePostProcessing Method
RecomputeSpectrumKxKy Method
ReconstructFile Method
ReconstructSequence Method
RedoFourierFilter Method
RefreshAmplitude Method
RefreshFourier Method
RefreshIntensityPhase Method
RefreshPhase Method
RemoveLastFourierFilter Method
ResetFourierRegions Method
ResetPhaseCorrectionSegments Method
ResetPhaseCorrectionZones Method
ResetPhaseMask Method
ResetPhaseMonitorZones Method
ResetPhaseOffsetAdjustmentZones Method
ResetROI Method
ResetTemporalPhaseAverage Method
SaveFourierRegion Method
SaveHologram Method
SaveImage Method
SaveImageFloat Method
SavePhaseOffsetAdjustmentZones Method
SaveRefHolo Method
SetDistance Method
SetHoloRHListSize Method
SetPhaseCorrectionCoefficient Method
SetSpectrumKxKy Method
SetSpTilt Method
SetWavelengthFilterParameters Method
SignalNewImage Method
UndoPhaseCorrectionSegment Method
UseCurrentHoloAsRef Method
Click or drag to resize

SingleWavelengthReconstructionExtractArbitraryPhaseProfile Method

Extracts a profile in the phase image. Use PhaseProfile to get the result.

Namespace:  LynceeTec.Processing.Holography
Assembly:  LynceeTec.InterfaceProcessing (in LynceeTec.InterfaceProcessing.dll) Version: 0.0.0.0
Syntax
Copy
public virtual int ExtractArbitraryPhaseProfile(
	int startx,
	int starty,
	int endx,
	int endy,
	int avgWidth,
	bool unwrap,
	bool toOPL,
	bool scaleXY,
	float umppx,
	float umppy
)

Parameters

startx
Type: SystemInt32
The X coordinate of the starting point.
starty
Type: SystemInt32
The Y coordinate of the starting point.
endx
Type: SystemInt32
The X coordinate of the ending point.
endy
Type: SystemInt32
The Y coordinate of the ending point.
avgWidth
Type: SystemInt32
The width of the profile in pixels, to average the measurement.
unwrap
Type: SystemBoolean
If true, phase unwrapping is applied and nearest-neighbor interpolation is used. If false bilinear interpolation is used, without unwrapping.
toOPL
Type: SystemBoolean
If true, the phase is converted to optical path length in [nm], if false it remains in [°].
scaleXY
Type: SystemBoolean
If true, returns the X and Y data in [m], if false scale is in pixels.
umppx
Type: SystemSingle
The real size in [m] corresponding to the width of a pixel in the image, in the X direction.
umppy
Type: SystemSingle
The real size in [m] corresponding to the width of a pixel in the image, in the Y direction.

Return Value

Type: Int32
Negative value in case of an error, length of the profile otherwise.

Implements

IReconstructionExtractArbitraryPhaseProfile(Int32, Int32, Int32, Int32, Int32, Boolean, Boolean, Boolean, Single, Single)
Exceptions
ExceptionCondition
ProcessingExceptionIf an error occurs during extraction
See Also