cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
mtsMicronTracker Class Reference

#include <mtsMicronTracker.h>

Inheritance diagram for mtsMicronTracker:
mtsTaskPeriodic mtsTaskContinuous mtsTask mtsComponent cmnGenericObject

Classes

class  Tool
 

Public Member Functions

 mtsMicronTracker (const std::string &taskName, const double period)
 
 mtsMicronTracker (const mtsTaskPeriodicConstructorArg &arg)
 
 ~mtsMicronTracker (void)
 
void Construct (void)
 
void Configure (const std::string &filename="")
 
void Startup (void)
 
void Run (void)
 
void Cleanup (void)
 
size_t GetNumberOfTools (void) const
 
std::string GetToolName (const unsigned int index) const
 
svlBufferSampleGetImageBufferLeft (void)
 
svlBufferSampleGetImageBufferRight (void)
 
- Public Member Functions inherited from mtsTaskPeriodic
 mtsTaskPeriodic (const std::string &name, double periodicityInSeconds, bool isHardRealTime=false, unsigned int sizeStateTable=256, bool newThread=true)
 
 mtsTaskPeriodic (const std::string &name, const osaAbsoluteTime &periodicity, bool isHardRealTime=false, unsigned int sizeStateTable=256, bool newThread=true)
 
 mtsTaskPeriodic (const mtsTaskPeriodicConstructorArg &arg)
 
virtual ~mtsTaskPeriodic ()
 
void Suspend (void)
 
double GetPeriodicity (void) const
 
bool IsPeriodic (void) const
 
- Public Member Functions inherited from mtsTaskContinuous
 mtsTaskContinuous (const std::string &name, unsigned int sizeStateTable=256, bool newThread=true)
 
 mtsTaskContinuous (const mtsTaskContinuousConstructorArg &arg)
 
virtual ~mtsTaskContinuous ()
 
void Create (void *data=0)
 
void Start (void)
 
void Kill (void)
 
- Public Member Functions inherited from mtsTask
 mtsTask (const std::string &name, unsigned int sizeStateTable=256)
 
virtual ~mtsTask ()
 
virtual void OnStartupException (const std::exception &excp)
 
virtual void OnRunException (const std::exception &excp)
 
virtual void Configure (const std::string &CMN_UNUSED(filename)="")
 
void SetInitializationDelay (double delay)
 
void Create (void)
 
double GetAveragePeriod (void) const
 
const std::string GetDefaultStateTableName (void) const
 
mtsStateTableGetDefaultStateTable (void)
 
mtsInterfaceRequiredAddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED)
 
mtsInterfaceProvidedAddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)
 
virtual bool WaitToStart (double timeout)
 
virtual bool WaitToTerminate (double timeout)
 
virtual void WaitForWakeup (void)
 
virtual void Wakeup (void)
 
void ProcessManagerCommandsIfNotActive ()
 
bool CheckForOwnThread (void) const
 
virtual bool IsOverranPeriod (void) const
 
virtual void ResetOverranPeriod (void)
 
- Public Member Functions inherited from mtsComponent
 mtsComponent (const std::string &deviceName)
 
virtual ~mtsComponent ()
 
const std::string & GetName (void) const
 
void GetName (std::string &placeHolder) const
 
void SetName (const std::string &componentName)
 
bool CreateAndWait (double timeoutInSeconds)
 
bool StartAndWait (double timeoutInSeconds)
 
bool KillAndWait (double timeoutInSeconds)
 
mtsInterfaceProvidedAddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)
 
CISST_DEPRECATED
mtsInterfaceProvided
AddProvidedInterface (const std::string &interfaceProvidedName)
 
virtual mtsInterfaceOutputAddInterfaceOutput (const std::string &interfaceOutputName)
 
bool InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
bool InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
bool InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
mtsInterfaceProvidedGetInterfaceProvided (const std::string &interfaceProvidedName) const
 
mtsInterfaceOutputGetInterfaceOutput (const std::string &interfaceOutputName) const
 
size_t GetNumberOfInterfacesProvided (void) const
 
size_t GetNumberOfInterfacesOutput (void) const
 
bool RemoveInterfaceProvided (const std::string &interfaceProvidedName, const bool skipDisconnect=false)
 
mtsInterfaceRequiredAddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
 
CISST_DEPRECATED
mtsInterfaceRequired
AddRequiredInterface (const std::string &requiredInterfaceName)
 
virtual mtsInterfaceInputAddInterfaceInput (const std::string &interfaceInputName)
 
const mtsInterfaceProvidedGetInterfaceProvidedFor (const std::string &interfaceRequiredName)
 
mtsInterfaceRequiredGetInterfaceRequired (const std::string &interfaceRequiredName)
 
mtsInterfaceInputGetInterfaceInput (const std::string &interfaceInputName) const
 
size_t GetNumberOfInterfacesRequired (void) const
 
size_t GetNumberOfInterfacesInput (void) const
 
bool RemoveInterfaceRequired (const std::string &interfaceRequiredName, const bool skipDisconnect=false)
 
const mtsManagerComponentServicesGetManagerComponentServices (void) const
 
mtsManagerComponentServicesGetManagerComponentServices (void)
 
mtsStateTableGetStateTable (const std::string &stateTableName)
 
bool AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)
 
void UseSeparateLogFileDefault (bool forwardToLogger=true)
 
void UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)
 
void UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)
 
cmnLogger::StreamBufTypeGetLogMultiplexer (void) const
 
bool IsRunning (void) const
 
bool CISST_DEPRECATED Running (void) const
 
bool IsStarted (void) const
 
bool IsTerminated (void) const
 
bool IsEndTask (void) const
 
const mtsComponentStateGetState (void) const
 
void GetState (mtsComponentState &state) const
 
void ToStream (std::ostream &outputStream) const
 
bool SetReplayMode (void)
 
bool SetReplayData (const std::string &stateTableName, const std::string &fileName)
 
bool SetReplayTime (const double time)
 
std::vector< std::string > GetNamesOfInterfacesProvidedOrOutput (void) const
 
std::vector< std::string > GetNamesOfInterfacesProvided (void) const
 
std::vector< std::string > GetNamesOfInterfacesOutput (void) const
 
std::vector< std::string > GetNamesOfInterfacesRequiredOrInput (void) const
 
std::vector< std::string > GetNamesOfInterfacesRequired (void) const
 
std::vector< std::string > GetNamesOfInterfacesInput (void) const
 
- Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
 
virtual const
cmnClassServicesBase
Services (void) const =0
 
bool ReconstructFrom (const cmnGenericObject &other)
 
std::string ToString (void) const
 
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
virtual void SerializeRaw (std::ostream &outputStream) const
 
virtual void DeSerializeRaw (std::istream &inputStream)
 
virtual size_t ScalarNumber (void) const
 
virtual bool ScalarNumberIsFixed (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
 

Protected Types

enum  { LEFT_CAMERA, RIGHT_CAMERA, MIDDLE_CAMERA }
 
typedef cmnNamedMap< ToolToolsType
 
- Protected Types inherited from mtsComponent
typedef cmnNamedMap
< mtsStateTable
StateTableMapType
 
typedef cmnNamedMap
< mtsInterfaceProvided
InterfacesProvidedMapType
 
typedef cmnNamedMap
< mtsInterfaceOutput
InterfacesOutputMapType
 
typedef cmnNamedMap
< mtsInterfaceRequired
InterfacesRequiredMapType
 
typedef cmnNamedMap
< mtsInterfaceInput
InterfacesInputMapType
 

Protected Member Functions

ToolCheckTool (const std::string &serialNumber)
 
ToolAddTool (const std::string &name, const std::string &serialNumber)
 
vctFrm3 XfHandleToFrame (mtHandle &xfHandle)
 
mtHandle FrameToXfHandle (vctFrm3 &frame)
 
void InitComponent (void)
 
void ToggleCapturing (const bool &toggle)
 
void ToggleTracking (const bool &toggle)
 
void Track (void)
 
void TrackXPoint (void)
 
void CalibratePivot (const std::string &toolName)
 
void ComputeCameraModel (const std::string &pathRectificationLUT)
 
void SetJitterFilterEnabled (const mtsBool &flag)
 
void SetJitterCoefficient (const double &coefficient)
 
void SetKalmanFilterEnabled (const mtsBool &flag)
 
- Protected Member Functions inherited from mtsTaskPeriodic
virtual void * RunInternal (void *argument)
 
void StartupInternal (void)
 
void CleanupInternal (void)
 
void StartInternal (void)
 
- Protected Member Functions inherited from mtsTask
void RunEventHandler (void)
 
void ChangeStateEventHandler (const mtsComponentState &newState)
 
mtsExecutionResult RunEvent (bool check=true)
 
void DoRunInternal (void)
 
void Sleep (double timeInSeconds)
 
mtsStateIndex::TimeTicksType GetTick (void) const
 
virtual void SaveThreadStartData (void *data)
 
virtual void SetThreadReturnValue (void *returnValue)
 
void ChangeState (mtsComponentState::Enum newState)
 
bool WaitForState (mtsComponentState desiredState, double timeout)
 
- Protected Member Functions inherited from mtsComponent
 mtsComponent (void)
 
 mtsComponent (const mtsComponent &other)
 
void Initialize (void)
 
mtsInterfaceRequiredAddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)
 
mtsInterfaceRequiredAddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)
 
mtsInterfaceProvidedAddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)
 
mtsInterfaceInputAddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)
 
mtsInterfaceOutputAddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)
 
void KillSeparateLogFile (void)
 
size_t ProcessMailBoxes (InterfacesProvidedMapType &interfaces)
 
size_t ProcessQueuedCommands (void)
 
size_t ProcessQueuedEvents (void)
 
mtsInterfaceRequiredEnableDynamicComponentManagement (void)
 Enable support for dynamic component management services. More...
 
bool AddInterfaceInternal (const bool useMangerComponentServices=false)
 Add internal interfaces. More...
 
void InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
 
void InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
 
void InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
 
void InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
 
void InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)
 
void InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)
 

Protected Attributes

int FrameWidth
 
int FrameHeight
 
std::string CameraCalibrationDir
 
std::string MarkerTemplatesDir
 
ToolsType Tools
 
bool IsCapturing
 
bool IsTracking
 
int XPointsMaxNum
 
std::vector< vct3XPoints
 
std::vector< vct3XPointsProjectionLeft
 
std::vector< vct3XPointsProjectionRight
 
mtHandle CurrentCamera
 
mtHandle IdentifyingCamera
 
mtHandle IdentifiedMarkers
 
mtHandle PoseXf
 
mtHandle Path
 
mtsDoubleVec MarkerProjectionLeft
 
mtsStateTableImageTable
 
mtsUCharVec ImageLeft
 
mtsUCharVec ImageRight
 
svlSampleImageRGBRGB
 
svlBufferSampleImageBufferLeft
 
svlBufferSampleImageBufferRight
 
- Protected Attributes inherited from mtsTaskPeriodic
osaThreadBuddy ThreadBuddy
 
double Period
 
osaAbsoluteTime AbsoluteTimePeriod
 
bool IsHardRealTime
 
- Protected Attributes inherited from mtsTaskContinuous
bool NewThread
 
bool CaptureThread
 
- Protected Attributes inherited from mtsTask
osaThread Thread
 
double InitializationDelay
 
osaMutex StateChange
 
osaThreadSignal StateChangeSignal
 
mtsStateTable StateTable
 
bool OverranPeriod
 
void * ThreadStartData
 
void * ReturnValue
 
mtsCallableVoidBaseInterfaceProvidedToManagerCallable
 
mtsInterfaceRequiredExecIn
 
mtsInterfaceProvidedExecOut
 
mtsFunctionVoid RunEventInternal
 
bool RunEventCalled
 
mtsFunctionWrite ChangeStateEvent
 
- Protected Attributes inherited from mtsComponent
std::string Name
 
mtsComponentState State
 
mtsInterfaceProvidedInterfaceProvidedToManager
 
bool UseSeparateLogFileFlag
 
cmnLogger::StreamBufTypeLoDMultiplexerStreambuf
 
std::ofstream * LogFile
 
StateTableMapType StateTables
 
mtsManagerComponentServicesManagerComponentServices
 
mtsFunctionWrite EventGeneratorChangeState
 
bool ReplayMode
 
InterfacesProvidedMapType InterfacesProvided
 
InterfacesOutputMapType InterfacesOutput
 
InterfacesRequiredMapType InterfacesRequired
 
InterfacesInputMapType InterfacesInput
 

Additional Inherited Members

- Public Types inherited from mtsTaskPeriodic
typedef mtsTaskContinuous BaseType
 
- Public Types inherited from mtsTaskContinuous
typedef mtsTask BaseType
 
- Public Types inherited from mtsTask
typedef mtsComponent BaseType
 
- Public Types inherited from mtsComponent
typedef mtsComponent ThisType
 
- Static Public Attributes inherited from mtsTask
static std::runtime_error UnknownException
 

Member Typedef Documentation

Member Enumeration Documentation

anonymous enum
protected
Enumerator
LEFT_CAMERA 
RIGHT_CAMERA 
MIDDLE_CAMERA 

Constructor & Destructor Documentation

mtsMicronTracker::mtsMicronTracker ( const std::string &  taskName,
const double  period 
)
inline
mtsMicronTracker::mtsMicronTracker ( const mtsTaskPeriodicConstructorArg arg)
inline
mtsMicronTracker::~mtsMicronTracker ( void  )
inline

Member Function Documentation

Tool* mtsMicronTracker::AddTool ( const std::string &  name,
const std::string &  serialNumber 
)
protected
void mtsMicronTracker::CalibratePivot ( const std::string &  toolName)
protected
Tool* mtsMicronTracker::CheckTool ( const std::string &  serialNumber)
protected
void mtsMicronTracker::Cleanup ( void  )
virtual

Virtual method that gets overloaded, and is run after the component gets killed using Kill() method.

Reimplemented from mtsComponent.

void mtsMicronTracker::ComputeCameraModel ( const std::string &  pathRectificationLUT)
protected
void mtsMicronTracker::Configure ( const std::string &  filename = "")
virtual

The virtual method so that the interface or tasks can configure themselves

Reimplemented from mtsComponent.

void mtsMicronTracker::Construct ( void  )
mtHandle mtsMicronTracker::FrameToXfHandle ( vctFrm3 frame)
protected
svlBufferSample* mtsMicronTracker::GetImageBufferLeft ( void  )
inline
svlBufferSample* mtsMicronTracker::GetImageBufferRight ( void  )
inline
size_t mtsMicronTracker::GetNumberOfTools ( void  ) const
inline
std::string mtsMicronTracker::GetToolName ( const unsigned int  index) const
void mtsMicronTracker::InitComponent ( void  )
protected
void mtsMicronTracker::Run ( void  )
virtual

Pure virtual method that gets overloaded to run the actual task.

Implements mtsTask.

void mtsMicronTracker::SetJitterCoefficient ( const double &  coefficient)
protected
void mtsMicronTracker::SetJitterFilterEnabled ( const mtsBool flag)
protected
void mtsMicronTracker::SetKalmanFilterEnabled ( const mtsBool flag)
protected
void mtsMicronTracker::Startup ( void  )
virtual

Virtual method that gets overloaded, and is run before the component is started.

Reimplemented from mtsComponent.

void mtsMicronTracker::ToggleCapturing ( const bool &  toggle)
protected
void mtsMicronTracker::ToggleTracking ( const bool &  toggle)
protected
void mtsMicronTracker::Track ( void  )
protected
void mtsMicronTracker::TrackXPoint ( void  )
protected
vctFrm3 mtsMicronTracker::XfHandleToFrame ( mtHandle &  xfHandle)
protected

Member Data Documentation

std::string mtsMicronTracker::CameraCalibrationDir
protected
mtHandle mtsMicronTracker::CurrentCamera
protected
int mtsMicronTracker::FrameHeight
protected
int mtsMicronTracker::FrameWidth
protected
mtHandle mtsMicronTracker::IdentifiedMarkers
protected
mtHandle mtsMicronTracker::IdentifyingCamera
protected
svlBufferSample* mtsMicronTracker::ImageBufferLeft
protected
svlBufferSample* mtsMicronTracker::ImageBufferRight
protected
mtsUCharVec mtsMicronTracker::ImageLeft
protected
mtsUCharVec mtsMicronTracker::ImageRight
protected
mtsStateTable* mtsMicronTracker::ImageTable
protected
bool mtsMicronTracker::IsCapturing
protected
bool mtsMicronTracker::IsTracking
protected
mtsDoubleVec mtsMicronTracker::MarkerProjectionLeft
protected
std::string mtsMicronTracker::MarkerTemplatesDir
protected
mtHandle mtsMicronTracker::Path
protected
mtHandle mtsMicronTracker::PoseXf
protected
svlSampleImageRGB* mtsMicronTracker::RGB
protected
ToolsType mtsMicronTracker::Tools
protected
std::vector<vct3> mtsMicronTracker::XPoints
protected
int mtsMicronTracker::XPointsMaxNum
protected
std::vector<vct3> mtsMicronTracker::XPointsProjectionLeft
protected
std::vector<vct3> mtsMicronTracker::XPointsProjectionRight
protected

The documentation for this class was generated from the following file: