ImagePassThrough uses CTexturedRecognition of IVTRecognition in order to recognize and localize objects. More...

#include <VisionX/components/image_processor/ImagePassThrough/ImagePassThrough.h>

Inheritance diagram for ImagePassThrough:

Public Member Functions
armarx::PropertyDefinitionsPtr	createPropertyDefinitions () override

std::string	getDefaultName () const override

bool	getImagesAreUndistorted (const ::Ice::Current &=::Ice::emptyCurrent) override

std::string	getReferenceFrame (const ::Ice::Current &=::Ice::emptyCurrent) override

visionx::StereoCalibration	getStereoCalibration (const ::Ice::Current &=::Ice::emptyCurrent) override

	ImagePassThrough ()

void	startCapture (::Ice::Float framesPerSecond, const ::Ice::Current &current=::Ice::emptyCurrent) override

void	stopCapture (const ::Ice::Current &current=::Ice::emptyCurrent) override

Public Member Functions inherited from ImageProcessor
std::string	getImageListenerTopicName (std::string providerName) const

Public Member Functions inherited from Component
void	forceComponentCreatedByComponentCreateFunc ()
	forces the flag to be set to true that the object instance was created by the Component::create function

std::vector< PropertyUserPtr >	getAdditionalPropertyUsers () const

template<typename PropertyType>
Property< PropertyType >	getProperty (const std::string &name)

template<typename PropertyType>
Property< PropertyType >	getProperty (const std::string &name) const

template<class T>
void	getProperty (std::atomic< T > &val, const std::string &name) const

template<class T>
void	getProperty (T &val, const std::string &name) const

template<class ProxyType>
ProxyType	getProxyFromProperty (const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Get a proxy whose name is specified by the given property.

template<class ProxyType>
void	getProxyFromProperty (ProxyType &proxy, const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)

template<class TopicProxyType>
TopicProxyType	getTopicFromProperty (const std::string &propertyName)
	Get a topic proxy whose name is specified by the given property.

template<class TopicProxyType>
void	getTopicFromProperty (TopicProxyType &top, const std::string &propertyName)

void	initializeProperties (const std::string &configName, Ice::PropertiesPtr const &properties, const std::string &configDomain)
	initializes the properties of this component.

void	injectPropertyDefinitions (PropertyDefinitionsPtr &props) override

void	offeringTopicFromProperty (const std::string &propertyName)
	Offer a topic whose name is specified by the given property.

virtual void	preOnConnectComponent () override

virtual void	preOnInitComponent () override

bool	usingProxyFromProperty (const std::string &propertyName, const std::string &endpoints="")
	Use a proxy whose name is specified by the given property.

void	usingTopicFromProperty (const std::string &propertyName, bool orderedPublishing=false)
	Use a topic whose name is specified by the given property.

Public Member Functions inherited from ManagedIceObject
void	enableProfiler (bool enable)
	setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer)

std::string	generateSubObjectName (const std::string &subObjectName)
	Generates a unique name for a sub object from a general name.

ArmarXManagerPtr	getArmarXManager () const
	Returns the ArmarX manager used to add and remove components.

ManagedIceObjectConnectivity	getConnectivity () const
	Retrieve connectivity of the object (topcis as well as proxies)

IceManagerPtr	getIceManager () const
	Returns the IceManager.

VariantBasePtr	getMetaInfo (const std::string &id)

StringVariantBaseMap	getMetaInfoMap () const

std::string	getName () const
	Retrieve name of object.

Ice::ObjectAdapterPtr	getObjectAdapter () const
	Returns object's Ice adapter.

ArmarXObjectSchedulerPtr	getObjectScheduler () const

PeriodicTaskPtr	getPeriodicTask (const std::string &name)

Profiler::ProfilerPtr	getProfiler () const
	getProfiler returns an instance of armarx::Profiler

template<class ProxyTarg, class... Args>
void	getProxy (const char *name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&... args)

template<class ProxyType>
ProxyType	getProxy (const std::string &name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Retrieves a proxy object.

template<class ProxyTarg, class... Args>
void	getProxy (const std::string &name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&... args)

template<class ProxyTarg, class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const char *name, Args &&... args)

template<class ProxyTarg, class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const std::string &name, Args &&... args)
	Assigns a proxy to `proxy`.

Ice::ObjectPrx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const
	Returns the proxy of this object (optionally it waits for the proxy)

template<class Prx>
Prx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const

template<class ProxyType>
void	getProxy (ProxyType &proxy, const char *name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Overload to allow using string literals as name (solve ambiguous overload).

template<class Prx>
void	getProxy (Prx &prx, long timeoutMs=0, bool waitForScheduler=true) const

int	getState () const
	Retrieve current state of the ManagedIceObject.

template<class TopicProxyType>
TopicProxyType	getTopic (const std::string &name)
	Returns a proxy of the specified topic.

template<class TopicProxyType>
void	getTopic (TopicProxyType &topicProxy, const std::string &name)
	Assigns a proxy of the specified topic to `topicProxy`.

std::vector< std::string >	getUnresolvedDependencies () const
	returns the names of all unresolved dependencies

	ManagedIceObject (ManagedIceObject const &other)

void	offeringTopic (const std::string &name)
	Registers a topic for retrival after initialization.

void	preambleGetTopic (std::string const &name)

void	setMetaInfo (const std::string &id, const VariantBasePtr &value)
	Allows to set meta information that can be queried live via Ice interface on the ArmarXManager.

void	startPeriodicTask (const std::string &uniqueName, std::function< void(void)> f, int periodMs, bool assureMeanInterval=false, bool forceSystemTime=true)

bool	stopPeriodicTask (const std::string &name)

bool	unsubscribeFromTopic (const std::string &name)
	Unsubscribe from a topic.

bool	usingProxy (const std::string &name, const std::string &endpoints="")
	Registers a proxy for retrieval after initialization and adds it to the dependency list.

void	usingTopic (const std::string &name, bool orderedPublishing=false)
	Registers a proxy for subscription after initialization.

void	waitForObjectScheduler ()
	Waits until the ObjectScheduler could resolve all dependencies.

void	waitForProxy (std::string const &name, bool addToDependencies)

Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds.

MessageTypeT	getEffectiveLoggingLevel () const

	Logging ()

void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.

void	setTag (const LogTag &tag)

void	setTag (const std::string &tagName)

virtual	~Logging ()

Public Member Functions inherited from PropertyUser
std::vector< std::string >	getComponentProxyNames ()

Ice::PropertiesPtr	getIceProperties () const
	Returns the set of Ice properties.

template<typename PropertyType>
Property< PropertyType >	getProperty (const std::string &name)
	Property creation and retrieval.

template<typename PropertyType>
Property< PropertyType >	getProperty (const std::string &name) const
	Hack to allow using getProperty in `const`-modified methods.

template<class T>
void	getProperty (std::atomic< T > &val, const std::string &name) const

template<class T>
void	getProperty (T &val, const std::string &name) const

template<class T>
std::vector< T >	getPropertyAsCSV (const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)

template<class ContainerT>
void	getPropertyAsCSV (ContainerT &val, const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)

PropertyDefinitionsPtr	getPropertyDefinitions ()
	Returns the component's property definition container.

std::vector< std::string >	getSubscribedTopicNames ()

std::vector< std::string >	getTopicProxyNames ()

bool	hasProperty (const std::string &name)

	PropertyUser ()

virtual void	setIceProperties (Ice::PropertiesPtr properties)
	Sets the Ice properties.

bool	tryAddProperty (const std::string &propertyName, const std::string &value)

virtual void	updateIceProperties (const std::map< std::string, std::string > &changes)

void	updateProperties ()

void	updateProxies (IceManagerPtr)

	~PropertyUser () override

Public Member Functions inherited from ImageProvider
armarx::Blob	getCompressedImagesAndMetaInfo (CompressionType, Ice::Int compressionQuality, armarx::MetaInfoSizeBasePtr &info, const Ice::Current &) override

ImageFormatInfo	getImageFormat (const Ice::Current &c=Ice::emptyCurrent) override
	Returns the entire image format info struct via Ice.

armarx::Blob	getImages (const Ice::Current &c=Ice::emptyCurrent) override
	Retrieve images via Ice.

armarx::Blob	getImagesAndMetaInfo (armarx::MetaInfoSizeBasePtr &, const Ice::Current &) override

int	getNumberImages (const Ice::Current &c=Ice::emptyCurrent) override
	Retrieve number of images handled by this provider.

bool	hasSharedMemorySupport (const Ice::Current &c=Ice::emptyCurrent) override

Public Member Functions inherited from ArVizComponentPluginUser
	ArVizComponentPluginUser ()

armarx::viz::Client	createArVizClient ()

armarx::viz::Client &	getArvizClient ()

Public Member Functions inherited from LightweightRemoteGuiComponentPluginUser
	LightweightRemoteGuiComponentPluginUser ()

void	RemoteGui_createTab (std::string const &name, RemoteGui::Client::Widget const &rootWidget, RemoteGui::Client::Tab *tab)

bool	RemoteGui_isRunning ()

void	RemoteGui_run ()

void	RemoteGui_startRunningTask ()

Protected Member Functions
void	createRemoteGuiTab ()

StereoCalibrationInterfacePrx	getStereoCalibrationProvider ()

void	onConnectComponent () final
	Pure virtual hook for the subclass.

void	onConnectImageProcessor () override
	Implement this method in the ImageProcessor in order execute parts when the component is fully initialized and about to run.

void	onDisconnectComponent () final
	Hook for subclass.

void	onDisconnectImageProcessor () override
	Implement this method in the ImageProcessor in order execute parts when the component looses network connectivity.

void	onExitComponent () final
	Hook for subclass.

void	onExitImageProcessor () override
	Exit the ImapeProcessor component.

void	onExitImageProvider () override
	This is called when the Component::onExitComponent() setup is called.

void	onInitComponent () final
	Pure virtual hook for the subclass.

void	onInitImageProcessor () override
	Setup the vision component.

void	onInitImageProvider () override
	This is called when the Component::onInitComponent() is called.

void	process () override
	Process the vision component.

void	RemoteGui_update () override

Protected Member Functions inherited from ImageProcessor
void	cleanup ()
	clean up memory

void	componentPropertiesUpdated (const std::set< std::string > &changedProperties) override
	Implement this function if you would like to react to changes in the properties.

armarx::PropertyDefinitionsPtr	createPropertyDefinitions () override

void	enableResultImages (int numberImages, ImageDimension imageDimension, ImageType imageType, const std::string &name="")
	Enables visualization.

int	getCompressionQuality () const

CompressionType	getCompressionType () const

float	getFramerate () const

std::string	getHardwareId (const Ice::Current &c=Ice::emptyCurrent)
	Returns machines hardware Id string.

armarx::MetaInfoSizeBasePtr	getImageMetaInfo (const std::string &imageProviderName="") const
	Get meta information from the image provider.

ImageProviderInfo	getImageProvider (std::string name, bool waitForProxy, ImageType destinationImageType=eRgb)

ImageProviderInfo	getImageProvider (std::string name, ImageType destinationImageType=eRgb, bool waitForProxy=false)
	Select an ImageProvider.

int	getImages (CByteImage **ppImages)
	Poll images from provider.

int	getImages (CFloatImage **ppImages)

int	getImages (std::string providerName, CByteImage **ppImages, armarx::MetaInfoSizeBasePtr &info)
	Poll images from provider.

int	getImages (std::string providerName, CFloatImage **ppImages, armarx::MetaInfoSizeBasePtr &info)

int	getImages (std::string providerName, const std::vector< CByteImageUPtr > &ppImages, armarx::MetaInfoSizeBasePtr &info)

int	getImages (std::string providerName, void **ppBuffer, armarx::MetaInfoSizeBasePtr &info)

int	getImages (void **ppBuffer)

ImageTransferStats	getImageTransferStats (std::string provideNname, bool resetStats=false)
	Retrieve statistics for a connection to an ImageProvider.

int	getNumberOfImages (const std::string &providerName="")
	Returns the number of images provided by the specified image provider If no provider is specified, the first provider is taken.

bool	isNewImageAvailable ()

bool	isNewImageAvailable (const std::string &providerName)

void	onConnectComponent () override

void	onDisconnectComponent () override

void	onExitComponent () override

void	onInitComponent () override

void	provideResultImages (CByteImage **images, armarx::MetaInfoSizeBasePtr info=nullptr)
	sends result images for visualization

void	provideResultImages (const std::vector< CByteImageUPtr > &images, armarx::MetaInfoSizeBasePtr info=nullptr)

void	releaseImageProvider (std::string providerName)

void	reportImageAvailable (const std::string &providerName, const Ice::Current &c=Ice::emptyCurrent) override
	Listener callback function.

virtual void	runProcessor ()

void	setCompressionType (CompressionType compressionType=ePNG, int compressionQuality=9)
	Sets the compression type and compression quality.

void	setFramerate (float fps)

void	usingImageProvider (std::string name)
	Registers a delayed topic subscription and a delayed provider proxy retrieval which all will be available on the start of the component.

bool	waitForImages (int milliseconds=1000)
	Wait for new images.

bool	waitForImages (std::string providerName, IceUtil::Time waitTime)

bool	waitForImages (std::string providerName, int milliseconds=1000)
	Wait for new images.

Protected Member Functions inherited from Component
void	addPropertyUser (const PropertyUserPtr &subPropertyUser)
	Add additional property users here that should show up in the application help text.

	Component ()
	Protected default constructor. Used for virtual inheritance. Use createManagedIceObject() instead.

std::string	getConfigDomain ()
	Retrieve config domain for this component as set in constructor.

std::string	getConfigIdentifier ()
	Retrieve config identifier for this component as set in constructor.

std::string	getConfigName ()
	Retrieve config name for this component as set in constructor.

virtual void	icePropertiesInitialized ()

Protected Member Functions inherited from ManagedIceObject
template<class PluginT, class... ParamsT>
PluginT *	addPlugin (const std::string prefix="", ParamsT &&... params)

template<class PluginT, class... ParamsT>
void	addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&... params)

template<class PluginT, class... ParamsT>
void	addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&... params)

Ice::CommunicatorPtr	getCommunicator () const

std::unique_ptr< ManagedIceObjectPlugin > &	getPluginPointer (std::type_info const &type, std::string const &prefix)

	ManagedIceObject ()
	Protected default constructor.

virtual void	postOnConnectComponent ()

virtual void	postOnDisconnectComponent ()

virtual void	postOnExitComponent ()

virtual void	postOnInitComponent ()

virtual void	preOnDisconnectComponent ()

virtual void	preOnExitComponent ()

bool	removeProxyDependency (const std::string &name)
	This function removes the dependency of this object on the in parameter name specified object.

void	setName (std::string name)
	Override name of well-known object.

void	terminate ()
	Initiates termination of this IceManagedObject.

	~ManagedIceObject () override

Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const

const LogSenderPtr &	getLogSender () const
	Retrieve log sender.

LogSenderPtr	loghelper (const char file, int line, const char function) const

Protected Member Functions inherited from ImageProvider
armarx::UnitExecutionState	getExecutionState (const Ice::Current &c) override

std::vector< imrec::ChannelPreferences >	getImageRecordingChannelPreferences (const Ice::Current &) override

imrec::Status	getImageRecordingStatus (const Ice::Current &) override

armarx::SharedMemoryScopedWriteLockPtr	getScopedWriteLock ()
	Retrieve scoped lock for writing to the memory.

void	imageRecordingRunningTask ()

void	init (const Ice::Current &c) override

bool	isExiting ()
	Retrieve whether provider is exiting.

void	onConnectComponent () override

virtual void	onConnectImageProvider ()
	This is called when the Component::onConnectComponent() setup is called.

void	onDisconnectComponent () override
	Hook for subclass.

virtual void	onDisconnectImageProvider ()

void	onExitComponent () override

void	onInitComponent () override

void	provideImages (CByteImage **images, const IceUtil::Time &imageTimestamp=IceUtil::Time())
	send ByteImages.

void	provideImages (CFloatImage **images, const IceUtil::Time &imageTimestamp=IceUtil::Time())
	send FloatImages.

void	provideImages (const std::vector< CByteImageUPtr > &images, const IceUtil::Time &imageTimestamp=IceUtil::Time())

void	provideImages (void **inputBuffers, const IceUtil::Time &imageTimestamp=IceUtil::Time())
	send images raw.

void	recordImages (const IceUtil::Time &image_timestamp)

void	release (const Ice::Current &c) override

void	request (const Ice::Current &c) override

void	setImageFormat (ImageDimension imageDimension, ImageType imageType, BayerPatternType bayerPatternType=visionx::eBayerPatternRg)
	Sets the image basic format data.

void	setNumberImages (int numberImages)
	Sets the number of images on each capture.

void	start (const Ice::Current &c) override

bool	startImageRecording (const imrec::Config &cfg, const Ice::Current &) override

void	stop (const Ice::Current &c) override

bool	stopImageRecording (const Ice::Current &) override

void	updateTimestamp (const armarx::DateTime &timestamp, bool threadSafe=true)

void	updateTimestamp (Ice::Long timestamp, bool threadSafe=true)
	Updates the timestamp of the currently captured image.

void	updateTimestamp (IceUtil::Time timestamp, bool threadSafe=true)

Additional Inherited Members
Public Types inherited from ManagedIceObject
using	PeriodicTaskPtr = IceUtil::Handle<SimplePeriodicTask<std::function<void(void)>>>

Static Public Member Functions inherited from Component
template<class T, class TPtr = IceInternal::Handle<T>>
static TPtr	create (Ice::PropertiesPtr properties=Ice::createProperties(), const std::string &configName="", const std::string &configDomain="ArmarX")
	Factory method for a component.

Static Public Member Functions inherited from ManagedIceObject
static std::string	generateSubObjectName (const std::string &superObjectName, const std::string &subObjectName)
	Generates a unique name for a sub object from a general name and unique name.

static std::string	GetObjectStateAsString (int state)

Public Attributes inherited from ArVizComponentPluginUser
armarx::viz::Client	arviz

Public Attributes inherited from LightweightRemoteGuiComponentPluginUser
plugins::LightweightRemoteGuiComponentPlugin *	plugin = nullptr

int	RemoteGui_updatePeriodInMS = 20

Static Public Attributes inherited from ImageProcessor
static std::string	ListenerSuffix = ".ImageListener"

Static Public Attributes inherited from ManagedIceObject
static const ManagedIceObjectPtr	NullPtr
	A nullptr to be used when a const ref to a nullptr is required.

Protected Types inherited from ImageProcessor
using	ImageProviderMap

Protected Attributes inherited from ImageProcessor
int	compressionQuality = 9

CompressionType	compressionType = eNoCompression

float	desiredFps = 0

std::map< std::string, ImageProviderInfo >	imageProviderInfoMap

std::shared_mutex	imageProviderInfoMutex

armarx::PeriodicTask< ImageProcessor >::pointer_type	processorTask

IceInternal::Handle< ResultImageProvider >	resultImageProvider

bool	startProcessorTask = true

std::map< std::string, ImageTransferStats >	statistics

std::mutex	statisticsMutex

ImageProviderMap	usedImageProviders

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Protected Attributes inherited from ImageProvider
void **	imageBuffers
	Image buffer memory.

ImageProcessorInterfacePrx	imageProcessorProxy
	Ice proxy of the image processor interface.

armarx::IceSharedMemoryProvider< unsignedchar >::pointer_type	sharedMemoryProvider
	shared memory provider

Detailed Description

ImagePassThrough uses CTexturedRecognition of IVTRecognition in order to recognize and localize objects.

The object data is read from PriorKnowledge and CommonStorage via MemoryX. The object localization is invoked automatically by the working memory if the object has been requested there.

Definition at line 63 of file ImagePassThrough.h.

Constructor & Destructor Documentation

◆ ImagePassThrough()

ImagePassThrough ( )

Definition at line 95 of file ImagePassThrough.cpp.

Member Function Documentation

◆ createPropertyDefinitions()

armarx::PropertyDefinitionsPtr createPropertyDefinitions ( )

overridevirtual

See also: PropertyUser::createPropertyDefinitions()

Reimplemented from Component.

Definition at line 62 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ createRemoteGuiTab()

void createRemoteGuiTab ( )

protected

Definition at line 253 of file ImagePassThrough.cpp.

◆ getDefaultName()

std::string getDefaultName ( ) const

overridevirtual

See also: Component::getDefaultName()

Implements ManagedIceObject.

Definition at line 101 of file ImagePassThrough.cpp.

◆ getImagesAreUndistorted()

bool getImagesAreUndistorted ( const ::Ice::Current & = ::Ice::emptyCurrent )

override

Definition at line 302 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ getReferenceFrame()

std::string getReferenceFrame ( const ::Ice::Current & = ::Ice::emptyCurrent )

override

Definition at line 290 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ getStereoCalibration()

visionx::StereoCalibration getStereoCalibration ( const ::Ice::Current & = ::Ice::emptyCurrent )

override

Definition at line 296 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ getStereoCalibrationProvider()

StereoCalibrationInterfacePrx getStereoCalibrationProvider ( )

protected

Definition at line 308 of file ImagePassThrough.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onConnectComponent()

void onConnectComponent ( )

inlinefinalprotectedvirtual

Pure virtual hook for the subclass.

Is called once all dependencies of the object have been resolved and Ice connection is established. This hook is called whenever the dependencies are found. That means if the a depedency crashes or shuts down, the ManagedIceObject goes into disconnected state. When the dependencies are found again, this hook is called again.

See also: onDisconnectComponent()

Implements ManagedIceObject.

Definition at line 101 of file ImagePassThrough.h.

Here is the call graph for this function:

◆ onConnectImageProcessor()

void onConnectImageProcessor ( )

overrideprotectedvirtual

Implement this method in the ImageProcessor in order execute parts when the component is fully initialized and about to run.

Implements ImageProcessor.

Definition at line 138 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ onDisconnectComponent()

void onDisconnectComponent ( )

inlinefinalprotectedvirtual

Hook for subclass.

Is called if a dependency of the object got lost (crash, network error, stopped, ...). This hook should be the inverse to onConnectComponent(). So that onDisconnectComponent() and onConnectComponent() can be called alternatingly and the ManagedIceObject remains in valid states. *

See also: onConnectComponent

Reimplemented from ManagedIceObject.

Definition at line 108 of file ImagePassThrough.h.

Here is the call graph for this function:

◆ onDisconnectImageProcessor()

void onDisconnectImageProcessor ( )

inlineoverrideprotectedvirtual

Implement this method in the ImageProcessor in order execute parts when the component looses network connectivity.

Reimplemented from ImageProcessor.

Definition at line 125 of file ImagePassThrough.h.

◆ onExitComponent()

void onExitComponent ( )

inlinefinalprotectedvirtual

Hook for subclass.

Is called once the component terminates. Use for cleanup. Only called once.

Reimplemented from ManagedIceObject.

Definition at line 115 of file ImagePassThrough.h.

Here is the call graph for this function:

◆ onExitImageProcessor()

void onExitImageProcessor ( )

inlineoverrideprotectedvirtual

Exit the ImapeProcessor component.

Implement this method in order to clean up the ImageProcessor

Implements ImageProcessor.

Definition at line 130 of file ImagePassThrough.h.

◆ onExitImageProvider()

void onExitImageProvider ( )

inlineoverrideprotectedvirtual

This is called when the Component::onExitComponent() setup is called.

Implement this method in the ImageProvider in order clean up right before terminating.

Implements ImageProvider.

Definition at line 140 of file ImagePassThrough.h.

◆ onInitComponent()

void onInitComponent ( )

inlinefinalprotectedvirtual

Pure virtual hook for the subclass.

Is called once initialization of the ManagedIceObject is done. This hook is called in the implenting class once and never again during the lifecyle of the object. This function is called as soon as the ManagedIceObject was added to the ArmarXManager. Called in an own thread and not the thread it was created in.

Implements ManagedIceObject.

Definition at line 94 of file ImagePassThrough.h.

Here is the call graph for this function:

◆ onInitImageProcessor()

void onInitImageProcessor ( )

overrideprotectedvirtual

Setup the vision component.

Implement this method in the ImageProcessor in order to setup its parameters. Use this for the registration of adaptars and subscription to topics

Parameters

argc	number of filtered command line arguments
argv	filtered command line arguments

Implements ImageProcessor.

Definition at line 107 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ onInitImageProvider()

void onInitImageProvider ( )

inlineoverrideprotectedvirtual

This is called when the Component::onInitComponent() is called.

Implement this method in the ImageProvider in order to setup its parameters. Use this to set the image format.

Implements ImageProvider.

Definition at line 135 of file ImagePassThrough.h.

◆ process()

void process ( )

overrideprotectedvirtual

Process the vision component.

The main loop of the imageprocessor to be implemented in the subclass. Do not block this method. One process should execute exactly one image processing step. The rate at which this function is called can be set with setFramerate(). If no framerate is set, the process will run as fast as possible.

See also: setFramerate

Implements ImageProcessor.

Definition at line 226 of file ImagePassThrough.cpp.

Here is the call graph for this function:

◆ RemoteGui_update()

void RemoteGui_update ( )

overrideprotectedvirtual

Implements LightweightRemoteGuiComponentPluginUser.

Definition at line 277 of file ImagePassThrough.cpp.

◆ startCapture()

void startCapture	(	::Ice::Float	framesPerSecond,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

override

Definition at line 321 of file ImagePassThrough.cpp.

◆ stopCapture()

void stopCapture ( const ::Ice::Current & current = ::Ice::emptyCurrent )

override

Definition at line 326 of file ImagePassThrough.cpp.

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

VisionX/components/image_processor/ImagePassThrough/ImagePassThrough.h
VisionX/components/image_processor/ImagePassThrough/ImagePassThrough.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImagePassThrough()

Member Function Documentation

◆ createPropertyDefinitions()

◆ createRemoteGuiTab()

◆ getDefaultName()

◆ getImagesAreUndistorted()

◆ getReferenceFrame()

◆ getStereoCalibration()

◆ getStereoCalibrationProvider()

◆ onConnectComponent()

◆ onConnectImageProcessor()

◆ onDisconnectComponent()

◆ onDisconnectImageProcessor()

◆ onExitComponent()

◆ onExitImageProcessor()

◆ onExitImageProvider()

◆ onInitComponent()

◆ onInitImageProcessor()

◆ onInitImageProvider()

◆ process()

◆ RemoteGui_update()

◆ startCapture()

◆ stopCapture()