GraspTrajectory.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * Copyright (C) 2012-2016, High Performance Humanoid Technologies (H2T),
 * Karlsruhe Institute of Technology (KIT), all rights reserved.
 *
 * 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/>.
 *
 * @author     Simon Ottenhaus (simon dot ottenhaus at kit dot edu)
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <map>
#include <memory>
#include <optional>
 
#include <Eigen/Core>
 
#include <VirtualRobot/VirtualRobot.h>
 
#include <RobotAPI/interface/units/GraspCandidateProviderInterface.h>
#include <RobotAPI/libraries/diffik/SimpleDiffIK.h>
 
namespace armarx
{
    class RapidXmlReader;
    using RapidXmlReaderPtr = std::shared_ptr<RapidXmlReader>;
 
    class GraspTrajectory;
    typedef std::shared_ptr<GraspTrajectory> GraspTrajectoryPtr;
 
    class GraspTrajectoryKeypoint
    {
    public:
        using GraspTrajectoryKeypointPtr = std::shared_ptr<GraspTrajectoryKeypoint>;
 
        Eigen::Matrix4f tcpTarget;
        armarx::NameValueMap handJointsTarget;
        std::optional<std::string> shape;
        float dt;
        Eigen::Vector3f feedForwardPosVelocity;
        Eigen::Vector3f feedForwardOriVelocity;
        Eigen::VectorXf feedForwardHandJointsVelocity;
 
        GraspTrajectoryKeypoint() = default;
 
        GraspTrajectoryKeypoint(const Eigen::Matrix4f& tcpTarget,
                                const armarx::NameValueMap& handJointsTarget,
                                const std::optional<std::string>& shape = std::nullopt);
 
        GraspTrajectoryKeypoint(const Eigen::Matrix4f& tcpTarget,
                                const armarx::NameValueMap& handJointsTarget,
                                float dt,
                                const Eigen::Vector3f& feedForwardPosVelocity,
                                const Eigen::Vector3f& feedForwardOriVelocity,
                                const Eigen::VectorXf& feedForwardHandJointsVelocity,
                                const std::optional<std::string>& shape = std::nullopt);
 
        Eigen::Vector3f getTargetPosition() const;
        Eigen::Matrix3f getTargetOrientation() const;
        Eigen::Matrix4f getTargetPose() const;
        void updateVelocities(const GraspTrajectoryKeypointPtr& prev, float deltat);
    };
 
    class GraspTrajectory
    {
    public:
        using Keypoint = GraspTrajectoryKeypoint;
        using KeypointPtr = std::shared_ptr<Keypoint>;
 
        struct Length
        {
            float pos = 0;
            float ori = 0;
        };
 
 
    public:
        GraspTrajectory() = default;
        GraspTrajectory(const std::vector<Keypoint>& keypoints);
 
        GraspTrajectory(const Eigen::Matrix4f& tcpStart,
                        const armarx::NameValueMap& handJointsStart,
                        const std::optional<std::string>& shape = std::nullopt);
 
        void addKeypoint(const Eigen::Matrix4f& tcpTarget,
                         const armarx::NameValueMap& handJointsTarget,
                         float dt,
                         const std::optional<std::string>& shape = std::nullopt);
 
        size_t getKeypointCount() const;
        const std::vector<KeypointPtr>& getAllKeypoints() const;
 
        void insertKeypoint(size_t index,
                            const Eigen::Matrix4f& tcpTarget,
                            const armarx::NameValueMap& handJointsTarget,
                            float dt,
                            const std::optional<std::string>& shape = std::nullopt);
 
        void removeKeypoint(size_t index);
 
        void replaceKeypoint(size_t index,
                             const Eigen::Matrix4f& tcpTarget,
                             const armarx::NameValueMap& handJointsTarget,
                             float dt,
                             const std::optional<std::string>& shape = std::nullopt);
 
        void setKeypointDt(size_t index, float dt);
 
        const KeypointPtr& lastKeypoint() const;
        const KeypointPtr& getKeypoint(int i) const;
        Eigen::Matrix4f getStartPose() const;
 
        void getIndex(float t, int& i1, int& i2, float& f) const;
 
        Eigen::Vector3f GetPosition(float t) const;
 
        Eigen::Matrix3f GetOrientation(float t) const;
 
        Eigen::Matrix4f GetPose(float t) const;
 
        std::vector<Eigen::Matrix4f> getAllKeypointPoses() const;
        std::vector<Eigen::Vector3f> getAllKeypointPositions() const;
        std::vector<Eigen::Matrix3f> getAllKeypointOrientations() const;
 
        armarx::NameValueMap GetHandValues(float t) const;
        std::optional<std::string> GetShape(float t) const;
 
        Eigen::Vector3f GetPositionDerivative(float t) const;
 
        Eigen::Vector3f GetOrientationDerivative(float t) const;
 
        Eigen::Matrix<float, 6, 1> GetTcpDerivative(float t) const;
 
        Eigen::Vector3f GetHandJointsDerivative(float t) const;
 
        float getDuration() const;
 
        Length calculateLength() const;
 
 
        GraspTrajectoryPtr getTranslatedAndRotated(const Eigen::Vector3f& translation,
                                                   const Eigen::Matrix3f& rotation) const;
        GraspTrajectoryPtr getTransformed(const Eigen::Matrix4f& transform) const;
        GraspTrajectoryPtr getTransformedToOtherHand() const;
 
        GraspTrajectoryPtr getClone() const;
 
        GraspTrajectoryPtr getTransformedToGraspPose(
            const Eigen::Matrix4f& target,
            const Eigen::Vector3f& handForward = Eigen::Vector3f::UnitZ()) const;
 
        SimpleDiffIK::Reachability
        calculateReachability(VirtualRobot::RobotNodeSetPtr rns,
                              VirtualRobot::RobotNodePtr tcp = VirtualRobot::RobotNodePtr(),
                              SimpleDiffIK::Parameters params = SimpleDiffIK::Parameters());
 
 
        void writeToFile(const std::string& filename);
 
        static GraspTrajectoryPtr ReadFromReader(const RapidXmlReaderPtr& reader);
        static GraspTrajectoryPtr ReadFromFile(const std::string& filename);
        static GraspTrajectoryPtr ReadFromJSON(const std::string& filename);
        static GraspTrajectoryPtr ReadFromString(const std::string& xml);
 
        void setFrame(const std::string& frame);
        const std::optional<std::string>& getFrame() const;
 
    private:
        void updateKeypointMap();
 
    private:
        std::vector<KeypointPtr> keypoints;
        std::map<float, size_t> keypointMap;
 
        std::optional<std::string> frame_;
    };
} // namespace armarx