histogram.h

Go to the documentation of this file.

/* 
 * histogram.h : atom probe data histogramming header
 * Copyright (C) 2015  Daniel Haley
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ATOMPROBE_HISTOGRAM_H
#define ATOMPROBE_HISTOGRAM_H
#include <vector>

#include "atomprobe/primitives/ionHit.h"
#include "atomprobe/helper/aptAssert.h"

#include <gsl/gsl_histogram.h>
#include <limits>

namespace AtomProbe {

// be in the correct ordering, usually as-loaded from file, (ie hitMultiplicity must be set correctly).
bool correlationHistogram(const std::vector<EPOS_ENTRY> &eposIons,
        std::vector<std::vector<unsigned int> > &histogram,float stepMass,
        float endMass, bool lowerTriangular=false); 

// using an incomplete vector of EPOS entries. Note that EPOS entries
// that lead in with a zero deltapulse will be ignored.
bool accumulateCorrelationHistogram(const std::vector<EPOS_ENTRY> &eposIons,
        std::vector<std::vector<unsigned int> > &histogram, float stepMass,
        float endMass, bool lowerTriangular=true);

template<class T>
void linearHistogram(const std::vector<T> &data, T start,
            T end, T step, std::vector<T> &histVals)
{
    ASSERT(start < end);
    ASSERT(step > std::numeric_limits<T>::epsilon());

    gsl_histogram *h = gsl_histogram_alloc((end-start)/step);
    gsl_histogram_set_ranges_uniform(h,start,end);

    for(size_t ui=0; ui<data.size();ui++)
        gsl_histogram_increment(h,data[ui]);

    //Copy out data
    histVals.resize(h->n);
#pragma omp parallel for
    for(size_t ui=0;ui<h->n; ui++)
        histVals[ui]=h->bin[ui];

    gsl_histogram_free(h);
}

}

#endif