Skip to content

cisstStereoVision svlFilterBase

Anton Deguet edited this page May 6, 2014 · 3 revisions

svlFilterBase class

Every filter of the cisstStereoVision library is derived from the baseclass svlFilterBase.

Methods to be implemented

Name Description
default constructor Typically, input and output connectors and their supported sample types are added in the default constructor.
int Initialize(svlSample * syncInput, svlSample * syncOutput) Input sample prototype for the synchronous input is stored in syncInput. If the filter has outputs, the Initialize method is responsible for providing sample prototypes for the filters that may be connected to them. The sample prototype for the synchronous output needs to be passed along in syncOutput. Sample prototypes for the asynchronous outputs need to be pushed to the corresponding outputs.
int Process(svlProcInfo * procInfo, svlSample * syncInput, svlSample * syncOutput) The synchronous input sample is stored in syncInput. If the filter has outputs, the synchronous output sample needs to be passed along in syncOutput. Samples for the asynchronous outputs may be pushed to the corresponding outputs.

Optional overloadable methods

Name Description
int OnConnectInput(svlFilterInput & input, svlStreamType type)
int OnStart(unsigned int procCount)
void OnStop(void)
int Release(void)

Public methods

Name Description
bool IsInitialized(void)
bool IsRunning(void)
unsigned int GetFrameCounter(void)
svlFilterInput * GetInput(void)
svlFilterOutput * GetOutput(void)
svlFilterInput * GetInput(std::string & inputname)
svlFilterOutput * GetOutput(std::string & outputname)
void SetEnable(bool & enable)
void GetEnable(bool & enable)
void Enable(void)
void Disable(void)
bool IsEnabled(void)
bool IsDisabled(void)

Protected methods

Name Description
svlFilterInput * AddInput(std::string & inputName, bool trunk)
svlFilterOutput * AddOutput(std::string & outputName, bool trunk)
int AddInputType(std::string & inputname, svlStreamType type)
int SetOutputType(std::string & outputname, svlStreamType type)
void SetAutomaticOutputType(bool autotype)
int IsDataValid(svlStreamType type, svlSample * data)
bool IsNewSample(svlSample * sample)
Clone this wiki locally