CameraImages.h

Go to the documentation of this file.

/*
Copyright (c) 2010-2016, Mathieu Labbe - IntRoLab - Universite de Sherbrooke
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Universite de Sherbrooke nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once

#include "rtabmap/core/RtabmapExp.h" // DLL export/import defines

#include "rtabmap/core/Camera.h"
#include "rtabmap/utilite/UTimer.h"
#include <list>

class UDirectory;

namespace rtabmap
{

class RTABMAP_EXP CameraImages :
        public Camera
{
public:
        CameraImages();
        CameraImages(
                        const std::string & path,
                        float imageRate = 0,
                        const Transform & localTransform = CameraModel::opticalRotation());
        virtual ~CameraImages();

        virtual bool init(const std::string & calibrationFolder = ".", const std::string & cameraName = "");
        virtual bool isCalibrated() const;
        virtual std::string getSerial() const;
        virtual bool odomProvided() const { return odometry_.size() > 0; }
        std::string getPath() const {return _path;}
        unsigned int imagesCount() const;
        std::vector<std::string> filenames() const;
        bool isImagesRectified() const {return _rectifyImages;}
        int getBayerMode() const {return _bayerMode;}
        const CameraModel & cameraModel() const {return _model;}

        void setPath(const std::string & dir) {_path=dir;}
        virtual void setStartIndex(int index) {_startAt = index;} // negative means last
        virtual void setMaxFrames(int value) {_maxFrames = value;}
        void setDirRefreshed(bool enabled) {_refreshDir = enabled;}
        void setImagesRectified(bool enabled) {_rectifyImages = enabled;}
        void setBayerMode(int mode) {_bayerMode = mode;} // -1=disabled (default) 0=BayerBG, 1=BayerGB, 2=BayerRG, 3=BayerGR

        void setTimestamps(bool fileNamesAreStamps, const std::string & filePath = "", bool syncImageRateWithStamps=true)
        {
                _filenamesAreTimestamps = fileNamesAreStamps;
                _timestampsPath=filePath;
                _syncImageRateWithStamps = syncImageRateWithStamps;
        }

        void setConfigForEachFrame(bool value)
        {
                _hasConfigForEachFrame = value;
        }

        void setScanPath(
                        const std::string & dir,
                        int maxScanPts = 0,
                        const Transform & localTransform=Transform::getIdentity())
        {
                _scanPath = dir;
                _scanLocalTransform = localTransform;
                _scanMaxPts = maxScanPts;
        }

        void setDepthFromScan(bool enabled, int fillHoles = 1, bool fillHolesFromBorder = false)
        {
                _depthFromScan = enabled;
                _depthFromScanFillHoles = fillHoles;
                _depthFromScanFillHolesFromBorder = fillHolesFromBorder;
        }

        // Format: 0=Raw, 1=RGBD-SLAM, 2=KITTI, 3=TORO, 4=g2o, 5=NewCollege(t,x,y), 6=Malaga Urban GPS, 7=St Lucia INS, 8=Karlsruhe
        void setOdometryPath(const std::string & filePath, int format = 0)
        {
                _odometryPath = filePath;
                _odometryFormat = format;
        }

        // Format: 0=Raw, 1=RGBD-SLAM, 2=KITTI, 3=TORO, 4=g2o, 5=NewCollege(t,x,y), 6=Malaga Urban GPS, 7=St Lucia INS, 8=Karlsruhe
        void setGroundTruthPath(const std::string & filePath, int format = 0)
        {
                _groundTruthPath = filePath;
                _groundTruthFormat = format;
        }

        void setMaxPoseTimeDiff(double diff) {_maxPoseTimeDiff = diff;}
        double getMaxPoseTimeDiff() const {return _maxPoseTimeDiff;}

        void setDepth(bool isDepth, float depthScaleFactor = 1.0f)
        {
                _isDepth = isDepth;
                _depthScaleFactor=depthScaleFactor;
        }

protected:
        virtual SensorData captureImage(CameraInfo * info = 0);

private:
        bool readPoses(
                std::list<Transform> & outputPoses,
                std::list<double> & stamps,
                const std::string & filePath,
                int format,
                double maxTimeDiff) const;

private:
        std::string _path;
        int _startAt;
        int _maxFrames;
        // If the list of files in the directory is refreshed
        // on each call of takeImage()
        bool _refreshDir;
        bool _rectifyImages;
        int _bayerMode;
        bool _isDepth;
        float _depthScaleFactor;
        int _count;
        int _framesPublished;
        UDirectory * _dir;
        std::string _lastFileName;

        int _countScan;
        UDirectory * _scanDir;
        std::string _lastScanFileName;
        std::string _scanPath;
        Transform _scanLocalTransform;
        int _scanMaxPts;

        bool _depthFromScan;
        int _depthFromScanFillHoles; // <0:horizontal 0:disabled >0:vertical
        bool _depthFromScanFillHolesFromBorder;

        bool _filenamesAreTimestamps;
        bool _hasConfigForEachFrame;
        std::string _timestampsPath;
        bool _syncImageRateWithStamps;

        std::string _odometryPath;
        int _odometryFormat;
        std::string _groundTruthPath;
        int _groundTruthFormat;
        double _maxPoseTimeDiff;

        std::list<double> _stamps;
        std::list<Transform> odometry_;
        std::list<cv::Mat> covariances_;
        std::list<Transform> groundTruth_;
        CameraModel _model;
        std::list<CameraModel> _models;

        UTimer _captureTimer;
        double _captureDelay;
};


} // namespace rtabmap