Developer Documentation |
RAVL, Recognition And Vision Library |
DPIMultiVidC<class PixelC>
|
|
Multi-view video sequence input port
|
|
include | "Ravl/Image/MultiVidIO.hh" |
Source file: | Ravl/Image/VideoIO/MultiVidIO.hh |
User Level: | Develop |
Library: | RavlVideoIO |
In Scope: | RavlImageN |
Comments:
Used for reading syncronised multi-view video sequences
from disk or from frame grabbers.
Can open an arbitary list of video files/sequences,
or sequences of the form basename.C.FFFFF.type
Where:
basename is a text id for the file
C is a 1 digit view number
FFFFF is a 5 digit frame number
type is the file type, such as "tif", "ppm", etc
To open a file sequence named in this way use:
DPISPortC< SArray1dC< ImageC > > port;
OpenISequence(port, "@multiview:basename:type");
Sequences are expected to start from frame 0, view 0
If no type is specified, tif is assumed
To open a predefined list, use:
DPISPortC< SArray1dC< ImageC > > port;
OpenISequence(port, "@viewlist:seq1;seq2;...;seqN");
Parent Classes:
Methods:
- DPIMultiVidC(const DListC<StringC> & view_list)
-
construct from list of sequences/files, one per view
- DPIMultiVidC(const StringC & fnBase,const StringC & fnFormat)
-
construct from base filename and format
- const DPISPortC<SArray1dC<ImageC<PixelC>>> & operator =(const DPISPortC<SArray1dC<ImageC<PixelC>>> & obj)
-
Assigment.
- DPIPortBodyC<SArray1dC<ImageC<PixelC>>> & Body()
-
Access body.
- const DPIPortBodyC<SArray1dC<ImageC<PixelC>>> & Body() const
-
Access body.
- SArray1dC<ImageC<PixelC>> Get()
-
Get next piece of data.
- bool Get(SArray1dC<ImageC<PixelC>> & buff)
-
Try and get next piece of data.
If none, return false.
else put data into buff.
- IntT GetArray(SArray1dC<SArray1dC<ImageC<PixelC>>> & data)
-
Get an array of data from stream.
returns the number of elements processed.
- DPSeekCtrlBodyC & Body()
-
Access body class.
- const DPSeekCtrlBodyC & Body() const
-
Access body class.
- bool Seek(UIntT off)
-
Seek to location in stream.
Returns false, if seek failed. (Maybe because its
not implemented.)
if an error occurered (Seek returned False) then stream
position will not be changed.
- bool DSeek(IntT off)
-
Delta Seek, goto location relative to the current one.
The default behavour of this functions is :
Do some error checking then:
Seek((UIntT)((IntT) Tell() + off));
if an error occurered (DSeek returned False) then stream
position will not be changed.
- UIntT Tell() const
-
Find current location in stream.
Defined as the index of the next object to be written or read.
May return ((UIntT) (-1)) if not implemented.
- UIntT Size() const
-
Find the total size of the stream. (assuming it starts from 0)
May return ((UIntT) (-1)) if not implemented.
- UIntT Start() const
-
Find the offset where the stream begins, normally zero.
Defaults to 0
- DPIPortBaseBodyC & Body()
-
Access body.
- const DPIPortBaseBodyC & Body() const
-
Access body.
- const type_info & InputType() const
-
Get type of input port.
- bool IsGetReady() const
-
Is valid data.
- bool IsGetEOS() const
-
Is valid data.
- bool Discard()
-
Discard the next input datum.
returns true on success.
- const DPEntityC & operator =(const DPEntityC & dat)
-
Assignment.
- DPEntityBodyC & Body()
-
Access body.
- const DPEntityBodyC & Body() const
-
Access body.
- DPPortBodyC & Body()
-
Access body.
- const DPPortBodyC & Body() const
-
Access body.
- bool IsAsync() const
-
Does port work asynchronously ??
- DPPortC ConnectedTo() const
-
Is this port connected to another ?
If not returns invalid handle.
- bool GetAttr(const StringC & attrName,StringC & attrValue)
-
Get a stream attribute.
Returns false if the attribute name is unknown.
This is for handling stream attributes such as frame rate, and compression ratios.
- StringC GetAttr(const StringC & attrName)
-
Get a stream attribute.
Return the value of an attribute or an empty string if its unkown.
This is for handling stream attributes such as frame rate, and compression ratios.
- bool SetAttr(const StringC & attrName,const StringC & attrValue)
-
Set a stream attribute.
Returns false if the attribute name is unknown.
This is for handling stream attributes such as frame rate, and compression ratios.
- const DPEntityBodyC & Body() const
-
Constant access to body of object.
- DPEntityBodyC & Body()
-
Constant access to body of object.
- bool Save(ostream & out) const
-
Save to stream 'out'.
- bool Save(BinOStreamC & out) const
-
Save to binary stream 'out'.
- RCAbstractC Abstract()
-
Create an abstract handle.
- istream & operator >>(istream & strm,RCHandleVC<DPEntityBodyC> & obj)
-
- BinIStreamC & operator >>(BinIStreamC & strm,RCHandleVC<DPEntityBodyC> & obj)
-
- const DPEntityC & operator =(const DPEntityC & dat)
-
Assignment.
- DPEntityBodyC & Body()
-
Access body.
- const DPEntityBodyC & Body() const
-
Access body.
- const RCHandleC<DPEntityBodyC> & operator =(const RCHandleC<DPEntityBodyC> & oth)
-
Assign handle.
- RCHandleC<DPEntityBodyC> DeepCopy(UIntT levels = ((UIntT))) const
-
Do a deep copy of the object.
- bool operator ==(const RCHandleC<DPEntityBodyC> & oth) const
-
Are handles to the same object ?
- bool operator !=(const RCHandleC<DPEntityBodyC> & oth) const
-
Are handles to different objects ?
- UIntT Hash() const
-
Default hash function.
This hashes on the address of the body.
- bool IsValid() const
-
Test if this is a valid handle.
- void Invalidate()
-
Invalidate this handle.
Unattaches the body from the handle.
- bool IsHandleType(const DT &) const
-
Is handle of given type ?
- void CheckHandleType(const DT & dummy) const
-
Check handle type. Throw an expception if not.
- DPEntityBodyC & Body()
-
Access body of object.
- const DPEntityBodyC & Body() const
-
Constant access to body of object.
- UIntT References() const
-
Find the number of references to the body of this object.
- ostream & operator <<(ostream & strm,const RCHandleC<DPEntityBodyC> & obj)
-
- istream & operator >>(istream & strm,RCHandleC<DPEntityBodyC> & obj)
-
Maintainer:Joel Mitchelson, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002
|