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
|
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje
#pragma once
#include <plots/Plot.h>
#include <hist/HistFwd.h>
#include <data/DataFwd.h>
#include <utility/observer_ptr.h>
namespace ausaxs::plots {
/**
* @brief Plot the distance histogram for a protein.
*/
class PlotDistance : public Plot {
public:
~PlotDistance() override;
/**
* @brief Prepare a new distance plot.
*
* @param data The ScatteringHistogram which will be plotted.
* @param path The path to the folder where the plot will be saved.
*/
PlotDistance(observer_ptr<hist::DistanceHistogram> data, const io::File& path);
/**
* @brief Prepare a new distance plot.
*
* @param data The protein whose distances will be plotted.
* @param path The path to the folder where the plot will be saved.
*/
PlotDistance(observer_ptr<data::Molecule> protein, const io::File& path);
/**
* @brief Plot and save the input dataset at the specified location.
* This is a convenient shortcut for quickly creating a plot of a single dataset.
*/
static void quick_plot(observer_ptr<hist::DistanceHistogram> data, const io::File& path);
/**
* @brief Plot and save the input dataset at the specified location.
* This is a convenient shortcut for quickly creating a plot of a single dataset.
*/
static void quick_plot(observer_ptr<data::Molecule> protein, const io::File& path);
};
}
|