#ifndef STIM_BSQ_H
#define STIM_BSQ_H
#include "../envi/envi_header.h"
#include "../envi/hsi.h"
#include "../envi/bil.h"
#include
#include
#include
#include
#include
namespace stim{
/**
The BIP class represents a 3-dimensional binary file stored using band sequential (BSQ) image encoding. The binary file is stored
such that X-Y "frames" are stored sequentially to form an image stack along the z-axis. When accessing the data sequentially on disk,
the dimensions read, from fastest to slowest, are X, Y, Z.
This class is optimized for data streaming, and therefore supports extremely large (terabyte-scale) files. Data is loaded from disk
on request. Functions used to access data are written to support efficient reading.
*/
template
class bsq: public hsi {
protected:
//std::vector w; //band wavelengths
unsigned long long offset;
using binary::R;
using hsi::w; //use the wavelength array in stim::hsi
using hsi::nnz;
using binary::progress;
using hsi::X;
using hsi::Y;
using hsi::Z;
public:
using binary::open;
using binary::file;
using binary::read_line_2;
using binary::read_plane_2;
bsq(){ hsi::init_bsq(); }
/// Open a data file for reading using the class interface.
/// @param filename is the name of the binary file on disk
/// @param X is the number of samples along dimension 1
/// @param Y is the number of samples (lines) along dimension 2
/// @param B is the number of samples (bands) along dimension 3
/// @param header_offset is the number of bytes (if any) in the binary header
/// @param wavelengths is an STL vector of size B specifying a numerical label for each band
bool open(std::string filename,
unsigned long long X,
unsigned long long Y,
unsigned long long B,
unsigned long long header_offset,
std::vector wavelengths){
//copy the wavelengths to the BSQ file structure
w = wavelengths;
//copy the wavelengths to the structure
offset = header_offset;
return open(filename, vec(X, Y, B), header_offset);
}
/// Retrieve a single band (based on index) and stores it in pre-allocated memory.
/// @param p is a pointer to an allocated region of memory at least X * Y * sizeof(T) in size.
/// @param page <= B is the integer number of the band to be copied.
bool band_index( T * p, unsigned long long page){
return read_plane_2(p, page); //call the binary read_plane function (don't let it update the progress)
}
/// Retrieve a single band (by numerical label) and stores it in pre-allocated memory.
/// @param p is a pointer to an allocated region of memory at least X * Y * sizeof(T) in size.
/// @param wavelength is a floating point value (usually a wavelength in spectral data) used as a label for the band to be copied.
bool band( T * p, double wavelength, bool PROGRESS = false){
if(PROGRESS) progress = 0;
//if there are no wavelengths in the BSQ file
if(w.size() == 0){
band_index(p, (unsigned long long)wavelength);
if(PROGRESS) progress = 100;
return true;
}
unsigned long long XY = X() * Y(); //calculate the number of pixels in a band
unsigned long long page = 0;
//get the two neighboring bands (above and below 'wavelength')
//if wavelength is smaller than the first one in header file
if ( w[page] > wavelength ){
band_index(p, page);
return true;
}
while( w[page] < wavelength )
{
page++;
//if wavelength is larger than the last wavelength in the header file
// (the wavelength is out of bounds)
if (page == Z()) {
band_index(p, Z()-1); //return the last band
return true;
}
}
//when the page counter points to the first band above 'wavelength'
if ( wavelength < w[page] ){
//do the interpolation
T * p1;
T * p2;
p1=(T*)malloc( XY * sizeof(T)); //memory allocation
p2=(T*)malloc( XY * sizeof(T));
band_index(p1, page - 1);
band_index(p2, page );
for(unsigned long long i=0; i < XY; i++){
double r = (wavelength - w[page-1]) / (w[page] - w[page-1]);
p[i] = (T)(((double)p2[i] - (double)p1[i]) * r + (double)p1[i]);
}
free(p1);
free(p2);
}
//if the wavelength is equal to a wavelength in header file
else{
band_index(p, page); //return the band
}
if(PROGRESS) progress = 100;
return true;
}
/// Retrieve a single spectrum (Z-axis line) at a given (x, y) location and stores it in pre-allocated memory.
/// @param p is a pointer to pre-allocated memory at least B * sizeof(T) in size.
/// @param x is the x-coordinate (dimension 1) of the spectrum.
/// @param y is the y-coordinate (dimension 2) of the spectrum.
void spectrum(T* p, size_t n, bool PROGRESS){
read_line_2(p, n, PROGRESS);
}
void spectrum(T * p, unsigned long long x, unsigned long long y, bool PROGRESS = false){
read_line_2(p, x, y, PROGRESS);
}
/// Retrieve a single pixel and stores it in pre-allocated memory.
/// @param p is a pointer to pre-allocated memory at least sizeof(T) in size.
/// @param n is an integer index to the pixel using linear array indexing.
bool pixel(T * p, unsigned long long n){
unsigned long long bandnum = X() * Y(); //calculate numbers in one band
if ( n >= bandnum){ //make sure the pixel number is right
std::cout<<"ERROR: sample or line out of range"<::header, std::ios::beg); //point to the certain pixel
for (unsigned long long i = 0; i < Z(); i++)
{
file.read((char *)(p + i), sizeof(T));
file.seekg((bandnum - 1) * sizeof(T), std::ios::cur); //go to the next band
}
return true;
}
/// Perform baseline correction given a list of baseline points and stores the result in a new BSQ file.
/// @param outname is the name of the output file used to store the resulting baseline-corrected data.
/// @param wls is the list of baseline points based on band labels.
bool baseline(std::string outname, std::vector wls, unsigned char* mask = NULL, bool PROGRESS = false )
{
size_t N = wls.size(); //get the number of baseline points
std::ofstream target(outname.c_str(), std::ios::binary); //open the target binary file
std::string headername = outname + ".hdr"; //the header file name
//simplify image resolution
unsigned long long B = Z(); //calculate the number of bands
unsigned long long XY = X() * Y(); //calculate the number of pixels in a band
unsigned long long S = XY * sizeof(T); //calculate the number of bytes in a band
double ai, bi; //stores the two baseline points wavelength surrounding the current band
double ci; //stores the current band's wavelength
unsigned long long control=0;
T * a; //pointers to the high and low band images
T * b;
T * c; //pointer to the current image
a = (T*)malloc( S ); //memory allocation
b = (T*)malloc( S );
c = (T*)malloc( S );
if (a == NULL || b == NULL || c == NULL){
std::cout<<"ERROR: error allocating memory";
exit(1);
}
//initialize lownum, highnum, low, high
ai=w[0];
//if no baseline point is specified at band 0,
//set the baseline point at band 0 to 0
if(wls[0] != w[0]){
bi = wls[control];
memset(a, (char)0, S);
}
//else get the low band
else{
control += 1;
band(a, ai);
bi = wls[control];
}
//get the high band
band(b, bi);
//correct every band
for(unsigned long long cii = 0; cii < B; cii++){
//update baseline points, if necessary
if( w[cii] >= bi && cii != B - 1) {
//if the high band is now on the last BL point?
if (control != N-1) {
control++; //increment the index
std::swap(a, b); //swap the baseline band pointers
ai = bi;
bi = wls[control];
band(b, bi);
}
//if the last BL point on the last band of the file?
else if ( wls[control] < w[B - 1]) {
std::swap(a, b); //swap the baseline band pointers
memset(b, (char)0, S); //clear the high band
ai = bi;
bi = w[B - 1];
}
}
//get the current band
band_index(c, cii);
ci = w[cii];
//perform the baseline correction
for(unsigned long long i=0; i < XY; i++){
if(mask != NULL && !mask[i]) //if the pixel is excluded by a mask
c[i] = 0; //set the value to zero
else{
double r = (double) (ci - ai) / (double) (bi - ai);
c[i] =(T) ( c[i] - (b[i] - a[i]) * r - a[i] );
}
}
target.write(reinterpret_cast(c), S); //write the corrected data into destination
if(PROGRESS)progress = (double)(cii+1) / B * 100;
}
//header.save(headername); //save the new header file
free(a);
free(b);
free(c);
target.close();
return true;
}
/// Normalize all spectra based on the value of a single band, storing the result in a new BSQ file.
/// @param outname is the name of the output file used to store the resulting baseline-corrected data.
/// @param w is the label specifying the band that the hyperspectral image will be normalized to.
/// @param t is a threshold specified such that a spectrum with a value at w less than t is set to zero. Setting this threshold allows the user to limit division by extremely small numbers.
bool ratio(std::string outname, double w, unsigned char* mask = NULL, bool PROGRESS = false)
{
unsigned long long B = Z(); //calculate the number of bands
unsigned long long XY = X() * Y(); //calculate the number of pixels in a band
unsigned long long S = XY * sizeof(T); //calculate the number of bytes in a band
std::ofstream target(outname.c_str(), std::ios::binary); //open the target binary file
std::string headername = outname + ".hdr"; //the header file name
T * b; //pointers to the certain wavelength band
T * c; //pointer to the current image
b = (T*)malloc( S ); //memory allocation
c = (T*)malloc( S );
band(b, w); //get the certain band into memory
for(unsigned long long j = 0; j < B; j++)
{
band_index(c, j); //get the current band into memory
for(unsigned long long i = 0; i < XY; i++)
{
if(mask != NULL && !mask[i])
c[i] = (T)0.0;
else
c[i] = c[i] / b[i];
}
target.write(reinterpret_cast(c), S); //write normalized data into destination
if(PROGRESS) progress = (double)(j+1) / B * 100;
}
//header.save(headername); //save the new header file
free(b);
free(c);
target.close();
return true;
}
void normalize(std::string outfile, unsigned char* mask = NULL, bool PROGRESS = false){
size_t B = Z(); //calculate the number of bands
size_t XY = X() * Y(); //calculate the number of pixels in a band
size_t XYb = XY * sizeof(T); //calculate the size of a band in bytes
std::ofstream out(outfile.c_str(), std::ios::binary); //open the output file
file.seekg(0, std::ios::beg); //move the pointer to the current file to the beginning
T* len = (T*)malloc(XYb); //allocate space to store the vector length
memset(len, 0, XYb); //initialize the vector length to zero (0)
T* band = (T*) malloc(XYb); //allocate space to store a band image
for(size_t b = 0; b < B; b++){
file.read((char*)band, XYb);
for(size_t xy = 0; xy < XY; xy++){
if(mask == NULL || mask[xy]){
len[xy] += pow(band[xy], 2); //sum the squared value for each pixel value in the band
}
}
if(PROGRESS) progress = (double) (b+1) / (double)B * 50;
}
for(size_t xy = 0; xy < XY; xy++){ //for each pixel, calculate the square root
if(mask == NULL || mask[xy]){
len[xy] += pow(band[xy], 2); //sum the squared value for each pixel value in the band
}
}
file.seekg(0, std::ios::beg); //move the pointer to the current file to the beginning
for(size_t b = 0; b < B; b++){
file.read((char*)band, XYb);
for(size_t xy = 0; xy < XY; xy++){
if(mask == NULL || mask[xy]){
band[xy] /= len[xy]; //divide the band by the vector length
}
}
out.write((char*)band, XYb);
if(PROGRESS) progress = (double) (b+1) / (double)B * 50 + 50;
}
}
/// Convert the current BSQ file to a BIL file with the specified file name.
/// @param outname is the name of the output BIL file to be saved to disk.
bool bil(std::string outname, bool PROGRESS = false)
{
//simplify image resolution
unsigned long long jump = (Y() - 1) * X() * sizeof(T);
std::ofstream target(outname.c_str(), std::ios::binary);
std::string headername = outname + ".hdr";
unsigned long long L = X();
T* line = (T*)malloc(sizeof(T) * L);
for ( unsigned long long y = 0; y < Y(); y++) //for each y position
{
file.seekg(y * X() * sizeof(T), std::ios::beg); //seek to the beginning of the xz slice
for ( unsigned long long z = 0; z < Z(); z++ ) //for each band
{
file.read((char *)line, sizeof(T) * X()); //read a line
target.write((char*)line, sizeof(T) * X()); //write the line to the output file
file.seekg(jump, std::ios::cur); //seek to the next band
if(PROGRESS) progress = (double)((y+1) * Z() + z + 1) / (Z() * Y()) * 100; //update the progress counter
}
}
free(line);
target.close();
return true;
}
/// Return a baseline corrected band given two adjacent baseline points and their bands. The result is stored in a pre-allocated array.
/// @param lb is the label value for the left baseline point
/// @param rb is the label value for the right baseline point
/// @param lp is a pointer to an array holding the band image for the left baseline point
/// @param rp is a pointer to an array holding the band image for the right baseline point
/// @param wavelength is the label value for the requested baseline-corrected band
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size.
bool baseline_band(double lb, double rb, T* lp, T* rp, double wavelength, T* result){
unsigned long long XY = X() * Y();
band(result, wavelength); //get band
//perform the baseline correction
double r = (double) (wavelength - lb) / (double) (rb - lb);
for(unsigned long long i=0; i < XY; i++){
result[i] =(T) (result[i] - (rp[i] - lp[i]) * r - lp[i] );
}
return true;
}
/// Return a baseline corrected band given two adjacent baseline points. The result is stored in a pre-allocated array.
/// @param lb is the label value for the left baseline point
/// @param rb is the label value for the right baseline point
/// @param bandwavelength is the label value for the desired baseline-corrected band
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size.
bool height(double lb, double rb, double bandwavelength, T* result){
T* lp;
T* rp;
unsigned long long XY = X() * Y();
unsigned long long S = XY * sizeof(T);
lp = (T*) malloc(S); //memory allocation
rp = (T*) malloc(S);
band(lp, lb);
band(rp, rb);
baseline_band(lb, rb, lp, rp, bandwavelength, result);
free(lp);
free(rp);
return true;
}
/// Calculate the area under the spectrum between two specified points and stores the result in a pre-allocated array.
/// @param lb is the label value for the left baseline point
/// @param rb is the label value for the right baseline point
/// @param lab is the label value for the left bound (start of the integration)
/// @param rab is the label value for the right bound (end of the integration)
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size
bool area(double lb, double rb, double lab, double rab, T* result){
T* lp; //left band pointer
T* rp; //right band pointer
T* cur; //current band 1
T* cur2; //current band 2
unsigned long long XY = X() * Y();
unsigned long long S = XY * sizeof(T);
lp = (T*) malloc(S); //memory allocation
rp = (T*) malloc(S);
cur = (T*) malloc(S);
cur2 = (T*) malloc(S);
//find the wavelength position in the whole band
unsigned long long n = w.size();
unsigned long long ai = 0; //left bound position
unsigned long long bi = n - 1; //right bound position
//to make sure the left and the right bound are in the bandwidth
if (lb < w[0] || rb < w[0] || lb > w[n-1] || rb >w[n-1]){
std::cout<<"ERROR: left bound or right bound out of bandwidth"< rb){
std::cout<<"ERROR: right bound should be bigger than left bound"<= w[ai]){
ai++;
}
while (rab <= w[bi]){
bi--;
}
band(lp, lb); //get the band images for the left and right baseline points
band(rp, rb);
// calculate the average value of the indexed region
memset(result, 0, S); //initialize the integral to zero (0)
//integrate the region between the specified bands and the closest indexed band
// this integrates the "tails" of the spectrum that lie outside the main indexed region
baseline_band(lb, rb, lp, rp, rab, cur2); //calculate the image for the right-most band in the integral
baseline_band(lb, rb, lp, rp, w[bi], cur); //calculate the image for the right-most indexed band
for(unsigned long long j = 0; j < XY; j++){
result[j] += (T)((rab - w[bi]) * ((double)cur[j] + (double)cur2[j]) / 2.0);
}
baseline_band(lb, rb, lp, rp, lab, cur2); //beginnning part
baseline_band(lb, rb, lp, rp, w[ai], cur);
for(unsigned long long j = 0; j < XY; j++){
result[j] += (T)((w[ai] - lab) * ((double)cur[j] + (double)cur2[j]) / 2.0);
}
//integrate the main indexed region
ai++;
for(unsigned long long i = ai; i <= bi ;i++) //for each band in the integral
{
baseline_band(lb, rb, lp, rp, w[ai], cur2); //get the baselined band
for(unsigned long long j = 0; j < XY; j++){ //for each pixel in that band
result[j] += (T)((w[ai] - w[ai-1]) * ((double)cur[j] + (double)cur2[j]) / 2.0);
}
std::swap(cur,cur2); //swap the band pointers
}
free(lp);
free(rp);
free(cur);
free(cur2);
return true;
}
/// Compute the ratio of two baseline-corrected peaks. The result is stored in a pre-allocated array.
/// @param lb1 is the label value for the left baseline point for the first peak (numerator)
/// @param rb1 is the label value for the right baseline point for the first peak (numerator)
/// @param pos1 is the label value for the first peak (numerator) position
/// @param lb2 is the label value for the left baseline point for the second peak (denominator)
/// @param rb2 is the label value for the right baseline point for the second peak (denominator)
/// @param pos2 is the label value for the second peak (denominator) position
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size
bool ph_to_ph(T* result, double lb1, double rb1, double pos1, double lb2, double rb2, double pos2, unsigned char* mask = NULL){
size_t XYbytes = X() * Y() * sizeof(T); //calculate the size of the band image (in bytes)
T* p1 = (T*)malloc(XYbytes); //allocate space for both bands in the ratio
T* p2 = (T*)malloc(XYbytes);
memset(result, 0, XYbytes); //initialize the ratio to zero
//get the two peak band
height(lb1, rb1, pos1, p1);
height(lb2, rb2, pos2, p2);
//calculate the ratio in result
for(unsigned long long i = 0; i < X() * Y(); i++){
if(mask == NULL || mask[i]){
result[i] = p1[i] / p2[i];
}
}
free(p1);
free(p2);
return true;
}
/// Compute the ratio between a peak area and peak height.
/// @param lb1 is the label value for the left baseline point for the first peak (numerator)
/// @param rb1 is the label value for the right baseline point for the first peak (numerator)
/// @param pos1 is the label value for the first peak (numerator) position
/// @param lb2 is the label value for the left baseline point for the second peak (denominator)
/// @param rb2 is the label value for the right baseline point for the second peak (denominator)
/// @param pos2 is the label value for the second peak (denominator) position
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size
bool pa_to_ph(T* result, double lb1, double rb1, double lab1, double rab1,
double lb2, double rb2, double pos, unsigned char* mask = NULL){
size_t bytes = X() * Y() * sizeof(T);
T* p1 = (T*)malloc(bytes); //allocate space for both ratio components
T* p2 = (T*)malloc(bytes);
memset(result, 0, bytes); //initialize the ratio to zero
//get the area and the peak band
area(lb1, rb1, lab1, rab1, p1);
height(lb2, rb2, pos, p2);
//calculate the ratio in result
for(unsigned long long i = 0; i < X() * Y(); i++){
if(mask == NULL || mask[i])
result[i] = p1[i] / p2[i];
}
free(p1);
free(p2);
return true;
}
/// Compute the ratio between two peak areas.
/// @param lb1 is the label value for the left baseline point for the first peak (numerator)
/// @param rb1 is the label value for the right baseline point for the first peak (numerator)
/// @param lab1 is the label value for the left bound (start of the integration) of the first peak (numerator)
/// @param rab1 is the label value for the right bound (end of the integration) of the first peak (numerator)
/// @param lb2 is the label value for the left baseline point for the second peak (denominator)
/// @param rb2 is the label value for the right baseline point for the second peak (denominator)
/// @param lab2 is the label value for the left bound (start of the integration) of the second peak (denominator)
/// @param rab2 is the label value for the right bound (end of the integration) of the second peak (denominator)
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size
bool pa_to_pa(T* result, double lb1, double rb1, double lab1, double rab1,
double lb2, double rb2, double lab2, double rab2, unsigned char* mask = NULL){
size_t bytes = X() * Y() * sizeof(T);
T* p1 = (T*)malloc(bytes); //allocate space for each of the operands
T* p2 = (T*)malloc(bytes);
memset(result, 0, bytes); //initialize the ratio result to zero (0)
//get the area and the peak band
area(lb1, rb1, lab1, rab1, p1);
area(lb2, rb2, lab2, rab2, p2);
//calculate the ratio in result
for(unsigned long long i = 0; i < X() * Y(); i++){
if(mask == NULL || mask[i]) //if the pixel is masked
result[i] = p1[i] / p2[i]; //calculate the ratio
}
free(p1);
free(p2);
return true;
}
/// Compute the definite integral of a baseline corrected peak weighted by the corresponding wavelength
/// @param lb is the label value for the left baseline point
/// @param rb is the label value for the right baseline point
/// @param lab is the label for the start of the definite integral
/// @param rab is the label for the end of the definite integral
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size
bool x_area(double lb, double rb, double lab, double rab, T* result){
T* lp; //left band pointer
T* rp; //right band pointer
T* cur; //current band 1
T* cur2; //current band 2
unsigned long long XY = X() * Y();
unsigned long long S = XY * sizeof(T);
lp = (T*) malloc(S); //memory allocation
rp = (T*) malloc(S);
cur = (T*) malloc(S);
cur2 = (T*) malloc(S);
//find the wavelenght position in the whole band
unsigned long long n = w.size();
unsigned long long ai = 0; //left bound position
unsigned long long bi = n - 1; //right bound position
//to make sure the left and the right bound are in the bandwidth
if (lb < w[0] || rb < w[0] || lb > w[n-1] || rb >w[n-1]){
std::cout<<"ERROR: left bound or right bound out of bandwidth"< rb){
std::cout<<"ERROR: right bound should be bigger than left bound"<= w[ai]){
ai++;
}
while (rab <= w[bi]){
bi--;
}
band(lp, lb);
band(rp, rb);
memset(result, (char)0, S); //initialize the integral to zero (0)
//calculate the beginning and the ending part
baseline_band(lb, rb, lp, rp, rab, cur2); //ending part
baseline_band(lb, rb, lp, rp, w[bi], cur);
for(unsigned long long j = 0; j < XY; j++){
result[j] += (T)((rab - w[bi]) * (rab + w[bi]) * ((double)cur[j] + (double)cur2[j]) / 4.0);
}
baseline_band(lb, rb, lp, rp, lab, cur2); //beginnning part
baseline_band(lb, rb, lp, rp, w[ai], cur);
for(unsigned long long j = 0; j < XY; j++){
result[j] += (T)((w[ai] - lab) * (w[ai] + lab) * ((double)cur[j] + (double)cur2[j]) / 4.0);
}
//calculate f(x) times x
ai++;
for(unsigned long long i = ai; i <= bi ;i++){
baseline_band(lb, rb, lp, rp, w[ai], cur2);
for(unsigned long long j = 0; j < XY; j++){
T v = (T)((w[ai] - w[ai-1]) * (w[ai] + w[ai-1]) * ((double)cur[j] + (double)cur2[j]) / 4.0);
result[j] += v;
}
std::swap(cur,cur2); //swap the band pointers
}
free(lp);
free(rp);
free(cur);
free(cur2);
return true;
}
/// Compute the centroid of a baseline corrected peak.
/// Note that the values for the centroid can be outside of [lab, rab] if the spectrum goes negative.
/// @param lb is the label value for the left baseline point
/// @param rb is the label value for the right baseline point
/// @param lab is the label for the start of the peak
/// @param rab is the label for the end of the peak
/// @param result is a pointer to a pre-allocated array at least X * Y * sizeof(T) in size
bool centroid(T* result, double lb, double rb, double lab, double rab, unsigned char* mask = NULL){
size_t bytes = X() * Y() * sizeof(T); //calculate the number of bytes in a band image
T* p1 = (T*)malloc(X() * Y() * sizeof(T)); //allocate space for both operands
T* p2 = (T*)malloc(X() * Y() * sizeof(T));
memset(result, 0, bytes); //initialize the ratio result to zero (0)
//get the area and the peak band
x_area(lb, rb, lab, rab, p1);
area(lb, rb, lab, rab, p2);
//calculate the ratio in result
for(unsigned long long i = 0; i < X() * Y(); i++){
if(mask == NULL || mask[i]){
result[i] = p1[i] / p2[i];
}
}
free(p1);
free(p2);
return true;
}
/// Create a mask based on a given band and threshold value.
/// All pixels in the
/// specified band greater than the threshold are true and all pixels less than the threshold are false.
/// @param mask_band is the band used to specify the mask
/// @param threshold is the threshold used to determine if the mask value is true or false
/// @param p is a pointer to a pre-allocated array at least X * Y in size
bool build_mask(unsigned char* mask, double mask_band, double threshold, bool PROGRESS = false){
T* temp = (T*)malloc(X() * Y() * sizeof(T)); //allocate memory for the certain band
band(temp, mask_band);
for (unsigned long long i = 0; i < X() * Y(); i++) {
if (temp[i] < threshold)
mask[i] = 0;
else
mask[i] = 255;
if(PROGRESS) progress = (double) (i+1) / (X() * Y()) * 100;
}
free(temp);
return true;
}
/// Apply a mask file to the BSQ image, setting all values outside the mask to zero.
/// @param outfile is the name of the masked output file
/// @param p is a pointer to memory of size X * Y, where p(i) = 0 for pixels that will be set to zero.
bool apply_mask(std::string outfile, unsigned char* p, bool PROGRESS = false){
std::ofstream target(outfile.c_str(), std::ios::binary);
unsigned long long XY = X() * Y(); //calculate number of a band
unsigned long long L = XY * sizeof(T);
T * temp = (T*)malloc(L);
for (unsigned long long i = 0; i < Z(); i++) //for each spectral bin
{
band_index(temp, i); //get the specified band (by index)
for ( unsigned long long j = 0; j < XY; j++) // for each pixel
{
if(p[j] == 0){ //if the mask is 0 at that pixel
temp[j] = 0; //set temp to zero
}
else{
continue;
}
}
target.write(reinterpret_cast(temp), L); //write the XY slice at that band to disk
if(PROGRESS) progress = (double)(i + 1) / (double)Z() * 100;
}
target.close();
free(temp);
return true;
}
/// Copies all spectra corresponding to nonzero values of a mask into a pre-allocated matrix of size (B x P)
/// where P is the number of masked pixels and B is the number of bands. The allocated memory can be accessed
/// using the following indexing: i = p*B + b
/// @param matrix is the destination for the pixel data
/// @param mask is the mask
bool sift(T* matrix, unsigned char* mask = NULL, bool PROGRESS = false){
unsigned long long XY = X() * Y(); //Number of XY pixels
unsigned long long L = XY * sizeof(T); //size of XY plane (in bytes)
//calculate the number of pixels in the mask
//unsigned long long P = nnz(mask);
T* band_image = (T*) malloc( XY * sizeof(T)); //allocate space for a single band
unsigned long long i; //pixel index into the sifted array
for(unsigned long long b = 0; b < Z(); b++){ //for each band in the data set
band_index(band_image, b); //retrieve an image of that band
i = 0;
for(unsigned long long xy = 0; xy < XY; xy++){
if(mask == NULL || mask[xy] != 0){ //if the pixel is valid
matrix[i*Z() + b] = band_image[xy]; //copy it to the appropriate point in the values[] array
i++;
}
if(PROGRESS) progress = (double)(xy+1) / (double)XY * 100;
}
}
return true;
}
/// Saves to disk only those spectra corresponding to mask values != 0
/// @param outfile is the name of the sifted ENVI file to be written to disk
/// @param unsigned char* p is the mask file used for sifting
bool sift(std::string outfile, unsigned char* p, bool PROGRESS = false){
std::ofstream target(outfile.c_str(), std::ios::binary);
// open a band (XY plane)
unsigned long long XY = X() * Y(); //Number of XY pixels
unsigned long long L = XY * sizeof(T); //size of XY pixels
unsigned long long B = Z();
T * temp = (T*)malloc(L); //allocate memory for a band
T * temp_vox = (T*)malloc(sizeof(T)); //allocate memory for one voxel
for (unsigned long long i = 0; i < B; i++) //for each spectral bin
{
band_index(temp, i); //get the specified band (XY sheet by index)
for (unsigned long long j = 0; j < XY; j++) // for each pixel
{
if (p[j] != 0){ //if the mask is != 0 at that pixel
temp_vox[0] = temp[j];
target.write(reinterpret_cast(temp_vox), sizeof(T)); //write the XY slice at that band to disk
}
else{
continue;
}
}
if(PROGRESS) progress = (double)(i+1)/ B * 100;
}
target.close();
free(temp);
progress = 100;
return true;
}
/// Generates a spectral image from a matrix of spectral values in lexicographic order and a mask
bool unsift(std::string outfile, unsigned char* p, unsigned long long samples, unsigned long long lines, bool PROGRESS = false){
//create a binary output stream
std::ofstream target(outfile.c_str(), std::ios::binary);
//make sure that there's only one line
if(Y() != 1){
std::cout<<"ERROR in stim::bsq::sift() - number of lines does not equal 1"<(unsifted), sizeof(T) * XY);
}
//std::cout<<"unsifted"<(temp), L); //write slice data into target file
file.seekg(jumpb, std::ios::cur);
}
free(temp);
return true;
}
/// Remove a list of bands from the ENVI file
/// @param outfile is the file name for the output hyperspectral image (with trimmed bands)
/// @param b is an array of bands to be eliminated
void trim(std::string outfile, std::vector band_array, bool PROGRESS = false){
std::ofstream out(outfile.c_str(), std::ios::binary); //open the output file for writing
file.seekg(0, std::ios::beg); //move to the beginning of the input file
size_t XY = X() * Y(); //calculate the number of elements in a band
size_t XYb = XY * sizeof(T); //calculate the number of bytes in a band
T* temp = (T*)malloc(XYb); //allocate space to store a band
size_t i = 0; //store the first index into the band array
for(size_t b = 0; b < Z(); b++){ //for each band
if(b != band_array[i]){ //if this band is not trimmed
file.read((char*)temp, XYb); //read the band
out.write((char*)temp, XYb); //output the band
}
else{
file.seekg(XYb, std::ios::cur); //otherwise, skip the band
i++;
}
if(PROGRESS) progress = (double)(b+1) / (double) Z() * 100;
}
free(temp); //free the scratch space for the band
}
/// Combine two BSQ images along the Y axis
/// @param outfile is the combined file to be output
/// @param infile is the input file stream for the image to combine with this one
/// @param Sx is the size of the second image along X
/// @param Sy is the size of the second image along Y
/// @param offset is a shift (negative or positive) in the combined image to the left or right
void combine(std::string outfile, bsq* C, long long xp, long long yp, bool PROGRESS = false){
std::ofstream out(outfile.c_str(), std::ios::binary); //open the output file for writing
file.seekg(0, std::ios::beg); //move to the beginning of both files
C->file.seekg(0, std::ios::beg);
size_t S[2]; //size of the output band image
size_t p0[2]; //position of the current image in the output
size_t p1[2]; //position of the source image in the output
hsi::calc_combined_size(xp, yp, C->X(), C->Y(), S[0], S[1], p0[0], p0[1], p1[0], p1[1]); //calculate the image placement parameters
size_t line_bytes = X() * sizeof(T);
size_t band_bytes = X() * Y() * sizeof(T);
T* cur = (T*)malloc(X() * Y() * sizeof(T)); //allocate space for a band of the current image
size_t line_src_bytes = C->X() * sizeof(T);
size_t band_src_bytes = C->X() * C->Y() * sizeof(T);
T* src = (T*)malloc(C->X() * C->Y() * sizeof(T)); //allocate space for a band of the source image
size_t line_dst_bytes = S[0] * sizeof(T);
size_t band_dst_bytes = S[0] * S[1] * sizeof(T);
T* dst = (T*)malloc(band_dst_bytes); //allocate space for a band of the destination image
memset(dst, 0, band_dst_bytes); //set all values to zero (0) in the destination image
for(size_t b = 0; b < Z(); b++){ //for each band in both images
file.read((char*)cur, band_bytes); //read a band from the current image
C->file.read((char*)src, band_src_bytes); //read a band from the source image
for(size_t y = 0; y < Y(); y++)
memcpy( &dst[ (p0[1]+y) * S[0] + p0[0] ], &cur[ y * X() ], line_bytes); //copy the line from the current to the destination image
//memset( &dst[ (p0[1]+y) * S[0] + p0[0] ], 0, line_dst_bytes);
for(size_t y = 0; y < C->Y(); y++)
memcpy( &dst[ (p1[1]+y) * S[0] + p1[0] ], &src[ y * C->X() ], line_src_bytes); //copy the line from the source to the destination image
out.write((char*)dst, band_dst_bytes); //write the combined image to an output file
if(PROGRESS) progress = (double)(b + 1) / (double) Z() * 100;
}
out.close();
}
/// Convolve the given band range with a kernel specified by a vector of coefficients.
/// @param outfile is an already open stream to the output file
/// @param C is an array of coefficients
/// @param start is the band to start processing (the first coefficient starts here)
/// @param nbands is the number of bands to process
/// @param center is the index for the center coefficient for the kernel (used to set the wavelengths in the output file)
void convolve(std::ofstream& out, std::vector C, size_t start, size_t end, unsigned char* mask = NULL, bool PROGRESS = false){
size_t nbands = end - start + 1;
size_t XY = X() * Y(); //calculate the number of values in a band
size_t XYb = XY * sizeof(T); //calculate the size of a band (frame) in bytes
file.seekg(XYb * start, std::ios::beg); //move to the beginning of the 'start' band
size_t nframes = C.size(); //get the number of bands that the kernel spans
std::deque frame(nframes, NULL); //create an array to store pointers to each frame
for(size_t f = 0; f < nframes; f++){ //for each frame
frame[f] = (T*)malloc(XYb); //allocate space for the frame
file.read((char*)frame[f], XYb); //load the frame
}
T* outband = (T*)malloc(XYb); //allocate space for the output band
//Implementation: In order to minimize reads from secondary storage, each band is only loaded once into the 'frame' deque.
// When a new band is loaded, the last band is popped, a new frame is copied to the pointer, and it is
// re-inserted into the deque.
for(size_t b = 0; b < nbands; b++){ //for each band
memset(outband, 0, XYb); //set the output band to zero (0)
size_t c, xy;
double coeff;
for(c = 0; c < nframes; c++){ //for each frame (corresponding to each coefficient)
coeff = C[c];
for(xy = 0; xy < XY; xy++){ //for each pixel
if(mask == NULL || mask[xy]){
outband[xy] += (T)(coeff * frame[c][xy]); //calculate the contribution of the current frame (scaled by the corresponding coefficient)
}
}
}
out.write((char*)outband, XYb); //output the band
file.read((char*)frame[0], XYb); //read the next band
frame.push_back(frame.front()); //put the first element in the back
frame.pop_front(); //pop the first element
if(PROGRESS) progress = (double)(b+1) / (double)nbands * 100;
}
}
/// Performs a single convolution and saves it to an output file
/// @param outfile is the convolved file to be output
/// @param C is an array of coefficients
/// @param start is the band to start processing (the first coefficient starts here)
/// @param nbands is the number of bands to process
void convolve(std::string outfile, std::vector C, size_t start, size_t end, unsigned char* mask = NULL, bool PROGRESS = false){
std::ofstream out(outfile.c_str(), std::ios::binary); //open the output file for writing
convolve(out, C, start, end, mask, PROGRESS); //start the convolution
out.close();
}
/// Performs a set of convolutions and chains the results together in a single file
/// @param outfile is the convolved file to be output
/// @param C is an array containing an array of coefficients for each kernel
/// @param start is the list of start bands for each kernel
/// @param end is the list of end bands for each kernel
void convolve(std::string outfile, std::vector< std::vector > C, std::vector start, std::vector end, unsigned char* mask = NULL, bool PROGRESS = false){
std::ofstream out(outfile.c_str(), std::ios::binary); //open the output file for writing
size_t K = C.size(); //get the number of kernels
for(size_t k = 0; k < K; k++){
size_t b0 = start[k]; //calculate the range of the convolution
size_t b1 = end[k];
convolve(out, C[k], b0, b1, mask, PROGRESS); //perform the convolution with the current kernel in the given range
}
out.close();
}
/// Approximate the spectral derivative of the image
void deriv(std::string outfile, size_t d, size_t order, const std::vector w = std::vector(), unsigned char* mask = NULL, bool PROGRESS = false){
std::ofstream out(outfile.c_str(), std::ios::binary); //open the output file for writing
size_t XY = X() * Y(); //calculate the number of values in a band
size_t XYb = XY * sizeof(T); //calculate the size of a band (frame) in bytes
size_t B = Z();
file.seekg(0, std::ios::beg); //move to the beginning of the file
size_t N = order + d; //approximating a derivative requires order + d samples
std::deque frame(N, NULL); //create an array to store pointers to each frame
for(size_t f = 0; f < N; f++){ //for each frame
frame[f] = (T*)malloc(XYb); //allocate space for the frame
file.read((char*)frame[f], XYb); //load the frame
}
T* outband = (T*)malloc(XYb); //allocate space for the output band
//Implementation: In order to minimize reads from secondary storage, each band is only loaded once into the 'frame' deque.
// When a new band is loaded, the last band is popped, a new frame is copied to the pointer, and it is
// re-inserted into the deque.
size_t mid = (size_t)(N / 2); //calculate the mid point of the kernel
size_t iw; //index to the first wavelength used to evaluate the derivative at this band
for(size_t b = 0; b < B; b++){ //for each band
if(b < mid) //calculate the first wavelength used to evaluate the derivative at this band
iw = 0;
else if(b > B - (N - mid + 1))
iw = B - N;
else{
iw = b - mid;
file.read((char*)frame[0], XYb); //read the next band
frame.push_back(frame.front()); //put the first element in the back
frame.pop_front(); //pop the first element
}
std::vector w_pts(w.begin() + iw, w.begin() + iw + N); //get the wavelengths corresponding to each sample
std::vector C = diff_coefficients(w[b], w_pts, d); //get the optimal sample weights
memset(outband, 0, XYb); //set the output band to zero (0)
for(size_t c = 0; c < N; c++){ //for each frame (corresponding to each coefficient)
for(size_t xy = 0; xy < XY; xy++){ //for each pixel
if(mask == NULL || mask[xy]){
outband[xy] += (T)(C[c] * frame[c][xy]); //calculate the contribution of the current frame (scaled by the corresponding coefficient)
}
}
}
out.write((char*)outband, XYb); //output the band
if(PROGRESS) progress = (double)(b+1) / (double)B * 100;
}
}
/// Close the file.
bool close(){
file.close();
return true;
}
};
}
#endif