Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Indexing - IndexRange3dC
 

  PUBLIC
IndexRange3dC::IndexRange3dC(void)
IndexRange3dC::IndexRange3dC(IndexC,IndexC,IndexC)
IndexRange3dC::IndexRange3dC(IntT,IntT,IntT)
IndexRange3dC::IndexRange3dC(const IndexRangeC &,const IndexRangeC &,const IndexRangeC &)
IndexRange3dC::IndexRange3dC(const Index3dC &,const Index3dC &)
IndexRange3dC::IndexRange3dC(IndexC,IndexC,IndexC,IndexC,IndexC,IndexC)
IndexRange3dC::IndexRange3dC(const Index3dC &,SizeT)
IndexRange3dC::IndexRange3dC(const Index3dC &,SizeT,SizeT,SizeT)
IndexRange3dC::Origin(void) const
IndexRange3dC::End(void) const
IndexRange3dC::Center(void) const
IndexRange3dC::MinI(void) const
IndexRange3dC::MinJ(void) const
IndexRange3dC::MinK(void) const
IndexRange3dC::MaxI(void) const
IndexRange3dC::MaxJ(void) const
IndexRange3dC::MaxK(void) const
IndexRange3dC::MinI(void)
IndexRange3dC::MinJ(void)
IndexRange3dC::MinK(void)
IndexRange3dC::MaxI(void)
IndexRange3dC::MaxJ(void)
IndexRange3dC::MaxK(void)
IndexRange3dC::Is(void) const
IndexRange3dC::Js(void) const
IndexRange3dC::Ks(void) const
IndexRange3dC::Size(void) const
IndexRange3dC::Volume(void) const
IndexRange3dC::Dilate(void) const
IndexRange3dC::Erode(void) const
IndexRange3dC::Expand(IndexC) const
IndexRange3dC::Shrink(IndexC) const
IndexRange3dC::ClipBy(const IndexRange3dC &)
IndexRange3dC::Contains(const Index3dC &) const
IndexRange3dC::Contains(const IndexRange3dC &) const
IndexRange3dC::IsOverlapping(const IndexRange3dC &) const
IndexRange3dC::operator +=(const Index3dC &)
IndexRange3dC::operator -=(const Index3dC &)
IndexRange3dC::operator +(const Index3dC &) const
IndexRange3dC::operator -(const Index3dC &) const
IndexRange3dC::IRange(void) const
IndexRange3dC::JRange(void) const
IndexRange3dC::KRange(void) const
IndexRange3dC::IRange(void)
IndexRange3dC::JRange(void)
IndexRange3dC::KRange(void)
IndexRange3dC::Range1(void) const
IndexRange3dC::Range2(void) const
IndexRange3dC::Range3(void) const
IndexRange3dC::Range1(void)
IndexRange3dC::Range2(void)
IndexRange3dC::Range3(void)
IndexRange3dC::Involve(const Index3dC &)
IndexRange3dC::Involve(const IndexRange3dC &)
IndexRange3dC::IsValid(void) const
IndexRange3dC::operator ==(const IndexRange3dC &) const
IndexRange3dC::operator !=(const IndexRange3dC &) const
IndexRange3dC::Range(void) const

   IndexRange3dC   
 
An index range of a 3D array
 
include "Ravl/IndexRange3d.hh"
Created:06/08/1995 
Source file:Ravl/Core/Base/IndexRange3d.hh
User Level:Normal
Library:RavlCore
In Scope:RavlN

Variables:
IndexRangeC is;

IndexRangeC js;

IndexRangeC ks;

Methods:
IndexRange3dC()
Default constructor.

IndexRange3dC(IndexC iNumber,IndexC jNumber,IndexC kNumber)
Constructor.

IndexRange3dC(IntT iNumber,IntT jNumber,IntT kNumber)
Constructor.

IndexRange3dC(const IndexRangeC & iRange,const IndexRangeC & jRange,const IndexRangeC & kRange)
Constructor.

IndexRange3dC(const Index3dC & org,const Index3dC & end)
Create an 3d range from corner points.

IndexRange3dC(IndexC minI,IndexC maxI,IndexC minJ,IndexC maxJ,IndexC minK,IndexC maxK)
Create rectangle from individual values.

IndexRange3dC(const Index3dC & center,SizeT 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.

IndexRange3dC(const Index3dC & center,SizeT sizei,SizeT sizej,SizeT sizek)
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 IndexRangeC(Index2dC ¢er,SizeT size). Note: if the rows or cols there will be a half pixel offset in the center of the rectangle.

Index3dC Origin() const
Returns the origin index of the rectangle.

Index3dC End() const
Returns the end index of the rectangle.

Index3dC Center() const
Returns the index which is in the middle of the rectangle

IndexC MinI() const
Returns the min value of I.

IndexC MinJ() const
Returns the min value of J.

IndexC MinK() const
Returns the min value of K.

IndexC MaxI() const
Returns the max value of I.

IndexC MaxJ() const
Returns the max value of J.

IndexC MaxK() const
Returns the max value of K.

IndexC & MinI()
Returns the min value of I.

IndexC & MinJ()
Returns the min value of J.

IndexC & MinK()
Returns the min value of K.

IndexC & MaxI()
Returns the max value of I.

IndexC & MaxJ()
Returns the max value of J.

IndexC & MaxK()
Returns the max value of K.

SizeT Is() const
The number of i's in the rectangle.

SizeT Js() const
The number of j's in the rectangle.

SizeT Ks() const
The number of k's in the rectangle.

Index3dC Size() const
Get size of range as an Index3dC.

SizeT Volume() const
Returns the volume of the prism expressed in number of indexs.

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

IndexRange3dC Erode() const
Removes one index layer on each side.

IndexRange3dC Expand(IndexC n) const
Expands the rectangle by adding 'n' indexs on each side.

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

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

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

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

bool IsOverlapping(const IndexRange3dC & r) const
Returns true if this range contains at least one common index with the range 'r'.

const IndexRange3dC & operator +=(const Index3dC & offset)
Shifts the rectangle to the new position.

const IndexRange3dC & operator -=(const Index3dC & offset)
Shifts the rectangle to the new position.

IndexRange3dC operator +(const Index3dC & offset) const
Shifts the rectangle to the new position.

IndexRange3dC operator -(const Index3dC & offset) const
Shifts the rectangle to the new position.

const IndexRangeC & IRange() const
Access i range.

const IndexRangeC & JRange() const
Access j range.

const IndexRangeC & KRange() const
Access k range.

IndexRangeC & IRange()
Access i range.

IndexRangeC & JRange()
Access j range.

IndexRangeC & KRange()
Access k range.

const IndexRangeC & Range1() const
Access i range.

const IndexRangeC & Range2() const
Access j range.

const IndexRangeC & Range3() const
Access k range.

IndexRangeC & Range1()
Access i range.

IndexRangeC & Range2()
Access j range.

IndexRangeC & Range3()
Access k range.

const IndexRange3dC & Involve(const Index3dC & index)
Checks and changes, if necessary, the 3 dimensional range to contain the 'index'.

const IndexRange3dC & Involve(const IndexRange3dC & subRange)
Checks and changes, if necessary, the 3 dimensional range to contain the 'subRange'.

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

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

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

const IndexRange3dC & Range() const


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