EdgeDetection1D

StripeScanParams - CreateStripeScanParams_CreateFromValues

Creates a new StripeScanParams object.

IN

Name	Type	Description
InProfileInterpolation	Enum < InterpolationMethod1D >	Sub-pixel edge detection method.
InSmoothingStdDev	Float	Smoothing applied to the brightness profile. Range 〔0, +inf〕.
InMinMagnitude	Float	Minimum acceptable edge strength. Range 〔0, +inf〕.
InMaxInnerEdgeMagnitude	Float	Maximum strength of edges appearing between the two ends of a stripe. Range 〔-1, +inf〕. If negative, the parameter is neglected.
InStripePolarity	Enum < Polarity >	Polarity of the stripes that will be searched.
InMinStripeWidth	Float	Minimum acceptable stripe width, in pixels. Range 〔0, +inf〕.
InMaxStripeWidth	Float	Maximum acceptable stripe width, in pixels. Range 〔-1, +inf〕. If negative, the parameter is neglected.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutStripeScanParams	StripeScanParams	The StripeScanParams instance.
Error	ErrorState	Gets the execution error message

Stripe1D - CreateStripe1D_CreateFromValues

Creates a new Stripe1D object.

IN

Name	Type	Description
InPosition1	Float	Position of the first stripe point on the brightness profile.
InPosition2	Float	Position of the second stripe point on the brightness profile.
InWidth	Float	1D distance between the two points.
InMagnitude	Float	Magnitude of the stripe.
InPolarity	Enum < Polarity >	Polarity of the stripe.
InPoint1	Point2D	Position of the first stripe point on the image.
InPoint2	Point2D	Position of the second stripe point on the image.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutStripe1D	Stripe1D	The Stripe1D instance.
Error	ErrorState	Gets the execution error message

Stripe1D - GetCenter

Returns the center point of the stripe.

IN

Name	Type	Description
InStripe1D	Stripe1D	The input Stripe1D
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutPoint2D	Point2D	Center point.
Error	ErrorState	Gets the execution error message

ScanTemplate - IsEmpty

Checks whether the ScanTemplate is empty.

IN

Name	Type	Description
InScanTemplate	ScanTemplate	The input ScanTemplate
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutBool	Bool	True if it's empty, false otherwise.
Error	ErrorState	Gets the execution error message

SamplingParams - CreateSamplingParams_CreateFromValues

Creates a new SamplingParams object using the provided values.

IN

Name	Type	Description
InInterpolation	Enum < InterpolationMethod2D >	Method of sub-pixel image sampling.
InSamplingStep	Float	Distance between two consecutive sampling places on a path. Range 〔0.5, +inf〕.
InSampleCount	Int	Number of points at a single sampling place. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutSamplingParams	SamplingParams	The SamplingParams instance.
Error	ErrorState	Gets the execution error message

RidgeScanParams - CreateRidgeScanParams_CreateFromValues

Creates a new RidgeScanParams object.

IN

Name	Type	Description
InSmoothingStdDev	Float	Gaussian smoothing of the brightness profile. Range 〔0, +inf〕.
InMinMagnitude	Float	Minimum acceptable ridge strength. Range 〔0, +inf〕.
InRidgePolarity	Enum < Polarity >	Polarity of ridges that will be detected.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutRidgeScanParams	RidgeScanParams	The RidgeScanParams instance.
Error	ErrorState	Gets the execution error message

Ridge1D - CreateRidge1D_CreateFromValues

Creates a new Ridge1D object.

IN

Name	Type	Description
InPosition	Float	Position of the ridge on the brightness profile.
InMagnitude	Float	Magnitude of the ridge.
InPolarity	Enum < Polarity >	Polarity of the ridge.
InPoint	Point2D	Position of the ridge on the image.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutRidge1D	Ridge1D	The Ridge1D instance.
Error	ErrorState	Gets the execution error message

LocalBlindness - CreateLocalBlindness_CreateFromValues

Creates a new LocalBlindness object.

IN

Name	Type	Description
InRadius	Float	Blindness radius, in the range 〔0,+inf〕. Set to -1 equals +inf.
InThreshold	Float	The fraction of a strong edge magnitude that a weaker edge needs to be detected. Range 〔0, 1〕.
InFuzziness	Float	Decreases effective threshold linearly from 'Threshold' at distance 'Radius - Radius * Fuzziness' to zero at distance 'Radius + Radius * Fuzziness'. Range 〔0, 1〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutLocalBlindness	LocalBlindness	The LocalBlindness instance.
Error	ErrorState	Gets the execution error message

Gap1D - CreateGap1D_CreateFromValues

Creates a new Gap1D object.

IN

Name	Type	Description
InPoint1	Point2D	Starting point of the gap.
InPoint2	Point2D	Ending point of the gap
InWidth	Float	Distance between the two points.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutGap1D	Gap1D	The Gap1D instance.
Error	ErrorState	Gets the execution error message

EdgeScanParams - CreateEdgeScanParams_CreateFromValues

Creates a new EdgeScanParams object.

IN

Name	Type	Description
InProfileInterpolation	Enum < InterpolationMethod1D >	Sub-pixel edge detection method.
InSmoothingStdDev	Float	Smoothing applied to the brightness profile. Range 〔0, +inf〕.
InMinMagnitude	Float	Minimum acceptable edge strength. Range 〔0, +inf〕.
InEdgeTransition	Enum < EdgeTransition >	Type of edge transition that should be detected.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutEdgeScanParams	EdgeScanParams	The EdgeScanParams instance.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - BuildScanTemplate

Expands the scan path into a scanning template used to speed up 1D struct detection. Note: If the provided path is degenerate (i.e. its length is equal to zero) the function returns an empty ScanTemplate object. If the sampling step of the SamplingParams is lower than 0.5, the function fails.

IN

Name	Type	Description
InImageFormat	ImageFormat	Metadata of the input image.
InScanPath	Path	Path along which the edges are searched. The path should contain at least 2 points.
InScanWidth	Int	Width of the scan path 〔pixels〕. Range 〔1, +inf〕.
InSamplingParams	SamplingParams	Parameters used to control the sampling process.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutScanTemplate	ScanTemplate	The computed scan template object.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - FindEdges1D

Finds the points in which the image brightness change rapidly, along a scanning path.

IN

Name	Type	Description
InImage	Image	Input image. It cannot be empty.
InScanTemplate	ScanTemplate	The scan path expanded to some width. The object must be pre-computed using the buildScanTemplate function.
InEdgeScanParams	EdgeScanParams	Parameters used to control the edge scanning process.
InMinDistance	Float	When two consecutive edges have a distance lower than this value, the second one is neglected. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutEdge1D	Edge1DArray	Array containing all the found edges.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - FindEdges1D_Direct

Finds the points in which the image brightness change rapidly, along a scanning path. Note: This overload build the scan template at each function call. When the parameters used to build the scan template do not change in a loop, build the scan template separately and used the other overload.

IN

Name	Type	Description
InImage	Image	Input image. It cannot be empty.
InScanPath	Path	Path along which the edges are searched. The path should contain at least 2 points.
InScanWidth	Int	Width of the scan path 〔pixels〕. Range 〔1, +inf〕.
InSamplingParams	SamplingParams	Parameters used to control the sampling process.
InEdgeScanParams	EdgeScanParams	Parameters used to control the edge scanning process.
InMinDistance	Float	When two consecutive edges have a distance lower than this value, the second one is neglected. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutEdge1D	Edge1DArray	Array containing all the found edges.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - FindRidges1D

Finds the local maxima of the brightness profile along a scanning path.

IN

Name	Type	Description
InImage	Image	Input image. It cannot be empty.
InScanTemplate	ScanTemplate	The scan path expanded to some width. The object must be pre-computed using the buildScanTemplate function.
InRidgeScanParams	RidgeScanParams	Parameters used to control the ridge scanning process.
InMinDistance	Float	When two consecutive edges have a distance lower than this value, the second one is neglected. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutRidge1D	Ridge1DArray	Array containing all the found ridges.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - FindRidges1D_Direct

Finds the local maxima of the brightness profile along a scanning path. Note: This overload build the scan template at each function call. When the parameters used to build the scan template do not change in a loop, build the scan template separately and used the other overload.

IN

Name	Type	Description
InImage	Image	Input image. It cannot be empty.
InScanPath	Path	Path along which the ridges are searched. The path should contain at least 2 points.
InScanWidth	Int	Width of the scan path 〔pixels〕. Range 〔1, +inf〕.
InSamplingParams	SamplingParams	Parameters used to control the sampling process.
InRidgeScanParams	RidgeScanParams	Parameters used to control the ridge scanning process.
InMinDistance	Float	When two consecutive ridges have a distance lower than this value, the second one is neglected. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutRidge1D	Ridge1DArray	Array containing all the found ridges.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - FindStripes1D

Finds segments included between two edges of opposite transition.

IN

Name	Type	Description
InImage	Image	Input image. It cannot be empty.
InScanTemplate	ScanTemplate	The scan path expanded to some width. The object must be pre-computed using the buildScanTemplate function.
InStripeScanParams	StripeScanParams	Parameters used to control the stripe scanning process.
InMinGapWidth	Float	When two consecutive stripes have a distance lower than this value, the second one is neglected. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutStripe1D	Stripe1DArray	Array containing all the found stripes.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - FindStripes1D_Direct

Finds segments included between two edges of opposite transition. Note: This overload build the scan template at each function call. When the parameters used to build the scan template do not change in a loop, build the scan template separately and used the other overload.

IN

Name	Type	Description
InImage	Image	Input image. It cannot be empty.
InScanPath	Path	Path along which the stripes are searched. The path should contain at least 2 points.
InScanWidth	Int	Width of the scan path 〔pixels〕. Range 〔1, +inf〕.
InSamplingParams	SamplingParams	Parameters used to control the sampling process.
InStripeScanParams	StripeScanParams	Parameters used to control the stripe scanning process.
InMinGapWidth	Float	When two consecutive stripes have a distance lower than this value, the second one is neglected. Range 〔0, +inf〕.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutStripe1D	Stripe1DArray	Array containing all the found stripes.
Error	ErrorState	Gets the execution error message

EdgeDetection1D - TranslateScanTemplate

Translates the scan template along the provided vector. Note: This function provides performance benefits only for scan templates built using the Bilinear interpolation. If a NearestNeighbour scan template is provided, the object is completely rebuilt by the function, so there is no performance benefit.

IN

Name	Type	Description
IoScanTemplate	ScanTemplate	ScanTemplate that will be translated. The object cannot be empty.
InDelta	Vector2D	Translation vector.
InInverse	Bool	If true, the translation vector is inverted.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoScanTemplate	ScanTemplate	The modified Core.Data.Types.ScanTemplate
Error	ErrorState	Gets the execution error message

Edge1D - CreateEdge1D_CreateFromValues

Creates a new Edge1D object.

IN

Name	Type	Description
InPosition	Float	Position of the edge on the brightness profile.
InMagnitude	Float	Magnitude of the edge.
InTransition	Enum < EdgeTransition >	Type of transition the edge is describing.
InPoint	Point2D	Position of the edge on the image.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutEdge1D	Edge1D	The Edge1D instance.
Error	ErrorState	Gets the execution error message