CVB.Net 15.0
Analyze Class Reference

A collection functions available in the Common Vision Blox Image Manager for analyzing image content. More...

Static Public Member Functions

static int[] Histogram (this ImagePlane plane)
 Gather and return the histogram from an 8 bits per pixel unsigned image plane . More...
 
static int[] Histogram (this ImagePlane plane, double density)
 Gather and return the histogram from an 8 bits per pixel unsigned image plane . More...
 
static int[] Histogram (this ImagePlane plane, Area2D aoi)
 Gather and return the histogram from an 8 bits per pixel unsigned image plane . More...
 
static int[] Histogram (this ImagePlane plane, Area2D aoi, double density)
 Gather and return the histogram from an 8 bits per pixel unsigned image plane . More...
 
static LocalMaximum[] FindLocalMaxima (this ImagePlane plane, int locality, double threshold, Rect aoi)
 Find local maxima in the input image plane . More...
 
static LocalMaximum[] FindLocalMaxima (this ImagePlane plane, int locality, double threshold)
 Find local maxima in the input image plane . More...
 
static LocalMaximum[] FindLocalMaxima (this ImagePlane plane, int locality, double threshold, Rect aoi, SubPixelMode mode, Neighborhood radius)
 Find sub pixel accurate local maxima in the input image plane . Sub pixel accuracy is achieved by assuming a Gaussian or parabolic gray value distribution around a local maximum that can be fitted into the image data. More...
 
static LocalMaximum[] FindLocalMaxima (this ImagePlane plane, int locality, double threshold, SubPixelMode mode, Neighborhood radius)
 Find sub pixel accurate local maxima in the input image plane . Sub pixel accuracy is achieved by assuming a Gaussian or parabolic gray value distribution around a local maximum that can be fitted into the image data. More...
 

Detailed Description

A collection functions available in the Common Vision Blox Image Manager for analyzing image content.

Member Function Documentation

◆ FindLocalMaxima() [1/4]

static LocalMaximum[] FindLocalMaxima ( this ImagePlane  plane,
int  locality,
double  threshold 
)
static

Find local maxima in the input image plane .

Parameters
planeImage plane in which to look for maxima
localityMinimum distance between two valid maxima; if two maxima fall within this distance (measured using the L1 norm), the one with the lower gray value will be removed from the result list
thresholdMinimum gray value a local maximum must have for being reported. Note that the minimal possible value for the image's pixel type is never eligible to be a local maximum (e.g. if the image uses 8 bits per pixel unsigned, pixels with value 0 will never be a local maximum even if the threshold has been set to 0.
Returns
List of the local maxima that have been found
Exceptions
ObjectDisposedExceptionIf the plane to work on has already been disposed

◆ FindLocalMaxima() [2/4]

static LocalMaximum[] FindLocalMaxima ( this ImagePlane  plane,
int  locality,
double  threshold,
Rect  aoi 
)
static

Find local maxima in the input image plane .

Parameters
planeImage plane in which to look for maxima
aoiRegion of interest in which to look for maxima
localityMinimum distance between two valid maxima; if two maxima fall within this distance (measured using the L1 norm), the one with the lower gray value will be removed from the result list
thresholdMinimum gray value a local maximum must have for being reported. Note that the minimal possible value for the image's pixel type is never eligible to be a local maximum (e.g. if the image uses 8 bits per pixel unsigned, pixels with value 0 will never be a local maximum even if the threshold has been set to 0.
Returns
List of the local maxima that have been found
Exceptions
ObjectDisposedExceptionIf the plane to work on has already been disposed

◆ FindLocalMaxima() [3/4]

static LocalMaximum[] FindLocalMaxima ( this ImagePlane  plane,
int  locality,
double  threshold,
Rect  aoi,
SubPixelMode  mode,
Neighborhood  radius 
)
static

Find sub pixel accurate local maxima in the input image plane . Sub pixel accuracy is achieved by assuming a Gaussian or parabolic gray value distribution around a local maximum that can be fitted into the image data.

Parameters
planeImage plane in which to look for maxima
aoiRegion of interest in which to look for maxima
localityMinimum distance between two valid maxima; if two maxima fall within this distance (measured using the L1 norm), the one with the lower gray value will be removed from the result list
thresholdMinimum gray value a local maximum must have for being reported. Note that the minimal possible value for the image's pixel type is never eligible to be a local maximum (e.g. if the image uses 8 bits per pixel unsigned, pixels with value 0 will never be a local maximum even if the threshold has been set to 0.
modeMode to be used for determining sub pixel accuracy (see description of SubPixelMode values)
radiusNeighborhood to take account in the sub pixel calculation (see description of Neighborhood values)
Returns
List of the local maxima that have been found
Exceptions
ObjectDisposedExceptionIf the plane to work on has already been disposed
InvalidOperationExceptionwhen trying to combine SubPixelMode.ParabolicFast with a neighborhood other than Neighborhood.Use3x3

◆ FindLocalMaxima() [4/4]

static LocalMaximum[] FindLocalMaxima ( this ImagePlane  plane,
int  locality,
double  threshold,
SubPixelMode  mode,
Neighborhood  radius 
)
static

Find sub pixel accurate local maxima in the input image plane . Sub pixel accuracy is achieved by assuming a Gaussian or parabolic gray value distribution around a local maximum that can be fitted into the image data.

Parameters
planeImage plane in which to look for maxima
localityMinimum distance between two valid maxima; if two maxima fall within this distance (measured using the L1 norm), the one with the lower gray value will be removed from the result list
thresholdMinimum gray value a local maximum must have for being reported. Note that the minimal possible value for the image's pixel type is never eligible to be a local maximum (e.g. if the image uses 8 bits per pixel unsigned, pixels with value 0 will never be a local maximum even if the threshold has been set to 0.
modeMode to be used for determining sub pixel accuracy (see description of SubPixelMode values)
radiusNeighborhood to take account in the sub pixel calculation (see description of Neighborhood values)
Returns
List of the local maxima that have been found
Exceptions
ArgumentNullExceptionIf the Parent of plane is null
ObjectDisposedExceptionIf the plane to work on has already been disposed
InvalidOperationExceptionwhen trying to combine SubPixelMode.ParabolicFast with a neighborhood other than Neighborhood.Use3x3

◆ Histogram() [1/4]

static int[] Histogram ( this ImagePlane  plane)
static

Gather and return the histogram from an 8 bits per pixel unsigned image plane .

Parameters
planePlane to gather the histogram from.
Returns
Histogram as an array of 256 integer values
Exceptions
ObjectDisposedExceptionIf the Parent of plane has already been disposed
CvbExceptionwhen calling this method on an image plane of inappropriate data type

◆ Histogram() [2/4]

static int[] Histogram ( this ImagePlane  plane,
Area2D  aoi 
)
static

Gather and return the histogram from an 8 bits per pixel unsigned image plane .

Parameters
planePlane to gather the histogram from
aoiArea in which to gather the histogram
Returns
Histogram as an array of 256 integer values
Exceptions
ArgumentNullExceptionIf the Parent of plane is null
ObjectDisposedExceptionIf the Parent of plane has already been disposed
CvbExceptionwhen calling this method on an image plane of inappropriate data type

◆ Histogram() [3/4]

static int[] Histogram ( this ImagePlane  plane,
Area2D  aoi,
double  density 
)
static

Gather and return the histogram from an 8 bits per pixel unsigned image plane .

Parameters
planePlane to gather the histogram from
densityScan density to gather the histogram with; must be in the range [0...1]; lower densities result in higher processing speed, but will also yield histograms which are notably jagged due to the poor statistics
aoiArea in which to gather the histogram
Returns
Histogram as an array of 256 integer values
Exceptions
ArgumentNullExceptionIf the Parent of plane is null
ObjectDisposedExceptionIf the Parent of plane has already been disposed
ArgumentOutOfRangeExceptionIf the density parameter exceeds the range [0...1]
CvbExceptionwhen calling this method on an image plane of inappropriate data type

◆ Histogram() [4/4]

static int[] Histogram ( this ImagePlane  plane,
double  density 
)
static

Gather and return the histogram from an 8 bits per pixel unsigned image plane .

Parameters
planePlane to gather the histogram from
densityScan density to generate the histogram. It must be in the range [0...1]. Lower densities result in higher processing speed, but will also yield histograms, which are notably jagged due to the poor statistics.
Returns
Histogram as an array of 256 integer values
Exceptions
ObjectDisposedExceptionIf the Parent of plane has already been disposed
CvbExceptionwhen calling this method on an image plane of inappropriate data type