sustaining_gazes/lib/local/Utilities/include/Visualizer.h

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2017, Tadas Baltrusaitis all rights reserved.
//
// ACADEMIC OR NON-PROFIT ORGANIZATION NONCOMMERCIAL RESEARCH USE ONLY
//
// BY USING OR DOWNLOADING THE SOFTWARE, YOU ARE AGREEING TO THE TERMS OF THIS LICENSE AGREEMENT.  
// IF YOU DO NOT AGREE WITH THESE TERMS, YOU MAY NOT USE OR DOWNLOAD THE SOFTWARE.
//
// License can be found in OpenFace-license.txt
//
//     * Any publications arising from the use of this software, including but
//       not limited to academic journal and conference publications, technical
//       reports and manuals, must cite at least one of the following works:
//
//       OpenFace: an open source facial behavior analysis toolkit
//       Tadas Baltru<72>aitis, Peter Robinson, and Louis-Philippe Morency
//       in IEEE Winter Conference on Applications of Computer Vision, 2016  
//
//       Rendering of Eyes for Eye-Shape Registration and Gaze Estimation
//       Erroll Wood, Tadas Baltru<72>aitis, Xucong Zhang, Yusuke Sugano, Peter Robinson, and Andreas Bulling 
//       in IEEE International. Conference on Computer Vision (ICCV),  2015 
//
//       Cross-dataset learning and person-speci?c normalisation for automatic Action Unit detection
//       Tadas Baltru<72>aitis, Marwa Mahmoud, and Peter Robinson 
//       in Facial Expression Recognition and Analysis Challenge, 
//       IEEE International Conference on Automatic Face and Gesture Recognition, 2015 
//
//       Constrained Local Neural Fields for robust facial landmark detection in the wild.
//       Tadas Baltru<72>aitis, Peter Robinson, and Louis-Philippe Morency. 
//       in IEEE Int. Conference on Computer Vision Workshops, 300 Faces in-the-Wild Challenge, 2013.    
//
///////////////////////////////////////////////////////////////////////////////

#ifndef __VISUALIZER_h_
#define __VISUALIZER_h_

// System includes
#include <vector>

// OpenCV includes
#include <opencv2/core/core.hpp>
#include <opencv2/highgui/highgui.hpp>

namespace Utilities
{

	//===========================================================================
	/**
	A class for recording data processed by OpenFace (facial landmarks, head pose, facial action units, aligned face, HOG features, and tracked video
	*/
	class Visualizer {

	public:

		// The constructor for the visualizer that specifies what to visualize
		Visualizer(std::vector<std::string> arguments);
		Visualizer(bool vis_track, bool vis_hog, bool vis_align);

		//~Visualizer();

		// TODO copy, assignment and move operators? Do not allow

		// Adding observations to the visualizer
		
		// Pose related observations
		void SetImage(const cv::Mat& canvas, float fx, float fy, float cx, float cy);

		// All observations relevant to facial landmarks (optional visibilities parameter to not display all landmarks)
		void SetObservationLandmarks(const cv::Mat_<double>& landmarks_2D, double confidence, bool success, const cv::Mat_<int>& visibilities = cv::Mat_<int>());

		// Pose related observations
		void SetObservationPose(const cv::Vec6d& pose, double confidence);
		
		// Gaze related observations
		void SetObservationGaze(const cv::Point3f& gazeDirection0, const cv::Point3f& gazeDirection1, const std::vector<cv::Point2d>& eye_landmarks, const std::vector<cv::Point3d>& eye_landmarks3d, double confidence);

		// Face alignment related observations
		void SetObservationFaceAlign(const cv::Mat& aligned_face);

		// HOG feature related observations
		void SetObservationHOG(const cv::Mat_<double>& hog_descriptor, int num_cols, int num_rows);

		void SetFps(double fps);

		// Return key-press that could have resulted in the open windows
		char ShowObservation();

		cv::Mat GetVisImage();

		// Keeping track of what we're visualizing
		bool vis_track;
		bool vis_hog;
		bool vis_align;
		
		// Can be adjusted to show less confident frames
		double visualisation_boundary = 0.4;

	private:

		// Temporary variables for visualization
		cv::Mat captured_image; // out canvas
		cv::Mat tracked_image;
		cv::Mat hog_image;
		cv::Mat aligned_face_image;

		// Useful for drawing 3d
		float fx, fy, cx, cy;

	};
}
#endif