User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Indexing - RealRange2dC
 

  PUBLIC
RealRange2dC::RealRange2dC(void)
RealRange2dC::RealRange2dC(RealT,RealT)
RealRange2dC::RealRange2dC(const RealRangeC &,const RealRangeC &)
RealRange2dC::RealRange2dC(const RealRange2dC &)
RealRange2dC::RealRange2dC(const TFVectorC &,const TFVectorC &)
RealRange2dC::RealRange2dC(const TFVectorC &,RealT)
RealRange2dC::RealRange2dC(const TFVectorC &,RealT,RealT)
RealRange2dC::RealRange2dC(RealT,RealT,RealT,RealT)
RealRange2dC::SetOrigin(const TFVectorC &)
RealRange2dC::Origin(void) const
RealRange2dC::End(void) const
RealRange2dC::TopRight(void) const
RealRange2dC::TopLeft(void) const
RealRange2dC::BottomLeft(void) const
RealRange2dC::BottomRight(void) const
RealRange2dC::Center(void) const
RealRange2dC::TRow(void) const
RealRange2dC::LCol(void) const
RealRange2dC::BRow(void) const
RealRange2dC::RCol(void) const
RealRange2dC::TRow(void)
RealRange2dC::LCol(void)
RealRange2dC::BRow(void)
RealRange2dC::RCol(void)
RealRange2dC::Rows(void) const
RealRange2dC::Cols(void) const
RealRange2dC::Area(void) const
RealRange2dC::Dilate(void) const
RealRange2dC::Erode(void) const
RealRange2dC::Expand(RealT) const
RealRange2dC::Shrink(RealT) const
RealRange2dC::ClipBy(const RealRange2dC &)
RealRange2dC::Contains(const RealRange2dC &) const
RealRange2dC::Contains(const TFVectorC &) const
RealRange2dC::operator +=(const TFVectorC &)
RealRange2dC::operator -=(const TFVectorC &)
RealRange2dC::operator +(const TFVectorC &) const
RealRange2dC::operator -(const TFVectorC &) const
RealRange2dC::RowRange(void) const
RealRange2dC::ColRange(void) const
RealRange2dC::RowRange(void)
RealRange2dC::ColRange(void)
RealRange2dC::Range1(void) const
RealRange2dC::Range2(void) const
RealRange2dC::Range1(void)
RealRange2dC::Range2(void)
RealRange2dC::Involve(const TFVectorC &)
RealRange2dC::Involve(const RealRange2dC &)
RealRange2dC::IsValid(void) const
RealRange2dC::operator ==(const RealRange2dC &) const
RealRange2dC::operator !=(const RealRange2dC &) const
RealRange2dC::Rotate180(TFVectorC)

   RealRange2dC   
 
An index range of a 2D array
 
include "Ravl/RealRange2d.hh"
Created:06/08/1995 
User Level:Normal
Library:RavlCore
In Scope:RavlN

Variables:
Methods:
RealRange2dC()
Default constructor.

RealRange2dC(RealT rowNumber,RealT colNumber)
Constructor.

RealRange2dC(const RealRangeC & rowRange,const RealRangeC & colRange)
Constructor.

RealRange2dC(const RealRange2dC & range)
Constructor.

RealRange2dC(const TFVectorC<RealT,2> & org,const TFVectorC<RealT,2> & end)
Create an 2d range from corner points.

RealRange2dC(const TFVectorC<RealT,2> & center,RealT size)
Create an 2d range from a center point and a size.
Size is the distance from the center to the edge, so a size of 0 gives a single pixel, and a size of 1 generates a 3x3 square.

RealRange2dC(const TFVectorC<RealT,2> & center,RealT nrows,RealT ncols)
Create an 2d range from a center point and a size for rows and cols.
The sizes passed to this function are the absolute size of the rectangle, unlike RealRangeC(Real2dC ¢er,RealT size). Note: if the rows or cols there will be a half pixel offset in the center of the rectangle.

RealRange2dC(RealT minRow,RealT maxRow,RealT minCol,RealT maxCol)
Create rectangle from indvidual values.

const RealRange2dC & SetOrigin(const TFVectorC<RealT,2> & newOrigin)
Set the origin of the range to 'newOrigin'
Returns a reference to this rectangle.

TFVectorC<RealT,2> Origin() const
Returns the top-left index of the rectangle.

TFVectorC<RealT,2> End() const
Returns the bottom-right index of the rectangle.

TFVectorC<RealT,2> TopRight() const
Returns the top-right index of the rectangle.

TFVectorC<RealT,2> TopLeft() const
Returns the top-left index of the rectangle.

TFVectorC<RealT,2> BottomLeft() const
Returns the bottom-left index of the rectangle.

TFVectorC<RealT,2> BottomRight() const
Returns the bottom-right index of the rectangle.

TFVectorC<RealT,2> Center() const
Returns the index which is in the middle of the rectangle

RealT TRow() const
Returns the top row index.

RealT LCol() const
Returns the left side column index.

RealT BRow() const
Returns the bottom row index.

RealT RCol() const
Returns the right side column index.

RealT & TRow()
Returns the top row index.

RealT & LCol()
Returns the left side column index.

RealT & BRow()
Returns the bottom row index.

RealT & RCol()
Returns the right side column index.

RealT Rows() const
The number of rows in the rectangle.

RealT Cols() const
The number of rows in the rectangle.

RealT Area() const
Returns the area of the image rectangle expressed in number of indexs.

RealRange2dC Dilate() const
Returns a new rectangle one index larger on each side.

RealRange2dC Erode() const
Returns an rectangle with each side 1 index closer to the center.

RealRange2dC Expand(RealT n) const
Returns an rectangle expanded by 'n' indexs on each side.

RealRange2dC Shrink(RealT n) const
Returns a new rectangle which has layer of the width of 'n' indexs removed.

RealRange2dC & ClipBy(const RealRange2dC & r)
This index range is clipped to contain at most the index range 'r'.

bool Contains(const RealRange2dC & oth) const
Returns true if this range contains the subrange 'oth'.

bool Contains(const TFVectorC<RealT,2> & oth) const
Returns true if this range contains the subrange 'oth'.

const RealRange2dC & operator +=(const TFVectorC<RealT,2> & offset)
Shifts the rectangle to the new position.

const RealRange2dC & operator -=(const TFVectorC<RealT,2> & offset)
Shifts the rectangle to the new position.

RealRange2dC operator +(const TFVectorC<RealT,2> & offset) const
Shifts the rectangle to the new position.

RealRange2dC operator -(const TFVectorC<RealT,2> & offset) const
Shifts the rectangle to the new position.

const RealRangeC & RowRange() const
Access row range.

const RealRangeC & ColRange() const
Access col range.

RealRangeC & RowRange()
Access row range.

RealRangeC & ColRange()
Access col range.

const RealRangeC & Range1() const
Access row range.

const RealRangeC & Range2() const
Access col range.

RealRangeC & Range1()
Access row range.

RealRangeC & Range2()
Access col range.

void Involve(const TFVectorC<RealT,2> & index)
Ensures this rectangle contains given index.
This method checks and changes, if necessary, the 2 dimensional range to contain the 'index'.

void Involve(const RealRange2dC & subrectangle)
Ensures this rectangle contains given sub rectangle.
This method checks and changes, if necessary, the 2 dimensional range to contain the 'subrectangle'.

bool IsValid() const
Returns true if this rectangle contains at least one index.

bool operator ==(const RealRange2dC & oth) const
Are two ranges equal ?

bool operator !=(const RealRange2dC & oth) const
Are two ranges unequal ?

RealRange2dC Rotate180(TFVectorC<RealT,2> centre)
Rotate rectangle 180 degree's around the given center.


Maintainer:Radek Marik, Created: 06/08/1995, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002