Functions
Point2D	oevislib_net.Image.GetAnchoredPoint (Anchor2D inPointAnchor)
	Returns one of the 9 anchor points of an image (corners or mid-points).
Box	oevislib_net.Image.GetBox ()
	Returns the box representing the Image's border.
Array< float >	oevislib_net.Image.GetPixelValues (Optional< Region > inRoi=null)
	Extracts the array of pixels present in the image (or in the specified region).
Histogram	oevislib_net.Image.GetHistogram (int inChannelIndex, Optional< Region > inRoi=null, float inDomainBegin=0.0f, int inBinCount=256, float inBinSize=1.0f)
	Creates the histogram from the image's pixel distribution.
float	oevislib_net.Image.GetMoment (ImageMoment inMomentType, bool inCentral=false, Optional< Region > inRoi=null)
	Computes the selected moment of the image.
float	oevislib_net.Image.GetNormMoment (ImageMoment inMomentType, bool inCentral=false, Optional< Region > inRoi=null)
	Computes the selected normalized moment of the image.
float	oevislib_net.Image.GetOrientation (Optional< Region > inRoi=null)
	Returns the image's orientation (based on its moments).
Profile	oevislib_net.Image.GetProjection (Optional< Region > inRoi, ProjectionDirection inProjectionDirection, ProjectionCombination inProjectionCombination)
	Computes the average (or another pixel combination) for each image row or column and merges it into a profile.
Profile	oevislib_net.Image.GetProfileAlongPath (Path inScanPath, Optional< UCS2D > inScanPathAlignment, int inScanWidth, SamplingParams inSamplingParams, float inSmoothingStdDev, AccumulationMode inAccumulationMode, Pixel inBorderColor, Optional< Path > outPath, Optional< Path > outAlignedScanPath, Optional< Array< Path > > outSamplingPoints, Optional< float > outSamplingStep)
	Returns the profile based on the image's pixels found on the specified path.
Profile	oevislib_net.Image.GetProfileAlongPath (ScanTemplate inScanTemplate, float inSmoothingStdDev, AccumulationMode inAccumulationMode, Pixel inBorderColor, Optional< Path > outPath)
	Returns the profile of the image's pixels specified by the scan template in input.
Point2D	oevislib_net.Image.GetMassCenter (Optional< Region > inRoi=null)
	Computes the mass center (based on the image's moments).
Array< Extremum2D >	oevislib_net.Image.GetLocalMinima (bool inConsiderLowlands, Optional< Region > inRoi, Optional< float > inMinValue, Optional< float > inMaxValue, float inMinDistance, Optional< Array< Region > > outMinimaRegions)
	Search for the local minima in the image.
Array< Extremum2D >	oevislib_net.Image.GetLocalMaxima (bool inConsiderLowlands, Optional< Region > inRoi, Optional< float > inMinValue, Optional< float > inMaxValue, float inMinDistance, Optional< Array< Region > > outMaximaRegions)
	Search for the local maxima in the image.
Point2D	oevislib_net.Image.GetCenter ()
	Returns the geometrical center of the image.
float	oevislib_net.Image.GetSharpness (Optional< Box > inRoi=null)
	Returns the sharpness of the image.
float	oevislib_net.Image.GetStdDev (Optional< Region > inRoi=null)
	Computes the standard deviation of image pixel values.

Extremum2D Features
See also Features
	oevislib_net.Extremum2D.Extremum2D ()
	Constructs a new Extremum2D object with default values.
	oevislib_net.Extremum2D.Extremum2D (Point2D inPoint, float inValue, Polarity inPolarity)
	Creates a new Extremum2D object.

Detailed Description

Function Documentation

◆ Extremum2D() [1/2]

oevislib_net.Extremum2D.Extremum2D ( )

inline

Constructs a new Extremum2D object with default values.

◆ Extremum2D() [2/2]

oevislib_net.Extremum2D.Extremum2D	(	Point2D	inPoint,
		float	inValue,
		Polarity	inPolarity )

inline

Creates a new Extremum2D object.

Parameters

inPoint	Position with subpixel-precision.
inValue	Value.
inPolarity	Polarity (a dark pixel if the extremum represents a minimum, a bright one otherwise).

◆ GetAnchoredPoint()

Point2D oevislib_net.Image.GetAnchoredPoint ( Anchor2D inPointAnchor )

inline

Returns one of the 9 anchor points of an image (corners or mid-points).

Parameters

inPointAnchor Anchor point to extract.

Returns: Output point.

◆ GetBox()

Box oevislib_net.Image.GetBox ( )

inline

Returns the box representing the Image's border.

Returns: Image's box.

◆ GetCenter()

Point2D oevislib_net.Image.GetCenter ( )

inline

Returns the geometrical center of the image.

Returns: Center.

◆ GetHistogram()

Histogram oevislib_net.Image.GetHistogram	(	int	inChannelIndex,
		Optional< Region >	inRoi = null,
		float	inDomainBegin = 0::0f,
		int	inBinCount = 256,
		float	inBinSize = 1::0f )

inline

Creates the histogram from the image's pixel distribution.

Parameters

inChannelIndex	Selected channel. Range: [0, 3].
inRoi	Region of interest.
inDomainBegin	The lowest value to consider in the histogram.
inBinCount	The number of histogram bars.
inBinSize	Width of a single histogram bin. Range: (0, +inf).

Returns: Output histogram.

◆ GetLocalMaxima()

Array< Extremum2D > oevislib_net.Image.GetLocalMaxima	(	bool	inConsiderLowlands,
		Optional< Region >	inRoi,
		Optional< float >	inMinValue,
		Optional< float >	inMaxValue,
		float	inMinDistance,
		Optional< Array< Region > >	outMaximaRegions )

inline

Search for the local maxima in the image.

If the image has more than one channel, the channels' sum is considered to obtain a monochromatic image.

Parameters

inConsiderLowlands	Whether to consider local maxima zones with more than one pixel equal to the maxima.
inRoi	Region of interest.
inMinValue	Minimal value to consider as maxima.
inMaxValue	Maximal value to consider as maxima.
inMinDistance	Minimal distance between two found maxima. Range: [0, +inf).
outMaximaRegions	Regions of local maxima.

Returns: Found local maxima.

◆ GetLocalMinima()

Array< Extremum2D > oevislib_net.Image.GetLocalMinima	(	bool	inConsiderLowlands,
		Optional< Region >	inRoi,
		Optional< float >	inMinValue,
		Optional< float >	inMaxValue,
		float	inMinDistance,
		Optional< Array< Region > >	outMinimaRegions )

inline

Search for the local minima in the image.

If the image has more than one channel, the channels' sum is considered to obtain a monochromatic image.

Parameters

inConsiderLowlands	Whether to consider local minima zones with more than one pixel equal to the minima.
inRoi	Region of interest.
inMinValue	Minimal value to consider as minima.
inMaxValue	Maximal value to consider as minima.
inMinDistance	Minimal distance between two found minima. Range: [0, +inf).
outMinimaRegions	Regions of local minima.

Returns: Found local minima.

◆ GetMassCenter()

Point2D oevislib_net.Image.GetMassCenter ( Optional< Region > inRoi = null )

inline

Computes the mass center (based on the image's moments).

Parameters

inRoi Region of interest.

Returns: Mass center.

◆ GetMoment()

float oevislib_net.Image.GetMoment	(	ImageMoment	inMomentType,
		bool	inCentral = false,
		Optional< Region >	inRoi = null )

inline

Computes the selected moment of the image.

Parameters

inMomentType	Type of moment.
inCentral	Whether to compute the central moment or not.
inRoi	Region of interest.

Returns: Moment.

◆ GetNormMoment()

float oevislib_net.Image.GetNormMoment	(	ImageMoment	inMomentType,
		bool	inCentral = false,
		Optional< Region >	inRoi = null )

inline

Computes the selected normalized moment of the image.

Parameters

inMomentType	Type of moment.
inCentral	Whether to compute the central moment or not.
inRoi	Region of interest.

Returns: Normalized moment.

◆ GetOrientation()

float oevislib_net.Image.GetOrientation ( Optional< Region > inRoi = null )

inline

Returns the image's orientation (based on its moments).

The resulting angle is in the range [0, 180].

Parameters

inRoi Region of interest.

Returns: Orientation angle.

◆ GetPixelValues()

Array< float > oevislib_net.Image.GetPixelValues ( Optional< Region > inRoi = null )

inline

Extracts the array of pixels present in the image (or in the specified region).

Parameters

inRoi Region of interest.

Returns: Pixels' values.

◆ GetProfileAlongPath() [1/2]

Profile oevislib_net.Image.GetProfileAlongPath	(	Path	inScanPath,
		Optional< UCS2D >	inScanPathAlignment,
		int	inScanWidth,
		SamplingParams	inSamplingParams,
		float	inSmoothingStdDev,
		AccumulationMode	inAccumulationMode,
		Pixel	inBorderColor,
		Optional< Path >	outPath,
		Optional< Path >	outAlignedScanPath,
		Optional< Array< Path > >	outSamplingPoints,
		Optional< float >	outSamplingStep )

inline

Returns the profile based on the image's pixels found on the specified path.

First it creates a series of segments across the scan path, then computes the average pixel on each of the segments and use them to create the final profile.

Parameters

inScanPath	Path along which the profile is extracted.
inScanPathAlignment	Aligns the path on the object to inspect.
inScanWidth	Width (in pixels) of the scan path. Range: [1, +inf).
inSamplingParams	Parameters controlling the sampling process.
inSmoothingStdDev	Standard deviation of the Gaussian smoothing (applied on the obtained profile). Range: [0, +inf).
inAccumulationMode	How the pixel values are combined (average, median, middle, minimum, maximum or sum).
inBorderColor	Pixel value to consider outside the image (used whether the scan path touches an extremity of the image).
outPath	Points from which the resulting profile is extracted (after considering the width and the sampling parameters).
outAlignedScanPath	Scan path after alignment (in the image coordinates).
outSamplingPoints	Array of paths, each one containing the sampling points that contributed to a single value of the extracted profile.
outSamplingStep	Distance between consecutive sampling points on the scan path.

Returns: Output profile.

◆ GetProfileAlongPath() [2/2]

Profile oevislib_net.Image.GetProfileAlongPath	(	ScanTemplate	inScanTemplate,
		float	inSmoothingStdDev,
		AccumulationMode	inAccumulationMode,
		Pixel	inBorderColor,
		Optional< Path >	outPath )

inline

Returns the profile of the image's pixels specified by the scan template in input.

First it creates a series of segments across the scan path, then computes the average pixel on each of the segments and use them to create the final profile.

Parameters

inScanTemplate	Defines the path along which the profile is extracted.
inSmoothingStdDev	Standard deviation of the Gaussian smoothing (applied on the obtained profile). Range: [0, +inf).
inAccumulationMode	How the pixel values are combined (average, median, middle, minimum, maximum or sum).
inBorderColor	Pixel value to consider outside the image (used whether the scan path touches an extremity of the image).
outPath	Points from which the resulting profile is extracted (after considering the width and the sampling parameters).

Returns: Output profile.

◆ GetProjection()

Profile oevislib_net.Image.GetProjection	(	Optional< Region >	inRoi,
		ProjectionDirection	inProjectionDirection,
		ProjectionCombination	inProjectionCombination )

inline

Computes the average (or another pixel combination) for each image row or column and merges it into a profile.

Parameters

inRoi	Region of interest.
inProjectionDirection	Whether to combine the pixel values horizontally or vertically.
inProjectionCombination	How the pixel values are merged (average, median, middle, minimum, maximum or sum).

Returns: Output profile.

◆ GetSharpness()

float oevislib_net.Image.GetSharpness ( Optional< Box > inRoi = null )

inline

Returns the sharpness of the image.

The bigger the value the sharper the image.

Parameters

inRoi Region of interest.

Returns: Sharpness value.

◆ GetStdDev()

float oevislib_net.Image.GetStdDev ( Optional< Region > inRoi = null )

inline

Computes the standard deviation of image pixel values.

Parameters

inRoi Region of interest.

Returns: Standard deviation.

Functions

Extremum2D Features

Detailed Description

Function Documentation

◆ Extremum2D() [1/2]

◆ Extremum2D() [2/2]

◆ GetAnchoredPoint()

◆ GetBox()

◆ GetCenter()

◆ GetHistogram()

◆ GetLocalMaxima()

◆ GetLocalMinima()

◆ GetMassCenter()

◆ GetMoment()

◆ GetNormMoment()

◆ GetOrientation()

◆ GetPixelValues()

◆ GetProfileAlongPath() [1/2]

◆ GetProfileAlongPath() [2/2]

◆ GetProjection()

◆ GetSharpness()

◆ GetStdDev()