ImageRectangleC - Rectangular area used for images.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
The class ImageRectangleC is a specification of rectangular area used by processing functions.

Parent Classes:

IndexRectangleC

Derived Classes:

BaseImageC

Methods:

ImageRectangleC()

empty object

ImageRectangleC(IndexT minRow,IndexT maxRow,IndexT minCol,IndexT maxCol)

constructor from limits

ImageRectangleC(SizeT rows,SizeT columns)

constructor from limits

ImageRectangleC(const PixelC & origin,const PixelC & endP)

constructor from 2 pixels

ImageRectangleC(const IndexRangeC & rows,const IndexRangeC & cols)

constructor from row and column index range

ImageRectangleC(const IndexRectangleC & rectangle)

the copy constructor

ImageRectangleC(const PixelC & center,const SizeT maskSize)

constructor from the mask in the specific position 'center'

ImageRectangleC(const PixelC & center,SizeT maskR,SizeT maskC)

constructor from the mask in the specific position 'center' with diffrent rows and cols.

ImageRectangleC(istream & is)

constructor from the input stream 'is'

const ImageRectangleC & operator=(const ImageRectangleC & rect)

assigment

Logical conditions

BooleanT operator==(const ImageRectangleC & rect) const

Return TRUE if the rectangles are identical

BooleanT operator!=(const ImageRectangleC & rect) const

Return TRUE if the rectangles are not identical

BooleanT IsInside(const ImageRectangleC & rect) const

Returns TRUE if 'this' rectangle is inside the rectangle 'rect'.
NB. It will also return true if the rectangles are the same size.

BooleanT IsValid() const

Returns TRUE if this rectangle contains at least one pixel.

BooleanT Contains(const Index2dC & i) const

Returns TRUE if the index 'i' is inside this rectangle.

BooleanT Contains(const ImageRectangleC & rect) const

Returns TRUE if this rectangle contains 'rect'
NB. It will also return true if the rectangles are the same size.

Access to the object representation

ImageRectangleC & Rectangle()

Returns this image rectangle.

const ImageRectangleC & Rectangle() const

Returns this image rectangle.

Modifications of the object

const ImageRectangleC & operator+=(const PixelC & offset)

Shifts the rectangle to the new position.

const ImageRectangleC & operator-=(const PixelC & offset)

Shifts the rectangle to the new position.

const ImageRectangleC & SetOrigin(const PixelC & o)

Shifts the rectangle
New position with the origin pixel equal to 'o'.

ImageRectangleC & Dilate()

Adds one pixel layer on each side.

ImageRectangleC & Expand(const IndexT n)

Expands this rectangle by adding "n" pixels on each side.

ImageRectangleC & Expand(const IndexT t,const IndexT b,const IndexT l,const IndexT r)

Expands this rectangle by adding "t" pixels to the top, "b" pixels to the bottom, "l" to the left and "r" to the right.

ImageRectangleC & Involve(const PixelC & pxl)

Expands this rectangle to involve pxl
Modifies the image rectangle in such way that the result rectangle is the minimum rectangle enclosing the original rectangle and the pixel "pxl".

ImageRectangleC & Involve(const ImageRectangleC & rect)

Expands this rectangle to involve rect
Sets rectangle in such way that contains both the original rectangle and another rectangle 'rect'

ImageRectangleC BoundingBox(const ImageRectangleC & rect) const

Gets a new rectangle that contains both this rectangle and another rectangle 'rect'

     -----------------
     |  1    |   2   |
     -----------------
     |  3    |   4   |
     -----------------

ImageRectangleC & Quartile1()

ImageRectangleC & Quartile2()

ImageRectangleC & Quartile3()

ImageRectangleC & Quartile4()

ImageRectangleC & Double()

set rectangle to be 2 times bigger by shifting of endPixel

ImageRectangleC & Half()

set rectangle to be 2 times smaller by shifting of endPixel
if the result can not be the exact half of the original rectangle the rectangle is set to be bigger part

ImageRectangleC & BiggerHalf()

set rectangle to be 2 times smaller by shifting of endPixel
if the result can not be the exact half of the original rectangle the rectangle is set to be bigger part

ImageRectangleC & SmallerHalf()

set rectangle to be 2 times smaller by shifting of endPixel
if the result can not be the exact half of the original rectangle the rectangle is set to be smaller part

ImageRectangleC & Rotate90()

Rotates the rectangle about PI/2 rad.

ImageRectangleC & Rotate180()

Rotates the rectangle about PI rad.

ImageRectangleC & Rotate270()

Rotates the rectangle about 3/2PI rad.

ImageRectangleC & Clip(const ImageRectangleC & rec)

The rectangle is clipped to be within the rectangle 'rec'.
That means the result rectangle is certainly inside the 'rec'.

ImageRectangleC & ClipRows(const ImageRectangleC & rect)

The rectangle rows are clipped to be within the rectangle 'rect'.
That means the result rows are certainly inside the 'rect'.

ImageRectangleC & ClipCols(const ImageRectangleC & rect)

The rectangle columns are clipped to be within the rectangle 'rect'.
That means the result colums are certainly inside the 'rect'.

PixelC ClipPixel(const PixelC & pxl) const

Clips pixel to be inside rectangle

Creation of new rectangles from object

ImageRectangleC Intersection(const ImageRectangleC & rect) const

Rectangle which is intersection of rectangle 'rect' and inside this rectangle.
(Similar to "Clip" functions above)

ImageRectangleC TopDiff(const ImageRectangleC & rect) const

Rectangle which is above the rectangle 'rect' and inside this rectangle.

ImageRectangleC BottomDiff(const ImageRectangleC & rect) const

Rectangle which is below the rectangle 'rect' and inside this rectangle.

ImageRectangleC LeftDiff(const ImageRectangleC & rect) const

Rectangle which is left from the rectangle 'rect' and inside this rectangle.

ImageRectangleC RightDiff(const ImageRectangleC & rect) const

Rectangle which is right from the rectangle 'rect' and inside this rectangle.

ImageRectangleC & ReflectUp()

Mirrors the image rectangle along its top edge.

ImageRectangleC & ReflectDown()

Mirrors the image rectangle along its bottom edge.

ImageRectangleC & ReflectLeft()

Mirrors the image rectangle along its left edge.

ImageRectangleC & ReflectRight()

Mirrors the image rectangle along its right edge.

ostream & operator<<(ostream & outS,const ImageRectangleC & rect)

write value of the rectangle to the output stream 'outS'

istream & operator>>(istream & is,ImageRectangleC & rect)

read value of the rectangle from the input stream 'is'

#include "amma/IndRect.hh"

const IndexRectangleC & operator=(const IndexRectangleC & rect): Assigment. Logical conditions. -------------------
BooleanT operator==(const IndexRectangleC & rect) const: Return TRUE if the rectangles are identical
BooleanT operator!=(const IndexRectangleC & rect) const: Return TRUE if the rectangles are not identical
BooleanT IsInside(const IndexRectangleC & rect) const: Returns TRUE if 'this' rectangle is inside the rectangle 'rect'.
BooleanT Contains(const Index2dC & i) const: Returns TRUE if the index 'i' is inside this rectangle.
BooleanT IsValid() const: Returns TRUE if this rectangle contains at least one index. Access to the object representation. ------------------------------------
IndexRectangleC & Rectangle(): Returns this image rectangle.
const IndexRectangleC & Rectangle() const: Returns this image rectangle.
IndexRangeC RowRange() const: Returns the index range of rows.
IndexRangeC ColumnRange() const: Returns the index range of columns.
Index2dC & Origin(): Returns the top-left index of the image rectangle.
const Index2dC & Origin() const: Returns the top-left index of the image rectangle.
Index2dC & End(): Returns the bottom-right index of the image rectangle.
const Index2dC & End() const: Returns the bottom-right index of the image rectangle.
Index2dC Center() const: Returns the index which is in the middle of the image rectangle.
SizeT Rnum() const: Returns number of rows.
SizeT Cnum() const: Returns number of columns.
IndexT TRow() const: Returns the top row index.
IndexT LCol() const: Returns the left side column index.
IndexT BRow() const: Returns the bottom row index.
IndexT RCol() const: Returns the right side column index.
IndexT & TRow(): Returns the top row index.
IndexT & LCol(): Returns the left side column index.
IndexT & BRow(): Returns the bottom row index.
IndexT & RCol(): Returns the right side column index.
LongIntT Area() const: Returns the area of the image rectangle expressed in number of indexs. Modifications of the object. ----------------------------
const IndexRectangleC & operator+=(const Index2dC & offset): Shifts the rectangle to the new position.
const IndexRectangleC & operator-=(const Index2dC & offset): Shifts the rectangle to the new position.
const IndexRectangleC & SetOrigin(const Index2dC & o): Shifts the rectangle to the new position with the origin index equal to 'o'.
IndexRectangleC & Dilate(): Adds one index layer on each side.
IndexRectangleC & Erode(): Removes one index layer on each side.
IndexRectangleC & Expand(const IndexT n): Expands the rectangle by adding 'n' indexs on each side.
IndexRectangleC Shrink(const IndexT n) const: Returns a new rectangle which has layer of the width of 'n' indexs removed.
IndexRectangleC & Involve(const Index2dC & pxl): Modifies the image rectangle in such way that the result rectangle is the minimum rectangle enclosing the original rectangle and the index 'pxl'.
IndexRectangleC & Involve(const IndexRectangleC & rect): Sets rectangle in such way that contains both the original rectangle and another rectangle 'rect'
IndexRectangleC BoundingBox(const IndexRectangleC & rect) const: Gets a new rectangle that contains both this rectangle and another rectangle 'rect'
BooleanT Overlaps(const IndexRectangleC & rect) const: Test if 'this' and 'rect' rectangle overlap.
----------------- | 1 | 2 | ----------------- | 3 | 4 | -----------------
IndexRectangleC & Quartile1()
IndexRectangleC & Quartile2()
IndexRectangleC & Quartile3()
IndexRectangleC & Quartile4()
IndexRectangleC & Double(): set rectangle to be 2 times bigger by shifting of endIndex
IndexRectangleC & Half(): set rectangle to be 2 times smaller by shifting of endIndex if the result can not be the exact half of the original rectangle the rectangle is set to be bigger part
IndexRectangleC & BiggerHalf(): set rectangle to be 2 times smaller by shifting of endIndex if the result can not be the exact half of the original rectangle the rectangle is set to be bigger part
IndexRectangleC & SmallerHalf(): set rectangle to be 2 times smaller by shifting of endIndex if the result can not be the exact half of the original rectangle the rectangle is set to be smaller part
IndexRectangleC & Rotate90(): Rotates the rectangle about PI/2 rad.
IndexRectangleC & Rotate180(): Rotates the rectangle about PI rad.
IndexRectangleC & Rotate270(): Rotates the rectangle about 3/2PI rad.
IndexRectangleC & Clip(const IndexRectangleC & rec): The rectangle is clipped by the rectangle 'rec'. That means the result rectangle is certainly inside the 'rec'.
IndexRectangleC & ClipRows(const IndexRectangleC & rect): The rectangle rows are clipped by the rectangle 'rect'. That means the result rows are certainly inside the 'rect'.
IndexRectangleC & ClipCols(const IndexRectangleC & rect): The rectangle columns are clipped by the rectangle 'rect'. That means the result colums are certainly inside the 'rect'.
IndexRectangleC TopDiff(const IndexRectangleC & rect) const: Returns the rectangle which is above the rectangle 'rect' and inside this rectangle.
IndexRectangleC BottomDiff(const IndexRectangleC & rect) const: Returns the rectangle which is below the rectangle 'rect' and inside this rectangle.
IndexRectangleC LeftDiff(const IndexRectangleC & rect) const: Returns the rectangle which is left from the rectangle 'rect' and inside this rectangle.
IndexRectangleC RightDiff(const IndexRectangleC & rect) const: Returns the rectangle which is right from the rectangle 'rect' and inside this rectangle.
IndexRectangleC & ReflectUp(): Mirrors the image rectangle along its top edge.
IndexRectangleC & ReflectDown(): Mirrors the image rectangle along its bottom edge.
IndexRectangleC & ReflectLeft(): Mirrors the image rectangle along its left edge.
IndexRectangleC & ReflectRight(): Mirrors the image rectangle along its right edge.
void ErrIfNotInside(const IndexRectangleC & rect,char * fnc = "") const: If this image rectangle is not inside the image rectangle 'rect', the function triggers error exit. The function name 'fnc' is send as the error triggering function.
void ErrIfNotSame(const IndexRectangleC & rect,char * fnc = "") const: If this image rectangle has not the same size as the rectangle 'rect', the function triggers error exit. The function name 'fnc' is printed as the error triggering function.

Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

ImageRectangleC

Rectangular area used for images.

include	"amma/ImageRec.hh"
User Level:	Default
Library:	Image
Example:	doNumClassComb.cc
Section:	Image.Indexing
In Scope:	std