Converter.cc

Go to the documentation of this file.

// An abstract class for the MBS or MIDAS data conversion
#include "Converter.hh"
 
MiniballConverter::MiniballConverter( std::shared_ptr<MiniballSettings> myset ) {
 
    // We need to do initialise, but only after Settings are added
    set = myset;
 
    my_tm_stp_msb = 0;
    my_tm_stp_hsb = 0;
 
    ctr_febex_hit.resize( set->GetNumberOfFebexSfps() );
    ctr_febex_pause.resize( set->GetNumberOfFebexSfps() );
    ctr_febex_resume.resize( set->GetNumberOfFebexSfps() );
    ctr_febex_sync.resize( set->GetNumberOfFebexSfps() );
 
    first_data.resize( set->GetNumberOfFebexSfps(), true );
 
    tm_stp_read.resize( set->GetNumberOfFebexSfps(), 0 );
    tm_stp_febex.resize( set->GetNumberOfFebexSfps() );
    tm_stp_febex_ch.resize( set->GetNumberOfFebexSfps() );
 
    // Start counters at zero
    for( unsigned int i = 0; i < set->GetNumberOfFebexSfps(); ++i ) {
                
        ctr_febex_hit[i].resize( set->GetNumberOfFebexBoards() );
        ctr_febex_pause[i].resize( set->GetNumberOfFebexBoards() );
        ctr_febex_resume[i].resize( set->GetNumberOfFebexBoards() );
        ctr_febex_sync[i].resize( set->GetNumberOfFebexBoards() );
 
        tm_stp_febex[i].resize( set->GetNumberOfFebexBoards(), 0 );
        tm_stp_febex_ch[i].resize( set->GetNumberOfFebexBoards() );
 
        for( unsigned int j = 0; j < set->GetNumberOfFebexBoards(); ++j )
            tm_stp_febex_ch[i][j].resize( set->GetNumberOfFebexBoards(), 0 );
        
    }
    
    // Default that we do not have a source or EBIS only run
    flag_source = false;
    flag_ebis = false;
    
    // No progress bar by default
    _prog_ = false;
 
    // Histogrammer options
    //TH1::AddDirectory(kFALSE);
 
    // Intialise the hist list
    histlist = new TList();
 
}
 
void MiniballConverter::NewBuffer(){
 
    // Reset check on first data item per SFP
    for( unsigned int i = 0; i < set->GetNumberOfFebexSfps(); ++i ) {
 
        first_data[i] = true;
        
    }
    
}
 
void MiniballConverter::StartFile(){
    
    // Start counters at zero
    for( unsigned int i = 0; i < set->GetNumberOfFebexSfps(); ++i ) {
                
        // Start counters at zero
        for( unsigned int j = 0; j < set->GetNumberOfFebexBoards(); ++j ) {
                    
            first_data[i] = true;
 
            ctr_febex_hit[i][j] = 0;    // hits on each module
            ctr_febex_pause[i][j] = 0;
            ctr_febex_resume[i][j] = 0;
            ctr_febex_sync[i][j] = 0;
 
            tm_stp_febex[i][j] = 0;         
            for( unsigned int k = 0; k < set->GetNumberOfFebexBoards(); ++k )
                tm_stp_febex_ch[i][j][k] = 0;
 
        }
 
    }
 
    jump_ctr = 0;   // timestamp jumps (jumps more than 300s in same board)
    warp_ctr = 0;   // timestamp warps (goes back in time, wrong board ID)
    mash_ctr = 0;   // timestamp mashes (mangled bits, with 16-bit shift)
    data_ctr = 0;   // total data items
    reject_ctr = 0; // rejected buffers
    
    buffer_full = false;    // first buffer not yet assumed to be full
 
    // Flags for FEBEX data items
    flag_febex_data0 = false;
    flag_febex_data1 = false;
    flag_febex_data2 = false;
    flag_febex_data3 = false;
    flag_febex_trace = false;
 
    // clear the data vectors
    std::vector<std::shared_ptr<MiniballDataPackets>>().swap(data_vector);
    std::vector<std::pair<unsigned long,double>>().swap(data_map);
 
    return;
    
}
 
void MiniballConverter::SetOutput( std::string output_file_name ){
    
    // Open output file
    output_file = new TFile( output_file_name.data(), "recreate", "FEBEX raw data file" );
 
    return;
 
};
 
 
void MiniballConverter::MakeTree() {
 
    // Create Root tree
    const int splitLevel = 0; // don't split branches = 0, full splitting = 99
    const int bufsize = 256000;
    sorted_tree = new TTree( "mb_sort", "Time sorted, calibrated Miniball data" );
    mbsinfo_tree = new TTree( "mbsinfo", "mbsinfo" );
    write_packet = std::make_shared<MiniballDataPackets>();
    mbsinfo_packet = std::make_shared<MBSInfoPackets>();
    sorted_tree->Branch( "data", "MiniballDataPackets", write_packet.get(), bufsize, splitLevel );
    mbsinfo_tree->Branch( "mbsinfo", "MBSInfoPackets", mbsinfo_packet.get(), bufsize, 0 );
    
    sorted_tree->SetDirectory( output_file->GetDirectory("/") );
    mbsinfo_tree->SetDirectory( output_file->GetDirectory("/") );
 
    dgf_data = std::make_shared<DgfData>();
    adc_data = std::make_shared<AdcData>();
    febex_data = std::make_shared<FebexData>();
    info_data = std::make_shared<InfoData>();
    
    dgf_data->ClearData();
    adc_data->ClearData();
    febex_data->ClearData();
    info_data->ClearData();
    
    return;
    
}
 
void MiniballConverter::MakeHists() {
    
    std::string hname, htitle;
    std::string dirname, maindirname, subdirname;
    
    // Maximum ADC value depends on MBS or MIDAS
    if( mbs_data ) qmax_default = 8388608;
    else qmax_default = 4294967296;
 
    // Make directories - just one DAQ type for now, no sub directories
    // if you do add a directory here, please use a trailing slash
    maindirname = "";
    
    // Resize vectors
    hfebex_qshort.resize( set->GetNumberOfFebexSfps() );
    hfebex_qint.resize( set->GetNumberOfFebexSfps() );
    hfebex_cal.resize( set->GetNumberOfFebexSfps() );
    hfebex_mwd.resize( set->GetNumberOfFebexSfps() );
    hfebex_hit.resize( set->GetNumberOfFebexSfps() );
    hfebex_pause.resize( set->GetNumberOfFebexSfps() );
    hfebex_resume.resize( set->GetNumberOfFebexSfps() );
    hfebex_sync.resize( set->GetNumberOfFebexSfps() );
 
    // Loop over FEBEX SFPs
    for( unsigned int i = 0; i < set->GetNumberOfFebexSfps(); ++i ) {
        
        hfebex_qshort[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_qint[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_cal[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_mwd[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_hit[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_pause[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_resume[i].resize( set->GetNumberOfFebexBoards() );
        hfebex_sync[i].resize( set->GetNumberOfFebexBoards() );
 
        // Loop over each FEBEX board
        for( unsigned int j = 0; j < set->GetNumberOfFebexBoards(); ++j ) {
            
            hfebex_qshort[i][j].resize( set->GetNumberOfFebexChannels() );
            hfebex_qint[i][j].resize( set->GetNumberOfFebexChannels() );
            hfebex_cal[i][j].resize( set->GetNumberOfFebexChannels() );
            hfebex_mwd[i][j].resize( set->GetNumberOfFebexChannels() );
 
            dirname  = maindirname + "sfp_" + std::to_string(i);
            dirname += "/board_" + std::to_string(j);
            
            if( !output_file->GetDirectory( dirname.data() ) )
                output_file->mkdir( dirname.data() );
            output_file->cd( dirname.data() );
 
            // Loop over channels of each FEBEX board
            for( unsigned int k = 0; k < set->GetNumberOfFebexChannels(); ++k ) {
                
                // Uncalibrated energy - 16-bit value
                hname = "febex_" + std::to_string(i);
                hname += "_" + std::to_string(j);
                hname += "_" + std::to_string(k);
                hname += "_qshort";
                
                htitle = "Raw FEBEX spectra for SFP " + std::to_string(i);
                htitle += ", board " + std::to_string(j);
                htitle += ", channel " + std::to_string(k);
                htitle += ";Charge value;Counts";
 
                hfebex_qshort[i][j][k] = new TH1F( hname.data(), htitle.data(), 16384, 0, (unsigned long long)1<<16 );
                histlist->Add(hfebex_qshort[i][j][k]);
 
                // Uncalibrated energy 32-bit value
                hname = "febex_" + std::to_string(i);
                hname += "_" + std::to_string(j);
                hname += "_" + std::to_string(k);
                hname += "_qint";
                
                htitle = "Raw FEBEX spectra for SFP " + std::to_string(i);
                htitle += ", board " + std::to_string(j);
                htitle += ", channel " + std::to_string(k);
                htitle += ";Charge value;Counts";
                
                hfebex_qint[i][j][k] = new TH1F( hname.data(), htitle.data(), 16384, 0, qmax_default );
                histlist->Add(hfebex_qint[i][j][k]);
 
                // Calibrated energy
                hname = "febex_" + std::to_string(i);
                hname += "_" + std::to_string(j);
                hname += "_" + std::to_string(k);
                hname += "_cal";
                
                htitle = "Calibrated FEBEX spectra for SFP " + std::to_string(i);
                htitle += ", board " + std::to_string(j);
                htitle += ", channel " + std::to_string(k);
                htitle += ";Energy (keV);Counts per 0.5 keV";
                
                // Assume gamma-ray spectrum
                unsigned int ebins = 8000;
                float emin = -0.25;
                float emax = 4000.0 + emin; // 4 MeV range
                
                // Check if we have particles with low gain preamps (heavy ions, Coulex)
                if( ( cal->FebexType(i,j,k) == "Qshort" && cal->FebexGain(i,j,k) > 50 )
                   || ( cal->FebexType(i,j,k) == "Qint" && cal->FebexGain(i,j,k) > 0.005 ) ) {
                    
                    ebins = 8000.0;
                    emin = -125.0;
                    emax = 2000000.0 + emin; // 2 GeV range
                    
                }
                
                // Check if we have mbs format and then adjust the range
                else if( ( cal->FebexType(i,j,k) == "Qshort" && cal->FebexGain(i,j,k) > 5 )
                   || ( cal->FebexType(i,j,k) == "Qint" && cal->FebexGain(i,j,k) > 0.0005 ) ) {
 
                    ebins = 8000.0;
                    emin = -1.25;
                    emax = 4000.0 + emin; // 4 MeV range
                
                }
                
                // Check if we have particles with high gain preamps (light ions, transfer)
                else if( ( cal->FebexType(i,j,k) == "Qshort" && cal->FebexGain(i,j,k) > 0.1 )
                   || ( cal->FebexType(i,j,k) == "Qint" && cal->FebexGain(i,j,k) > 0.00001 ) ) {
                    
                    ebins = 8000.0;
                    emin = -12.5;
                    emax = 200000.0 + emin; // 200 MeV range
                    
                }
                
                hfebex_cal[i][j][k] = new TH1F( hname.data(), htitle.data(),
                                                ebins, emin, emax );
                histlist->Add(hfebex_cal[i][j][k]);
 
                // MWD energy
                hname = "febex_" + std::to_string(i);
                hname += "_" + std::to_string(j);
                hname += "_" + std::to_string(k);
                hname += "_mwd";
                
                htitle = "MWD FEBEX spectra for SFP " + std::to_string(i);
                htitle += ", board " + std::to_string(j);
                htitle += ", channel " + std::to_string(k);
                htitle += ";Energy (keV);Counts per 0.5 keV";
                
                hfebex_mwd[i][j][k] = new TH1F( hname.data(), htitle.data(), 32768, -0.25, 16383.75 );
                histlist->Add(hfebex_mwd[i][j][k]);
 
            } // k - channel
 
            // Hit ID vs timestamp
            hname  = "hfebex_hit_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            htitle = "Profile of ts versus hit_id in SFP " + std::to_string(i);
            htitle += ", board " + std::to_string(j);
            hfebex_hit[i][j] = new TProfile( hname.data(), htitle.data(), 10800, 0., 108000., "" );
            histlist->Add(hfebex_hit[i][j]);
 
            // Pause events vs timestamp
            hname = "hfebex_pause_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            htitle = "Profile of ts versus pause events in SFP " + std::to_string(i);
            htitle += ", board " + std::to_string(j);
            hfebex_pause[i][j] = new TProfile( hname.data(), htitle.data(), 1000, 0., 10000., "" );
            histlist->Add(hfebex_pause[i][j]);
 
            // Resume events vs timestamp
            hname = "hfebex_resume_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            htitle = "Profile of ts versus resume events in SFP " + std::to_string(i);
            htitle += ", board " + std::to_string(j);
            hfebex_resume[i][j] = new TProfile( hname.data(), htitle.data(), 1000, 0., 10000., "" );
            histlist->Add(hfebex_resume[i][j]);
 
            // External sync trigger vs timestamp
            hname = "hfebex_sync_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            htitle = "Profile of external sync trigger ts versus hit_id";
            hfebex_sync[i][j] = new TProfile( hname.data(), htitle.data(), 10800, 0., 108000., "" );
            histlist->Add(hfebex_sync[i][j]);
 
                
        } // j - board
        
    } // i - SFP
    
    // Resize vectors for DGFs and ADCs
    hdgf_qshort.resize( set->GetNumberOfDgfModules() );
    hdgf_cal.resize( set->GetNumberOfDgfModules() );
    hadc_qshort.resize( set->GetNumberOfAdcModules() );
    hadc_cal.resize( set->GetNumberOfAdcModules() );
    
    // Loop over DGF modules
    for( unsigned int i = 0; i < set->GetNumberOfDgfModules(); ++i ) {
        
        hdgf_qshort[i].resize( set->GetNumberOfDgfChannels() );
        hdgf_cal[i].resize( set->GetNumberOfDgfChannels() );
 
        for( unsigned int j = 0; j < set->GetNumberOfDgfChannels(); ++j ) {
            
            // New directory
            dirname  = maindirname + "dgf_" + std::to_string(i);
            if( !output_file->GetDirectory( dirname.data() ) )
                output_file->mkdir( dirname.data() );
            output_file->cd( dirname.data() );
 
            // Uncalibrated energy 16-bit value
            hname = "dgf_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            hname += "_qshort";
            
            htitle = "Raw DGF spectra for module " + std::to_string(i);
            htitle += ", channel " + std::to_string(j);
            htitle += ";Charge value;Counts";
            
            hdgf_qshort[i][j] = new TH1F( hname.data(), htitle.data(), 16384, 0, 65536 );
            histlist->Add(hdgf_qshort[i][j]);
 
            // Calibrated energy
            hname = "dgf_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            hname += "_cal";
 
            htitle = "Calibrated DGF spectra for module " + std::to_string(i);
            htitle += ", channel " + std::to_string(j);
            htitle += ";Energy (keV);Counts per 0.5 keV";
            
            // Assume gamma-ray spectrum
            unsigned int ebins = 8000;
            float emin = -0.25;
            float emax = 4000.0 + emin; // 4 MeV range
 
            hdgf_cal[i][j] = new TH1F( hname.data(), htitle.data(), ebins, emin, emax );
            histlist->Add(hdgf_cal[i][j]);
 
        } // j - channels
        
    } // i - DGF
    
    // Loop over ADC modules
    for( unsigned int i = 0; i < set->GetNumberOfAdcModules(); ++i ) {
        
        hadc_qshort[i].resize( set->GetMaximumNumberOfAdcChannels() );
        hadc_cal[i].resize( set->GetMaximumNumberOfAdcChannels() );
 
        // New directory
        dirname  = maindirname + "adc_" + std::to_string(i);
        if( !output_file->GetDirectory( dirname.data() ) )
            output_file->mkdir( dirname.data() );
        output_file->cd( dirname.data() );
        
        for( unsigned int j = 0; j < set->GetMaximumNumberOfAdcChannels(); ++j ) {
            
            // Uncalibrated energy 16-bit value
            hname = "adc_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            hname += "_qshort";
            
            htitle = "Raw ADC spectra for module " + std::to_string(i);
            htitle += ", channel " + std::to_string(j);
            htitle += ";Charge value;Counts";
            
            hadc_qshort[i][j] = new TH1F( hname.data(), htitle.data(), 8192, 0, 8192 );
            histlist->Add(hadc_qshort[i][j]);
 
            // Calibrated energy
            hname = "adc_" + std::to_string(i);
            hname += "_" + std::to_string(j);
            hname += "_cal";
            
            htitle = "Calibrated ADC spectra for module " + std::to_string(i);
            htitle += ", channel " + std::to_string(j);
            htitle += ";Energy (keV);Counts per 0.5 keV";
            
            // Assume particle spectrum
            unsigned int ebins = 6000;
            float emin = -1e3;
            float emax = 1.2e6 + emin; // 1.2 GeV range
            
            hadc_cal[i][j] = new TH1F( hname.data(), htitle.data(), ebins, emin, emax );
            histlist->Add(hadc_cal[i][j]);
 
        } // j - channels
        
    } // i - ADC
    
    
    // Hit time plot
    output_file->cd( maindirname.data() );
    hhit_time = new TH1F( "hhit_time", "Hit time distribution", 3200, -16000, 16000 );
    histlist->Add(hhit_time);
 
    // Write once
    output_file->Write();
 
    return;
    
}
 
// Reset histograms in the DataSpy
void MiniballConverter::ResetHists(){
 
    // Loop over the hist list
    TIter next( histlist->MakeIterator() );
    while( TObject *obj = next() ) {
 
        if( obj->InheritsFrom( "TH2" ) )
            ( (TH2*)obj )->Reset("ICESM");
        else if( obj->InheritsFrom( "TH1" ) )
            ( (TH1*)obj )->Reset("ICESM");
 
    }
 
}
 
void MiniballConverter::BuildMbsIndex(){
    
    // Make the index for the MBS info tree
    mbsinfo_tree->BuildIndex( "mbsinfo.GetEventID()" );
 
    return;
    
}
 
bool MiniballConverter::TimeComparator( const std::shared_ptr<MiniballDataPackets> &lhs,
                                        const std::shared_ptr<MiniballDataPackets> &rhs ) {
 
    return lhs->GetTime() < rhs->GetTime();
 
}
 
bool MiniballConverter::MapComparator( const std::pair<unsigned long,double> &lhs,
                                       const std::pair<unsigned long,double> &rhs ) {
 
    return lhs.second < rhs.second;
 
}
 
void MiniballConverter::SortDataVector() {
 
    // Sort the data vector as we go along
    std::sort( data_vector.begin(), data_vector.end(), TimeComparator );
 
}
 
void MiniballConverter::SortDataMap() {
 
    // Sort the data vector as we go along
    std::sort( data_map.begin(), data_map.end(), MapComparator );
 
}
 
unsigned long long int MiniballConverter::SortTree( bool do_sort ){
 
    // Reset the sorted tree so it's empty before we start
    sorted_tree->Reset();
 
    // Get number of data packets
    long long int n_ents = data_vector.size();  // std::vector method
 
    // Check we have entries and build time-ordered index
    if( n_ents && do_sort ) {
        std::cout << "Time ordering " << n_ents << " data items..." << std::endl;
        SortDataMap();
    }
    else if( n_ents == 0 ) return 0;
 
    // Loop on t_raw entries and fill t
    std::cout << "Writing time-ordered data items to the output tree..." << std::endl;
    for( long long int i = 0; i < n_ents; ++i ) {
 
        // Get the data item back from the vector
        unsigned long idx = data_map[i].first;
        write_packet->SetData( data_vector[idx] );
 
        // Fill the sorted tree
        sorted_tree->Fill();
 
        // Progress bar
        bool update_progress = false;
        if( n_ents < 200 )
            update_progress = true;
        else if( i % (n_ents/100) == 0 || i+1 == n_ents )
            update_progress = true;
        
        if( update_progress ) {
            
            // Percent complete
            float percent = (float)(i+1)*100.0/(float)n_ents;
 
            // Progress bar in GUI
            if( _prog_ ) {
                
                prog->SetPosition( percent );
                gSystem->ProcessEvents();
                
            }
            
            // Progress bar in terminal
            std::cout << " " << std::setw(6) << std::setprecision(4);
            std::cout << percent << "%    \r";
            std::cout.flush();
 
        } // progress bar
 
    } // i
 
    return n_ents;
 
}