File: PlotHistogram.h

package info (click to toggle)
ausaxs 1.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 72,592 kB
  • sloc: cpp: 49,853; ansic: 6,901; python: 730; makefile: 18
file content (30 lines) | stat: -rw-r--r-- 811 bytes parent folder | download
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
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje

#pragma once

#include <plots/Plot.h>
#include <utility/observer_ptr.h>
#include <hist/HistFwd.h>

namespace ausaxs::plots {
	/**
	 * @brief Plot a specific \class Histogram object.
	 */
	class PlotHistogram : public Plot {
		public:
			PlotHistogram();

			virtual ~PlotHistogram();

			PlotHistogram(const hist::Histogram& h, const plots::PlotOptions& options);

			PlotHistogram& plot(const hist::Histogram& hist, const plots::PlotOptions& options);

			/**
			 * @brief Plot and save the input dataset and the specified location. 
			 * 	      This is a convenient shortcut for quickly creating a histogram. 
			 */
			static void quick_plot(const hist::Histogram& hist, const plots::PlotOptions& options, const io::File& path);
	};
}