Functionality for analyzing the Histogram of images (previously found in the LightMeter tool). More...

Static Public Member Functions
static Histogram	Create (ImagePlane plane)
	Create a histogram for the whole plane . More...

static Histogram	Create (ImagePlane plane, double density)
	Create a histogram for the whole plane . More...

static Histogram	Create (ImagePlane plane, Rect aoi)
	Creates a histogram for the aoi in the given plane . More...

static Histogram	Create (ImagePlane plane, Rect aoi, double density)
	Creates a histogram for the aoi in the given plane . More...

static Histogram	Create (ImagePlane plane, Area2D aoi)
	Creates a histogram for the aoi in the given plane . More...

static Histogram	Create (ImagePlane plane, Area2D aoi, double density)
	Creates a histogram for the aoi in the given plane . More...

static Histogram[]	Create (Image image)
	Creates a histogram for each plane of the whole image . More...

static Histogram[]	Create (Image image, double density)
	Creates a histogram for each plane of the whole image . More...

static Histogram[]	Create (Image image, Rect aoi)
	Creates a histogram for each plane of the aoi in the given image . More...

static Histogram[]	Create (Image image, Rect aoi, double density)
	Creates a histogram for each plane of the aoi in the given image . More...

static Histogram[]	Create (Image image, Area2D aoi)
	Creates a histogram for each plane of the aoi in the given image . More...

static Histogram[]	Create (Image image, Area2D aoi, double density)
	Creates a histogram for each plane of the aoi in the given image . More...

Detailed Description

Functionality for analyzing the Histogram of images (previously found in the LightMeter tool).

Member Function Documentation

◆ Create() [1/12]

static Histogram[] Create ( Image image )

static

Creates a histogram for each plane of the whole image .

Parameters

image Image to create histograms for.

Returns: Array containing the histograms for each ImagePlane.

Exceptions

ArgumentNullException	If image is `null`.
ObjectDisposedException	If image has been disposed.

◆ Create() [2/12]

static Histogram[] Create	(	Image	image,
		Area2D	aoi
	)

static

Creates a histogram for each plane of the aoi in the given image .

Using the Area2D as an overlay uses the CoordinateSystemType.ImageCoordinates.

Parameters

image	Image to create histograms for.
aoi	Area of interest in CoordinateSystemType.ImageCoordinates.

Returns: Array containing the histograms for each ImagePlane.

Exceptions

ArgumentNullException	If image is `null`.
ObjectDisposedException	If image has been disposed.

◆ Create() [3/12]

static Histogram[] Create	(	Image	image,
		Area2D	aoi,
		double	density
	)

static

Creates a histogram for each plane of the aoi in the given image .

Using the Area2D as an overlay uses the CoordinateSystemType.ImageCoordinates.

Parameters

image	Image to create histograms for.
aoi	Area of interest in CoordinateSystemType.ImageCoordinates.
density	Percentage of pixels to process where 0 is 0% and 1.0 is 100%.

Returns: Array containing the histograms for each ImagePlane.

Exceptions

ArgumentNullException	If image is `null`.
ObjectDisposedException	If image has been disposed.
ArgumentOutOfRangeException	If density is out of range.

◆ Create() [4/12]

static Histogram[] Create	(	Image	image,
		double	density
	)

static

Creates a histogram for each plane of the whole image .

Parameters

image	Image to create histograms for.
density	Percentage of pixels to process where 0 is 0% and 1.0 is 100%.

Returns: Array containing the histograms for each ImagePlane.

Exceptions

ArgumentNullException	If image is `null`.
ObjectDisposedException	If image has been disposed.
ArgumentOutOfRangeException	If density is out of range.

◆ Create() [5/12]

static Histogram[] Create	(	Image	image,
		Rect	aoi
	)

static

Creates a histogram for each plane of the aoi in the given image .

Using the Rect as an overlay uses the CoordinateSystemType.PixelCoordinates.

Parameters

image	Image to create histograms for.
aoi	Area of interest in CoordinateSystemType.PixelCoordinates.

Returns: Array containing the histograms for each ImagePlane.

Exceptions

ArgumentNullException	If image is `null`.
ObjectDisposedException	If image has been disposed.

◆ Create() [6/12]

static Histogram[] Create	(	Image	image,
		Rect	aoi,
		double	density
	)

static

Creates a histogram for each plane of the aoi in the given image .

Using the Rect as an overlay uses the CoordinateSystemType.PixelCoordinates.

Parameters

image	Image to create histograms for.
aoi	Area of interest in CoordinateSystemType.PixelCoordinates.
density	Percentage of pixels to process where 0 is 0% and 1.0 is 100%.

Returns: Array containing the histograms for each ImagePlane.

Exceptions

ArgumentNullException	If image is `null`.
ObjectDisposedException	If image has been disposed.
ArgumentOutOfRangeException	If density is out of range.

◆ Create() [7/12]

static Histogram Create ( ImagePlane plane )

static

Create a histogram for the whole plane .

Parameters

plane Image plane to create histogram for.

Returns: Histogram for the given plane .

Exceptions

ObjectDisposedException If plane has been disposed.

◆ Create() [8/12]

static Histogram Create	(	ImagePlane	plane,
		Area2D	aoi
	)

static

Creates a histogram for the aoi in the given plane .

Using the Area2D as an overlay uses the CoordinateSystemType.ImageCoordinates.

Parameters

plane	Image plane to create histogram for.
aoi	Area of interest in CoordinateSystemType.ImageCoordinates.

Returns: Histogram for the given plane .

Exceptions

ObjectDisposedException If plane has been disposed.

◆ Create() [9/12]

static Histogram Create	(	ImagePlane	plane,
		Area2D	aoi,
		double	density
	)

static

Creates a histogram for the aoi in the given plane .

Using the Area2D as an overlay uses the CoordinateSystemType.ImageCoordinates.

Parameters

plane	Image plane to create histogram for.
aoi	Area of interest in CoordinateSystemType.ImageCoordinates.
density	Percentage of pixels to process where 0 is 0% and 1.0 is 100%.

Returns: Histogram for the given plane .

Exceptions

ObjectDisposedException	If plane has been disposed.
ArgumentOutOfRangeException	If density is out of range.

◆ Create() [10/12]

static Histogram Create	(	ImagePlane	plane,
		double	density
	)

static

Create a histogram for the whole plane .

Parameters

plane	Image plane to create histogram for.
density	Percentage of pixels to process where 0 is 0% and 1.0 is 100%.

Returns: Histogram for the given plane .

Exceptions

ObjectDisposedException	If plane has been disposed.
ArgumentOutOfRangeException	If density is out of range.

◆ Create() [11/12]

static Histogram Create	(	ImagePlane	plane,
		Rect	aoi
	)

static

Creates a histogram for the aoi in the given plane .

Using the Rect as an overlay uses the CoordinateSystemType.PixelCoordinates.

Parameters

plane	Image plane to create histogram for.
aoi	Area of interest in CoordinateSystemType.PixelCoordinates.

Returns: Histogram for the given plane .

Exceptions

ObjectDisposedException If plane has been disposed.

◆ Create() [12/12]

static Histogram Create	(	ImagePlane	plane,
		Rect	aoi,
		double	density
	)

static

Creates a histogram for the aoi in the given plane .

Using the Rect as an overlay uses the CoordinateSystemType.PixelCoordinates.

Parameters

plane	Image plane to create histogram for.
aoi	Area of interest in CoordinateSystemType.PixelCoordinates.
density	Percentage of pixels to process where 0 is 0% and 1.0 is 100%.

Returns: Histogram for the given plane .

Exceptions

ObjectDisposedException	If plane has been disposed.
ArgumentOutOfRangeException	If density is out of range.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Create() [1/12]

◆ Create() [2/12]

◆ Create() [3/12]

◆ Create() [4/12]

◆ Create() [5/12]

◆ Create() [6/12]

◆ Create() [7/12]

◆ Create() [8/12]

◆ Create() [9/12]

◆ Create() [10/12]

◆ Create() [11/12]

◆ Create() [12/12]