 | SingleWavelengthReconstructionExtractArbitraryPhaseProfile Method |
Extracts a profile in the phase image. Use
PhaseProfile to get the result.
Namespace: LynceeTec.Processing.HolographyAssembly: LynceeTec.InterfaceProcessing (in LynceeTec.InterfaceProcessing.dll) Version: 0.0.0.0
Syntaxpublic virtual int ExtractArbitraryPhaseProfile(
int startx,
int starty,
int endx,
int endy,
int avgWidth,
bool unwrap,
bool toOPL,
bool scaleXY,
float umppx,
float umppy
)
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 Int32
- The X coordinate of the starting point.
- starty Int32
- The Y coordinate of the starting point.
- endx Int32
- The X coordinate of the ending point.
- endy Int32
- The Y coordinate of the ending point.
- avgWidth Int32
- The width of the profile in pixels, to average the measurement.
- unwrap Boolean
- If true, phase unwrapping is applied and nearest-neighbor interpolation is used. If false bilinear interpolation is used, without unwrapping.
- toOPL Boolean
- If true, the phase is converted to optical path length in [nm], if false it remains in [°].
- scaleXY Boolean
- If true, returns the X and Y data in [m], if false scale is in pixels.
- umppx Single
- The real size in [m] corresponding to the width of a pixel in the image, in the X direction.
- umppy Single
- The real size in [m] corresponding to the width of a pixel in the image, in the Y direction.
Return Value
Int32Negative value in case of an error, length of the profile otherwise.
Implements
IReconstructionExtractArbitraryPhaseProfile(Int32, Int32, Int32, Int32, Int32, Boolean, Boolean, Boolean, Single, Single)
Exceptions
See Also