User Documentation

Here is a list of all related documentation pages:

[detail level 12345]

How to use data from the last time the robot was running on startup
▼ArmarX Packages
armarx_navigation Overview
armarx_view_selection Overview
▼Work in Progress
▼GUI Plugins
►ArmarXGui GuiPlugins
ScenarioManager
StatechartEditor	The Statechart Editor is a powerful and convenient tool to design complex behavior
SystemStateMonitor	The SystemStateMonitor allows you to inspect the properties of the running ArmarX components
ConditionViewer	With this widget conditions can be visualized
LogViewer	The log viewer allows you to filter and view log messages from all running ArmarX applications
ObserverGui	This widget allows to inspect all observers in the system and their content
Live Plotter	The plotter widget allows the user to plot any sensor channel
Static Plotter	The plotter widget allows the user to send data to a the StaticPlotterInterface topic, which can be plotted with this widget. To send plotting data from your code use code similar to this:
EventSender	This widget allows the user to create event senders
StatechartViewer	The StatechartViewer is a GUI to inspect currently running statecharts
ThreadViewer	The ThreadViewer displays all threads of an ArmarX application
IceGridViewer	The IceGridViewer shows the current state of a running IceGrid instance
IceProxy	The IceProxy widget allows you to gather basig information about a proxy (i.e
Clock	The Clock allows viewing and manipulating the time
TopicReplayer	The TopicReplayer allows replaying files that contain recorded topics
MessageDisplayPlugin	The MessageDisplayPlugin allows visualizing ..
RemoteGui	The RemoteGui allows visualizing remotely defined widgets for configuration
WriteToDebugObserverGuiPlugin	The WriteToDebugObserverGuiPlugin allows visualizing ..
DebugPlotterWidget	The DebugPlotterWidget allows visualizing ..
►RobotAPI Gui Plugins
ArViz	The ArViz allows visualizing ..
ArVizDrawerGui	The ArVizDrawerGui allows visualizing ..
ArMemMemoryViewer	The ArMemMemoryViewer allows visualizing ..
HandUnitGuiPlugin	With this widget the HandUnit can be controlled
KinematicUnitPlugin	This widget shows position and velocity of all joints. Optionally a 3d robot model can be visualized
PlatformUnitPlugin	With this widget the PlatformUnit can be controlled
RobotViewerPlugin
RobotUnitPlugin	The RobotUnitPlugin allows visualizing ..
TCPMoverPlugin	The TCPMover widget allows direct control of a TCP
BoxToGraspCandidates	The BoxToGraspCandidates allows visualizing ..
DebugRobotUnitDataStreaming	The DebugRobotUnitDataStreaming allows visualizing ..
FTSensorCalibrationGui	The FTSensorCalibrationGui allows visualizing ..
GraspCandidateViewer	The GraspCandidateViewer allows visualizing ..
GuiHealthClient	The GuiHealthClient allows visualizing ..
HapticUnitPlugin	With this widget the HapticUnit can be controlled
HomogeneousMatrixCalculator	The HomogeneousMatrixCalculator allows visualizing ..
LaserScannerPlugin	The LaserScannerPlugin allows visualizing the raw sensor data captured from multiple laser scanners
ObjectPoseGui	The ObjectPoseGui allows visualizing ..
ViewSelection	The ViewSelection allows visualizing ..
DebugDrawerGuiPlugin	The DebugDrawerGuiPlugin allows visualizing ..
DebugDrawerViewer	The DebugDrawerViewer listens on the DebugDrawer topic and visualizes all incoming data
►MemoryX Gui Plugins
GraphVisualizer	A widget used to visualize an undirected graph and draw it to a debug layer
GridFS FileEditor	This widget allows viewing files that are referenced in the prior knowledge database
PriorMemoryEditor	This widget allows viewing and editing data entries in the prior memory
SceneEditor	This Plugin is an editor for the selected WorkingMemory which contains the current knowledge of the roboter about its environment
SnapshotGui	SnapshotControlWidgetController provides a graphical interface for loading, storing, and removing Memory Snapshots
WorkingMemoryEditor	This widget allows you to inspect the current state of the working memory
ObjectLocalizationRequester	The ObjectLocalizationRequester allows triggering and releasing of localization requests of specific objects
LoadObjectsIntoMemory	The LoadObjectsIntoMemory allows visualizing ..
►VisionX Gui plugins
ImageMonitor	..
PointCloudViewer	..
PrimitiveExtraction	The PrimitiveExtractionGui provides a convenient way for evaluating parameter setups for the segmentation of point clouds into geometric primitives
AffordancePipelineGui	The AffordancePipelineGui provides access to a running affordance extraction pipeline
PointCloudVisualization	The PointCloudVisualization allows visualizing point clouds provided by configured PointCloudProviders using a DebugDrawer topic
FeatureLearning	The FeatureLearning allows connecting to ArmarX ImageProviders and extract features from their images
HsvColorSegmentation	The HsvColorSegmentation allows image segmentation by HSV color and fast parameter selection
SemanticRelationViewer	The SemanticRelationViewer allows visualizing ..
UserAssistedSegmenterGui	The UserAssistedSegmenterGui allows manually grouping segments of an input oversegmentation to objects
ImageMaskPainter	The ImageMaskPainter allows visualizing ..
LookAtClick	The LookAtClick allows visualizing ..
►ArmarXSimulation Gui plugins
SimulatorControl Gui
ClutteredSceneGenerator	The ClutteredSceneGenerator allows visualizing ..
►RobotComponents Gui Plugins
"The RobotIK Gui Plugin"
Collision Space Visualizer
The plugin to show all tasks on a MotionPlanningServer	A gui plugin to see all tasks on a MotionPlanningServer and their status
LaserScannerSelfLocalisation	The LaserScannerSelfLocalisation allows visualizing and configuring the self localisation process
RobotTrajectoryDesigner	The RobotTrajectoryDesigner gui plugin allows the generation of trajectories for a given robot
HandEyeCalibration	The HandEyeCalibration allows visualizing ..
►armarx_control Gui Plugins
BimanualCartesianAdmittanceControllerGui	The BimanualCartesianAdmittanceControllerGui allows visualizing ..
CartesianImpedanceController	The CartesianImpedanceController allows visualizing ..
CartesianNaturalPositionController	The CartesianNaturalPositionController allows visualizing ..
CartesianWaypointControlGui	The CartesianWaypointControlGui allows visualizing ..
▼How To's
►ArmarXCore How To's
How to start the Ice service
How to start an ArmarX application
How to create a new package
How to add my own package to my Default Package List
How to write a new distributed object	See Write a Server and Client Communicating via RPC (C++)
How to write a new distributed application	See Write a Server and Client Communicating via RPC (C++)
How to offer and subscribe to a topic
How to get and use a proxy (Remote Procedure Calls)
How to create new condition checks
How to implement a new Ice class	See Write a Server and Client Communicating via RPC (C++)
How to create and implement a new Ice interface
How to Create Custom Variant Types
How to create a new statechart
How to run a remote function asynchronously
How to use properties
How to use ArmarX packages in your custom package
How to extend the statechart contexts	How to extend a statechart context is brief described in Set up the context
How to use smart/shared pointers
How to create your own Scenario
How to locate package data files
How to Implement a Custom Unit	Three components are required for implementing a custom unit in ArmarX:
How to Implement a Custom Observer	After having implemented the custom ExampleUnit, this section will explain how to implement the matching observer, ExampleUnitObserver
How to setup IceGrid on your robot
►ArmarXGui HowTos
How to create your own gui plugin
How to add your own interfaces to a statechart context
How to add your own data type to a statechart
Migrate to Statechart Editor codegenerator
RobotAPI HowTos
►MemoryX HowTos
How to create new Entities in MemoryX
Object serialization with MemoryX
How to create a new persistent memory segment in MemoryX
►VisionX HowTos
VisionX: Implementing ImageProviders
VisionX: Implementing ImageProcessors
VisionX: Implementing PointCloudProviders
VisionX: Implementing PointCloudProcessors
Implementing RGB ObjectLocalizerProcessors
Setting up the seperated Armar4 head
Calibrating the cameras of the Armar4 head
Calculating point clouds with stereo vision
VisionX-HowTos-Learning-new-Object-Models
Localizing textured objects with Armar4
Running the VisionX Pipeline
ArmarXSimulation HowTos
armarx_control HowTos
armarx_localization_and_mapping HowTos
armarx_navigation HowTos
armarx_view_selection HowTos
How to Interactively Edit the Object Memory
How to Record Multiple Image Streams Simultaneously
How To View Camera Recordings Created Using an ImageRecorder from ArmarX
How To Record memory data using the Long-Term Memory (LTM)
How to Connect to an Instance of ArmarX/Ice Running on Another Machine
How To Set up QtCreator for ArmarX
How to Create an ArmarX Package in a Git Repository
How To Use Paths in ArmarX
How To Add a Skill Library and Skill Provider
How to Find the Name of an ArmarX Package
How to Use CMake in ArmarX including Conventions and Tricks
How To Install and Activate CUDA / cuDNN
▼Package Overviews
►ArmarXCore Overview
Distributed Processing	Distributed Processing can easily be achieved in ArmarX with the ArmarXManager and ManagedIceObject
►ArmarX Observers
Variants	Variants provide a mechanism to store several types of data in one construct and send them via Ice
ArmarX Statecharts	Programming complex behavior or event-dependent processes in ArmarX is done with Statecharts
►Utility Features
ArmarX Logging
ArmarX Profiling
ArmarX Shared Memory	The ArmarX shared memory provides unidirectional shared memory communication
ArmarX Threads	ArmarX provides utility methods in order to include different types of threads
ArmarX VirtualTime
Properties
Execution of code when a scope is left
Component factories	ArmarX Components can be registered with a name to the ComponentFactory
Recording and Replaying Topics	It is possible to easily record and replay any topic available in ArmarX
ArmarXGui Overview
►RobotAPI Overview
Remote Robot State	The ArmarX Robot State is the global pose and joint configuration of a robot and is used for coordinate frame transformations
►MemoryX Overview
Getting Started with MemoryX
The CommonStorage component
The WorkingMemory component
The PriorKnowledge component
The LongtermMemory component
Object serialization with MemoryX
GridFS files and file reference attributes
Motion Models
VisionX Overview
ArmarXSimulation Overview
Robot Skill Templates Overview
►RobotComponents Overview
►RobotComponents Gui Plugins
"The RobotIK Gui Plugin"
Collision Space Visualizer
The plugin to show all tasks on a MotionPlanningServer	A gui plugin to see all tasks on a MotionPlanningServer and their status
LaserScannerSelfLocalisation	The LaserScannerSelfLocalisation allows visualizing and configuring the self localisation process
RobotTrajectoryDesigner	The RobotTrajectoryDesigner gui plugin allows the generation of trajectories for a given robot
HandEyeCalibration	The HandEyeCalibration allows visualizing ..
armarx_control Overview
armarx_localization_and_mapping Overview
armarx_navigation Overview
armarx_view_selection Overview
armarx_documentation: Slice Documentation
▼Tools
Deploying ArmarX Scenarios
ArmarX Developer CLI	ArmarX provides a python tool for ArmarX developer to conventiently build a package and all its depedencies
ArmarX and Python
▼Extended Documentation
Running Applications
►CMake legacy
CMake Setup
CMake Internals
Documentation
Component parameterization
Coding Conventions
Git Tutorials and Links
Unit Testing and Code Coverage
ArmarX Package Versioning
Internet Communication Engine (Ice) Basics
ArmarXCore FAQ
Quick Start
▼ArmarXGui Tutorials
Tutorial: Creating a new Gui Widget for ArmarX
MemoryX FAQ
armarx_control FAQ
armarx_control Tutorials
LocationGraphEditor	The LocationGraphEditor allows visualizing ..
armarx_view_selection HowTos
Writing Data to a Memory Server
ARON Specifications