|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
An image template class containing only rows for the current field. This
class does not inherit from ImageC, although its member functions
behave in an analogous manner to those in ImageC. Use FieldIterC as an
iterator.
Parent Classes:
Variables:
- IndexC FiF;
-
Field no. within frame; defined as: row no. % FpF
i.e. row no. modulo no. of frames in field
- ImageRectangleC FrameRect;
-
rectangle of the original frame
- ImageC Field;
-
the field
Methods:
- ImgFieldC()
-
Default constructor
- ImgFieldC(const ImageC<PixTypeT> & img,IndexC fif,const VidIntlBodyC & intl)
-
Constructor tthat deinterlaces field from frame, using interlace params
- ImgFieldC(const ImageRectangleC & fr,IndexC fif,const VidIntlBodyC & intl)
-
Constructor of empty field from frame rectangle & interlace params
- ImgFieldC(const ImageRectangleC & fr,ImgFieldC<PixTypeT> other)
-
Constructor of empty field from frame rectangle,
using interlace params from "other"
- ImgFieldC(IndexC fif,const VidIntlBodyC & intl,ImageC<PixTypeT> & img,const ImageRectangleC & frame = ImageRectangleC())
-
Constructor repackages image as field, using field no. in frame and
interlace info. I.e. the resulting field is identical to "img" apart from
the row numbering.
The optional "frame" argument specifies the rectangle of the containing
frame, e.g. if the fields within a frame do not have an identical
number of rows. "frame" and "img" sizes must be consistent;
i.e. the rows from "img" should occupy precisely all of the appropriate
field rows in "frame".
- const ImageC<PixTypeT> Image() const
-
returns plain image of field, with rows numbered consecutively
- ImageC<PixTypeT> Image()
-
returns plain image of field, with rows numbered consecutively
- IndexC FieldInFrame() const
-
returns field no. within current frame;
- BooleanT FirstInFrame() const
-
true if first field in frame (i.e. it includes the top row of the frame)
- BooleanT LastInFrame() const
-
true if last field in frame
- BooleanT IsValid() const
-
true if image component is valid
- BooleanT IsEmpty() const
-
true if image component contains no data
- IndexT TRow() const
-
top row of current frame
- IndexT BRow() const
-
bottom row of current frame
- IndexT LCol() const
-
leftmost column of field
- IndexT RCol() const
-
rightmost column of field
- const RangeBufferAccessC<PixTypeT> operator[](IndexT r) const
-
Const. access to the row of pixels, based on row no. in frame
- RangeBufferAccessC<PixTypeT> operator[](IndexT r)
-
Access to the row of pixels, based on row no. in frame
- const PixTypeT & operator[](const Index2dC & pxl) const
-
Returns the content of the pixel.
- PixTypeT & operator[](const Index2dC & pxl)
-
Returns the content of the pixel.
- const PixTypeT & operator[](const PixelC & pxl) const
-
Returns the content of the pixel.
- PixTypeT & operator[](const PixelC & pxl)
-
Returns the content of the pixel.
- const ImageRectangleC & Rectangle() const
-
returns rectangle of current frame
- void ErrNotInField(IndexT r,char * functionName) const
-
Triggers the error event if the index 'i' is not in current field
- ImageRectangleC ImRec() const
-
Computes the rectangle for the ImageC used to store the field rows
- BooleanT IsInterlaced() const
-
Is Stream interlaced ? (i.e. >1 field per frame)
- UIntT FieldsPerFrame() const
-
|
Programmer:Bill Christmas, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001
|