HistoUtils Namespace Reference

Collection of utils for 1D and 2D image processing (background, peaks, ets). More...

Functions
bool	agreesWithReference (const SimulationResult &dat, const std::string &refFileName, double tol)
	Returns true if SimulatioResult agrees with data from reference file. More...
std::vector< std::pair< double, double > >	FindPeaks (const Histogram2D &hist, double sigma=2, const std::string &option={}, double threshold=0.05)
	Returns vector of peak center coordinates, for peaks in given histogram. More...
double	getRelativeDifference (const IHistogram &dat, const IHistogram &ref)
double	RelativeDifference (const SimulationResult &dat, const SimulationResult &ref)
	Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(a + b) ( and zero if a-b=0 ) More...

Detailed Description

Collection of utils for 1D and 2D image processing (background, peaks, ets).

Function Documentation

agreesWithReference()

bool HistoUtils::agreesWithReference	(	const SimulationResult &	dat,
		const std::string &	refFileName,
		double	tol
	)

Returns true if SimulatioResult agrees with data from reference file.

Definition at line 80 of file HistoUtils.cpp.

{
    std::unique_ptr<OutputData<double>> refDat{IntensityDataIOFactory::readOutputData(refFileName)};
    if (!refDat) {
        std::cerr << "Could not read reference data from file " << refFileName << std::endl;
        return false;
    }
    std::unique_ptr<OutputData<double>> datDat(dat.data());
    return DataUtils::checkRelativeDifference(*datDat, *refDat, tol);
}

References DataUtils::checkRelativeDifference(), SimulationResult::data(), and IntensityDataIOFactory::readOutputData().

Here is the call graph for this function:

FindPeaks()

std::vector< std::pair< double, double > > HistoUtils::FindPeaks	(	const Histogram2D &	hist,
		double	sigma = 2,
		const std::string &	option = {},
		double	threshold = 0.05
	)

Returns vector of peak center coordinates, for peaks in given histogram.

Definition at line 25 of file HistoUtils.cpp.

{
    std::unique_ptr<OutputData<double>> data(hist.createOutputData());
    std::vector<std::vector<double>> arr = ArrayUtils::createVector2D(*data);
    tspectrum::Spectrum2D spec;
    auto peaks = spec.find_peaks(arr, sigma, option, threshold);
 
    // coordinates of peaks in histogram axes units
    std::vector<std::pair<double, double>> result;
 
    for (const auto& p : peaks) {
        double row_value = p.first;
        double col_value = p.second;
 
        size_t xaxis_index = static_cast<size_t>(col_value);
        size_t yaxis_index = hist.yAxis().size() - 1 - static_cast<size_t>(row_value);
 
        Bin1D xbin = hist.xAxis().bin(xaxis_index);
        Bin1D ybin = hist.yAxis().bin(yaxis_index);
 
        double dx = col_value - static_cast<size_t>(col_value);
        double dy = -1.0 * (row_value - static_cast<size_t>(row_value));
 
        double x = xbin.center() + xbin.binSize() * dx;
        double y = ybin.center() + ybin.binSize() * dy;
 
        result.push_back(std::make_pair(x, y));
    }
    return result;
}

References IAxis::bin(), Bin1D::binSize(), Bin1D::center(), IHistogram::createOutputData(), ArrayUtils::createVector2D(), IAxis::size(), IHistogram::xAxis(), and IHistogram::yAxis().

Here is the call graph for this function:

getRelativeDifference()

double HistoUtils::getRelativeDifference	(	const IHistogram &	dat,
		const IHistogram &	ref
	)

Definition at line 73 of file HistoUtils.cpp.

{
    return DataUtils::relativeDataDifference(
        *std::unique_ptr<OutputData<double>>(dat.getData().meanValues()),
        *std::unique_ptr<OutputData<double>>(ref.getData().meanValues()));
}

References IHistogram::getData(), OutputData< T >::meanValues(), and DataUtils::relativeDataDifference().

Here is the call graph for this function:

RelativeDifference()

double HistoUtils::RelativeDifference	(	const SimulationResult &	dat,
		const SimulationResult &	ref
	)

Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(a + b) ( and zero if a-b=0 )

Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(|a| + |b|) ( and zero if a=b=0 within epsilon )

Definition at line 60 of file HistoUtils.cpp.

{
    if (dat.size() != ref.size())
        throw std::runtime_error("Error in HistoUtils::RelativeDifference: "
                                 "different number of elements");
    if (dat.empty())
        return 0.0;
    double sum_of_diff = 0.0;
    for (size_t i = 0; i < dat.size(); ++i)
        sum_of_diff += Numeric::GetRelativeDifference(dat[i], ref[i]);
    return sum_of_diff / dat.size();
}

References SimulationResult::empty(), Numeric::GetRelativeDifference(), and SimulationResult::size().

Here is the call graph for this function: