Back to Aurora Vision Library Lite website
You are here: Start » Image » Image Pixel Statistics » ImageStatistics
ImageStatistics
Header: | AVL.h |
---|---|
Namespace: | avl |
Computes various statistics of the image pixel values.
Syntax
void avl::ImageStatistics ( const avl::Image& inImage, atl::Optional<const avl::Region&> inRoi, atl::Optional<avl::Location&> outMinimumLocation = atl::NIL, atl::Optional<float&> outMinimumValue = atl::NIL, atl::Optional<avl::Location&> outMaximumLocation = atl::NIL, atl::Optional<float&> outMaximumValue = atl::NIL, atl::Optional<avl::Pixel&> outAverageColor = atl::NIL, atl::Optional<float&> outAverageValue = atl::NIL, atl::Optional<avl::Pixel&> outSumColor = atl::NIL, atl::Optional<float&> outSumValue = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inImage | const Image& | Input image | ||
inRoi | Optional<const Region&> | NIL | Range of pixels to be processed | |
outMinimumLocation | Optional<Location&> | NIL | ||
outMinimumValue | Optional<float&> | NIL | ||
outMaximumLocation | Optional<Location&> | NIL | ||
outMaximumValue | Optional<float&> | NIL | ||
outAverageColor | Optional<Pixel&> | NIL | ||
outAverageValue | Optional<float&> | NIL | ||
outSumColor | Optional<Pixel&> | NIL | ||
outSumValue | Optional<float&> | NIL |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outMinimumLocation, outMinimumValue, outMaximumLocation, outMaximumValue, outAverageColor, outAverageValue, outSumColor, outSumValue.
Read more about Optional Outputs.
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Region exceeds an input image in ImageStatistics. |