Back to Aurora Vision Library website
You are here: Start » Function Reference » Region » Region Features » RegionInscribedBox
![](../../img/icon/RegionAnalysis.png)
RegionInscribedBox
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Computes the largest box contained in a region.
Syntax
C++
C#
void avl::RegionInscribedBox ( const avl::Region& inRegion, const float inMinAspectRatio, atl::Optional<float> inMaxAspectRatio, const int inMinWidth, atl::Optional<int> inMaxWidth, const int inMinHeight, atl::Optional<int> inMaxHeight, atl::Conditional<avl::Box>& outBox )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() |
inRegion | const Region& | Input region | ||
![]() |
inMinAspectRatio | const float | 0.0 - ![]() |
0.0f | Minimal aspect ratio of found box |
![]() |
inMaxAspectRatio | Optional<float> | 0.0 - ![]() |
NIL | Maximal aspect ratio of found box (reciprocal of inMinAspectRatio by default) |
![]() |
inMinWidth | const int | 1 - 65535 | 1 | Minimal width of found box |
![]() |
inMaxWidth | Optional<int> | 1 - 65535 | NIL | Maximal width of found box |
![]() |
inMinHeight | const int | 1 - 65535 | 1 | Minimal height of found box |
![]() |
inMaxHeight | Optional<int> | 1 - 65535 | NIL | Maximal height of found box |
![]() |
outBox | Conditional<Box>& | Found box with largest area |
Examples
![]() RegionInscribedBox performed on a sample region with inMaxAspectRatio = Auto. |
![]() RegionInscribedBox performed on a sample region with inMaxAspectRatio = 2.0. |