Skip to content
Snippets Groups Projects
ViewSelection.cpp 18.3 KiB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    Armar3::ViewSelection
 * @author     David Schiebener (schiebener at kit dot edu)
 * @date       2015
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */

#include "ViewSelection.h"

#include <ArmarXCore/core/system/ArmarXDataPath.h>
#include <RobotAPI/libraries/core/remoterobot/RemoteRobot.h>
#include <MemoryX/core/MemoryXCoreObjectFactories.h>
#include <MemoryX/libraries/memorytypes/MemoryXTypesObjectFactories.h>

#include <VirtualRobot/Robot.h>
#include <VirtualRobot/Nodes/RobotNode.h>
#include <MemoryX/libraries/helpers/IVTRecognitionHelpers/IVTRecognitionObjectWrapper.h>


using namespace armarx;
using namespace Eigen;


void ViewSelection::onInitComponent()
{
    usingProxy(getProperty<std::string>("RobotStateComponentName").getValue());
    usingProxy(getProperty<std::string>("HeadIKUnitName").getValue());
    usingProxy(getProperty<std::string>("WorkingMemoryName").getValue());
    usingProxy(getProperty<std::string>("PriorKnowledgeName").getValue());
    offeringTopic("DebugDrawerUpdates");
    headIKKinematicChainName = getProperty<std::string>("HeadIKKinematicChainName").getValue();
    headFrameName = getProperty<std::string>("HeadFrameName").getValue();
    cameraFrameName = getProperty<std::string>("CameraFrameName").getValue();
    drawViewDirection = getProperty<bool>("VisualizeViewDirection").getValue();

    randomNoiseLevel = getProperty<float>("RandomNoiseLevel").getValue();

    std::string graphFileName;
    if (ArmarXDataPath::getAbsolutePath("Armar3/graph40k.gra", graphFileName))
    {
        saliencyEgosphereGraph = new CIntensityGraph(graphFileName);
        ARMARX_VERBOSE << "Created egosphere graph with " << saliencyEgosphereGraph->getNodes()->size() << "nodes";
        graphLookupTable = new CGraphPyramidLookupTable(9, 18);
        graphLookupTable->buildLookupTable(saliencyEgosphereGraph);
        nodeVisitedForObject.resize(saliencyEgosphereGraph->getNodes()->size());

        // create visibility mask
        visibilityMaskGraph = new CIntensityGraph(*saliencyEgosphereGraph);
        TNodeList* nodes = visibilityMaskGraph->getNodes();
        const float maxOverallHeadTiltAngle = getProperty<float>("MaxOverallHeadTiltAngle").getValue();
        const float borderAreaAngle = 10.0f;
        const float centralAngle = getProperty<float>("CentralHeadTiltAngle").getValue();
        for (size_t i=0; i<nodes->size(); i++)
        {
            CIntensityNode* node = (CIntensityNode*) nodes->at(i);
            if (fabs(node->getPosition().fPhi-centralAngle) < maxOverallHeadTiltAngle-borderAreaAngle)
            {
                node->setIntensity(1.0f);
            }
            else if (fabs(node->getPosition().fPhi-centralAngle) < maxOverallHeadTiltAngle)
            {
                node->setIntensity(1.0f - (fabs(node->getPosition().fPhi-centralAngle) - (maxOverallHeadTiltAngle-borderAreaAngle))/borderAreaAngle);
            }
            else
            {
                node->setIntensity(0.0f);
            }
        }

        randomNoiseGraph = new CIntensityGraph(*saliencyEgosphereGraph);
        randomNoiseGraph->set(0);
    }
    else
    {
        ARMARX_ERROR << "Could not find required graph file";
    }

    halfCameraOpeningAngle = getProperty<float>("HalfCameraOpeningAngle").getValue();
    sleepingTimeBetweenViewDirectionChanges = getProperty<int>("SleepingTimeBetweenViewDirectionChanges").getValue();
    doAutomaticViewSelection = getProperty<bool>("ActiveAtStartup").getValue();
    deviationFromCameraCenterFactor = 0.5f;
    timeOfLastViewChange = IceUtil::Time::now();

    // this is robot model specific: offset from the used head coordinate system to the actual
    // head center where the eyes are assumed to be located. Here it is correct for ARMAR-III
    offsetToHeadCenter << 0, 0, 150;
}


void ViewSelection::onConnectComponent()
{
    robotStateComponent = getProxy<RobotStateComponentInterfacePrx>(getProperty<std::string>("RobotStateComponentName").getValue());
    memoryProxy = getProxy<memoryx::WorkingMemoryInterfacePrx>(getProperty<std::string>("WorkingMemoryName").getValue());
    priorKnowledge = getProxy<memoryx::PriorKnowledgeInterfacePrx>(getProperty<std::string>("PriorKnowledgeName").getValue());
    objectInstancesProxy = memoryx::ObjectInstanceMemorySegmentBasePrx::uncheckedCast(memoryProxy->getSegment("objectInstances"));
    objectClassesProxy = memoryx::ObjectClassMemorySegmentBasePrx::uncheckedCast(memoryProxy->getSegment("objectClasses"));
    headIKUnitProxy = getProxy<HeadIKUnitInterfacePrx>(getProperty<std::string>("HeadIKUnitName").getValue());
    drawer = getTopic<DebugDrawerInterfacePrx>("DebugDrawerUpdates");
    headIKUnitProxy->request();

    auto objClassSegment = priorKnowledge->getObjectClassesSegment();
    auto ids = objClassSegment->getAllEntityIds();
    for (auto& id: ids)
    {
        memoryx::ObjectClassPtr objClass = memoryx::ObjectClassPtr::dynamicCast(objClassSegment->getEntityById(id));
        if (objClass)
        {
             memoryx::EntityWrappers::ObjectRecognitionWrapperPtr wrapper = objClass->addWrapper(new memoryx::EntityWrappers::ObjectRecognitionWrapper());
             if (!wrapper->getRecognitionMethod().empty() && wrapper->getRecognitionMethod() != "<none>")
             {
                 recognizableObjClasses[objClass->getName()] = objClass;
                 ARMARX_INFO << objClass->getName() << " has " << wrapper->getRecognitionMethod();
             }
        }
    }
    processorTask = new PeriodicTask<ViewSelection>(this, &ViewSelection::process, 30);
    processorTask->setDelayWarningTolerance(sleepingTimeBetweenViewDirectionChanges+100);
    processorTask->start();
}


void ViewSelection::onDisconnectComponent()
{
    try
    {
        if (drawer)
            drawer->removeArrowDebugLayerVisu("HeadRealViewDirection");
        processorTask->stop();
        headIKUnitProxy->release();
    }
    catch (...)
    {
        ARMARX_WARNING_S << "An exception occured during onDisconnectComponent()";
        handleExceptions();
    }
}


void ViewSelection::onExitComponent()
{
    delete visibilityMaskGraph;
    delete graphLookupTable;
    delete saliencyEgosphereGraph;
    delete randomNoiseGraph;
}


void ViewSelection::process()
{
    try
    {
        float maxObjectDistance = getProperty<float>("MaxObjectDistance").getValue();
        auto syncRobot = robotStateComponent->getSynchronizedRobot();

        if (manualViewTargets.size() > 0)
        {
            // look to the manually set target
            FramedPositionPtr target;
            {
                ScopedLock lock(manualViewTargetsMutex);

                target = new FramedPosition(FramedPositionPtr::dynamicCast(manualViewTargets.at(0))->toEigen(), manualViewTargets.at(0)->frame, syncRobot->getName());
                for (size_t i=0; i<manualViewTargets.size()-1; i++)
                {
                    manualViewTargets.at(i) = manualViewTargets.at(i+1);
                }
                manualViewTargets.pop_back();
            }
            ARMARX_INFO << "Looking to manual head target " << *target;
            headIKUnitProxy->setHeadTarget(headIKKinematicChainName, target);

            boost::this_thread::sleep(boost::posix_time::milliseconds(sleepingTimeBetweenViewDirectionChanges));
        }
        else if (doAutomaticViewSelection)
        {
            // reset saliency and visited nodes
            saliencyEgosphereGraph->set(0);
            for (size_t i=0; i< saliencyEgosphereGraph->getNodes()->size(); i++)
            {
                nodeVisitedForObject.at(i) = -1;
            }

            // generate new random noise
            if (randomNoiseLevel > 0)
            {
                setRandomNoise();
            }
            auto robotPrx = robotStateComponent->getSynchronizedRobot();
            // collect localizable objects
            std::vector<memoryx::ObjectInstancePtr> localizableObjects;
            std::vector<FramedPositionPtr> localizableObjectPositions;
            int numberOfLostObjects = 0;
            memoryx::EntityIdList objectIds = objectInstancesProxy->getAllEntityIds();
            for (size_t i=0; i<objectIds.size(); i++)
            {
                const std::string objectId = objectIds.at(i);
                const memoryx::EntityBasePtr entityBase = objectInstancesProxy->getEntityById(objectId);
                const memoryx::ObjectInstancePtr object = memoryx::ObjectInstancePtr::dynamicCast(entityBase);
                if (object)
                {
                    if (recognizableObjClasses.count(object->getName()) > 0 && !object->getPosition()->getFrame().empty())
                    {
                        if (objectClassesProxy->hasEntityByName(object->getName())) // should be true if and only if object has been requested
                        {
                            FramedPositionPtr position = object->getPosition();
                            position->changeFrame(robotPrx, headFrameName);
                            float objDist = position->toEigen().norm();
                            if (objDist <= maxObjectDistance)
                            {
                                localizableObjects.push_back(object);
                                localizableObjectPositions.push_back(position);
                                if (object->getExistenceCertainty() < 0.5)
                                {
                                    numberOfLostObjects++;
                                }
                            }
                            else
                            {
                                ARMARX_DEBUG << "Discarding " << object->getName() << " which is at " << position->output() <<  " ObjectDistance " << objDist;
                            }
                        }
                    }
                }
            }

            const float probabilityToAddALostObject = (numberOfLostObjects > 0) ? getProperty<float>("ProbabilityToLookForALostObject").getValue()/numberOfLostObjects : 0;


            // add localization necessities to sphere of possible view directions
            for (size_t i=0; i<localizableObjects.size(); i++)
            {
                const memoryx::ObjectInstancePtr object = localizableObjects.at(i);
                if ((object->getExistenceCertainty() >= 0.5) || (rand() % 100000 < 100000*probabilityToAddALostObject))
                {
                    const FramedPositionPtr position = localizableObjectPositions.at(i);

                    memoryx::MultivariateNormalDistributionPtr uncertaintyGaussian = memoryx::MultivariateNormalDistributionPtr::dynamicCast(object->getPositionUncertainty());
                    if (!uncertaintyGaussian)
                    {
                        uncertaintyGaussian = memoryx::MultivariateNormalDistribution::CreateDefaultDistribution(1000000);
                    }

                    float saliency = log(1.0 + uncertaintyGaussian->getVarianceScalar());

                    if (saliency > 0)
                    {
                        TSphereCoord positionInSphereCoordinates;
                        MathTools::convert(position->toEigen() - offsetToHeadCenter, positionInSphereCoordinates);
                        int closestNodeIndex = graphLookupTable->getClosestNode(positionInSphereCoordinates);
                        addSaliencyRecursive(closestNodeIndex, saliency, positionInSphereCoordinates, i);
                    }
                }
            }


            // find the direction with highest saliency
            TNodeList* visibilityMaskGraphNodes = visibilityMaskGraph->getNodes();
            TNodeList* saliencyEgosphereGraphNodes = saliencyEgosphereGraph->getNodes();
            TNodeList* randomNoiseGraphNodes = randomNoiseGraph->getNodes();
            int maxIndex = -1;
            float maxSaliency = 0;

            for (size_t i=0; i<saliencyEgosphereGraphNodes->size(); i++)
            {
                CIntensityNode* visibilityNode = (CIntensityNode*) visibilityMaskGraphNodes->at(i);
                CIntensityNode* saliencyNode = (CIntensityNode*) saliencyEgosphereGraphNodes->at(i);
                CIntensityNode* randomNoiseNode = (CIntensityNode*) randomNoiseGraphNodes->at(i);
                float saliency = visibilityNode->getIntensity() * (saliencyNode->getIntensity() + randomNoiseNode->getIntensity());
                if (saliency > maxSaliency)
                {
                    maxSaliency = saliency;
                    maxIndex = i;
                }
            }

            ARMARX_DEBUG << "Highest saliency: " << maxSaliency;

            // select a new view if saliency is bigger than threshold, which converges towards 0 over time
            int timeSinceLastViewChange = (IceUtil::Time::now() - timeOfLastViewChange).toMilliSeconds();
            float saliencyThreshold = 0;
            if (timeSinceLastViewChange > 0)
            {
                saliencyThreshold = 2.0f * sleepingTimeBetweenViewDirectionChanges / timeSinceLastViewChange;
            }

            if (maxSaliency > saliencyThreshold)
            {
                Eigen::Vector3f target;
                MathTools::convert(saliencyEgosphereGraphNodes->at(maxIndex)->getPosition(), target);
                const float distanceFactor = 1500;
                target = distanceFactor*target + offsetToHeadCenter;
                FramedPositionPtr viewTargetPositionPtr = new FramedPosition(target, headFrameName, robotPrx->getName());
                if(drawer && robotPrx->hasRobotNode("Cameras") && drawViewDirection)
                {
                    Vector3Ptr startPos = new Vector3(FramedPosePtr::dynamicCast(robotPrx->getRobotNode("Cameras")->getGlobalPose())->toEigen());
                    FramedDirectionPtr direction = new FramedDirection(Eigen::Vector3f(1, 0, 0),"Cameras", robotPrx->getName());
                    drawer->setArrowDebugLayerVisu("HeadRealViewDirection", startPos, direction->toGlobal(robotPrx), DrawColor{0,1,0,0.2}, maxObjectDistance, 5);
                }
                headIKUnitProxy->setHeadTarget(headIKKinematicChainName, viewTargetPositionPtr);

                timeOfLastViewChange = IceUtil::Time::now();
                boost::this_thread::sleep(boost::posix_time::milliseconds(sleepingTimeBetweenViewDirectionChanges));
            }
        }
    }
    catch (...)
    {
        ARMARX_WARNING_S << "An exception occured during process()";
        handleExceptions();
    }
}



void ViewSelection::addSaliencyRecursive(int currentNodeIndex, float saliency, TSphereCoord objectSphereCoord, int objectIndex)
{
    // distance on arc between object projection center and node,
    // normalized by the maximal viewing angle of the camera (=> in [0,1])
    float normalizedDistance = MathTools::getDistanceOnArc(objectSphereCoord, saliencyEgosphereGraph->getNodes()->at(currentNodeIndex)->getPosition()) / halfCameraOpeningAngle;

    // increase value of node
    float newValue = ((CIntensityNode*)saliencyEgosphereGraph->getNodes()->at(currentNodeIndex))->getIntensity()
                    + (1.0f - deviationFromCameraCenterFactor*normalizedDistance*normalizedDistance) * saliency;
    ((CIntensityNode*)saliencyEgosphereGraph->getNodes()->at(currentNodeIndex))->setIntensity( newValue );

    // mark node as visited for this object
    nodeVisitedForObject.at(currentNodeIndex) = objectIndex;

    // recurse on neighbours if they were not yet visited and close enough to the object projection center
    int neighbourIndex;
    for (int i=0; i<(int)saliencyEgosphereGraph->getNodeAdjacency(currentNodeIndex)->size(); i++)
    {
        neighbourIndex = saliencyEgosphereGraph->getNodeAdjacency(currentNodeIndex)->at(i);
        if (nodeVisitedForObject.at(neighbourIndex) != objectIndex)
        {
            if (MathTools::getDistanceOnArc(objectSphereCoord, saliencyEgosphereGraph->getNodes()->at(neighbourIndex)->getPosition()) <= halfCameraOpeningAngle)
            {
                addSaliencyRecursive(neighbourIndex, saliency, objectSphereCoord, objectIndex);
            }
            else
            {
                nodeVisitedForObject.at(neighbourIndex) = objectIndex;
            }
        }
    }
}



void ViewSelection::setRandomNoise()
{
    if (!robotStateComponent)
    {
        return;
    }

    Eigen::Vector3f currentViewTargetEigen(1000, 0, 0); // virtual central gaze goes into x direction
    FramedPosition currentViewTarget(currentViewTargetEigen, cameraFrameName, robotStateComponent->getSynchronizedRobot()->getName());
    currentViewTarget.changeFrame(robotStateComponent->getSynchronizedRobot(), headFrameName);
    currentViewTargetEigen = currentViewTarget.toEigen() - offsetToHeadCenter;
    TSphereCoord currentViewDirection;
    MathTools::convert(currentViewTargetEigen, currentViewDirection);    

    const float centralAngle = getProperty<float>("CentralHeadTiltAngle").getValue();

    TNodeList* nodes = randomNoiseGraph->getNodes();
    const int randomFactor = 100000;
    const float noiseFactor = randomNoiseLevel/randomFactor;
    for (size_t i=0; i<nodes->size(); i++)
    {
        CIntensityNode* node = (CIntensityNode*) nodes->at(i);
        TSphereCoord nodeCoord = node->getPosition();
        float distanceOnSphere = MathTools::getDistanceOnArc(currentViewDirection, nodeCoord);
        float distanceFactor = 1.0f - 0.5f*distanceOnSphere/M_PI; // prefer directions close to current direction
        float heightFactor = 1.0f - 0.2f*fabs(nodeCoord.fPhi-centralAngle)/90.0f; // prefer directions that look down 20°
        node->setIntensity(heightFactor*distanceFactor*noiseFactor*(rand()%randomFactor));
    }
}



void ViewSelection::addManualViewTarget(const FramedPositionBasePtr& target, const Ice::Current &c)
{
    ScopedLock lock(manualViewTargetsMutex);

    manualViewTargets.push_back(target);
}


PropertyDefinitionsPtr ViewSelection::createPropertyDefinitions()
{
    return PropertyDefinitionsPtr(new ViewSelectionPropertyDefinitions(getConfigIdentifier()));
}