stira::common::RectangularROI< T > Class Template Reference

A class to represent a rectangular ROI. The edges of this ROI are parallel with the x and y axes. Here, we consider a closed ROI, i.e., the edge points also belong to the ROI. More...

#include <RectangularROI.h>

Public Member Functions
	RectangularROI ()
	constructor
	RectangularROI (Point< T > topLeftCorner, Point< T > bottomRightCorner)
	constructor More...
	RectangularROI (T topLeftX, T topLeftY, T bottomRightX, T bottomRightY)
	constructor More...
	~RectangularROI ()
	destructor
Point< T >	GetTopLeftCorner ()
	Gets the top left corner point of the rectangle.
Point< T >	GetBottomRightCorner ()
	Gets the bottom right corner point of the rectangle.
Point< T >	GetCenter ()
	Gets the center point of the rectangle.
bool	IsInROI (Point< T > candidatePoint)
	Checks if a candidate point is inside this rectangle.
T	GetWidth ()
	Gets the width of this rectangle.
T	GetHeight ()
	Gets the height of this rectangle.
T	GetArea ()
T	GetDiagonalLength ()

Detailed Description

template<class T>
class stira::common::RectangularROI< T >

A class to represent a rectangular ROI. The edges of this ROI are parallel with the x and y axes. Here, we consider a closed ROI, i.e., the edge points also belong to the ROI.

Constructor & Destructor Documentation

template<class T>

stira::common::RectangularROI< T >::RectangularROI	(	Point< T >	topLeftCorner,
		Point< T >	bottomRightCorner
	)

constructor

Parameters

topLeftCorner	the point that is the top left corner of the rectangle
bottomRightCorner	the point that is the bottom right corner of the rectangle

template<class T>

stira::common::RectangularROI< T >::RectangularROI	(	T	topLeftX,
		T	topLeftY,
		T	bottomRightX,
		T	bottomRightY
	)

constructor

Parameters

topLeftCorner	the point that is the top left corner of the rectangle
bottomRightCorner	the point that is the bottom right corner of the rectangle

---

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

• common/common/RectangularROI.h