AliceVision
Photogrammetric Computer Vision Framework
Public Member Functions | Public Attributes | List of all members
aliceVision::ROI Struct Reference

Public Member Functions

CUDA_HOST_DEVICE ROI (unsigned int in_beginX, unsigned int in_endX, unsigned int in_beginY, unsigned int in_endY)
 ROI constructor. More...
 
CUDA_HOST_DEVICE ROI (const Range &in_rangeX, const Range &in_rangeY)
 ROI constructor. More...
 
CUDA_HOST_DEVICE unsigned int width () const
 Get the ROI width. More...
 
CUDA_HOST_DEVICE unsigned int height () const
 Get the ROI height. More...
 
CUDA_HOST_DEVICE bool isEmpty () const
 
CUDA_HOST bool contains (unsigned int in_x, unsigned int in_y) const
 Return true if the given 2d point is contained in the ROI. More...
 

Public Attributes

Range x
 
Range y
 

Constructor & Destructor Documentation

◆ ROI() [1/2]

CUDA_HOST_DEVICE aliceVision::ROI::ROI ( unsigned int  in_beginX,
unsigned int  in_endX,
unsigned int  in_beginY,
unsigned int  in_endY 
)
inline

ROI constructor.

Parameters
[in]in_beginXthe range X begin index
[in]in_endXthe range X end index
[in]in_beginYthe range Y begin index
[in]in_endYthe range Y end index

◆ ROI() [2/2]

CUDA_HOST_DEVICE aliceVision::ROI::ROI ( const Range in_rangeX,
const Range in_rangeY 
)
inline

ROI constructor.

Parameters
[in]in_rangeXthe X index range
[in]in_rangeYthe Y index range

Member Function Documentation

◆ contains()

CUDA_HOST bool aliceVision::ROI::contains ( unsigned int  in_x,
unsigned int  in_y 
) const
inline

Return true if the given 2d point is contained in the ROI.

Parameters
[in]in_xthe given 2d point X coordinate
[in]in_ythe given 2d point Y coordinate
Returns
true if the given 2d point is contained in the ROI

◆ height()

CUDA_HOST_DEVICE unsigned int aliceVision::ROI::height ( ) const
inline

Get the ROI height.

Returns
the Y range size

◆ width()

CUDA_HOST_DEVICE unsigned int aliceVision::ROI::width ( ) const
inline

Get the ROI width.

Returns
the X range size

The documentation for this struct was generated from the following file: