src/TRestRawSignalRemoveChannelsProcess.cxx

/*************************************************************************
 * This file is part of the REST software framework.                     *
 *                                                                       *
 * Copyright (C) 2016 GIFNA/TREX (University of Zaragoza)                *
 * For more information see http://gifna.unizar.es/trex                  *
 *                                                                       *
 * REST 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.                                   *
 *                                                                       *
 * REST 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 a copy of the GNU General Public License along with   *
 * REST in $REST_PATH/LICENSE.                                           *
 * If not, see http://www.gnu.org/licenses/.                             *
 * For the list of contributors see $REST_PATH/CREDITS.                  *
 *************************************************************************/
 
#include "TRestRawSignalRemoveChannelsProcess.h"
 
using namespace std;
 
ClassImp(TRestRawSignalRemoveChannelsProcess);
 
TRestRawSignalRemoveChannelsProcess::TRestRawSignalRemoveChannelsProcess() { Initialize(); }
 
TRestRawSignalRemoveChannelsProcess::TRestRawSignalRemoveChannelsProcess(const char* configFilename) {
    Initialize();
 
    if (LoadConfigFromFile(configFilename) == -1) {
        LoadDefaultConfig();
    }
 
    PrintMetadata();
}
 
TRestRawSignalRemoveChannelsProcess::~TRestRawSignalRemoveChannelsProcess() { delete fOutputEvent; }
 
void TRestRawSignalRemoveChannelsProcess::LoadDefaultConfig() {
    SetName("removeChannels-Default");
    SetTitle("Default config");
}
 
void TRestRawSignalRemoveChannelsProcess::Initialize() {
    SetSectionName(this->ClassName());
    SetLibraryVersion(LIBRARY_VERSION);
 
    fInputEvent = nullptr;
    fOutputEvent = new TRestRawSignalEvent();
}
 
void TRestRawSignalRemoveChannelsProcess::LoadConfig(const string& configFilename, const string& name) {
    if (LoadConfigFromFile(configFilename, name) == -1) {
        LoadDefaultConfig();
    }
}
 
TRestEvent* TRestRawSignalRemoveChannelsProcess::ProcessEvent(TRestEvent* inputEvent) {
    fInputEvent = dynamic_cast<TRestRawSignalEvent*>(inputEvent);
 
    const auto run = GetRunInfo();
    if (run != nullptr) {
        fInputEvent->InitializeReferences(run);
    }
 
    if (fReadoutMetadata == nullptr) {
        fReadoutMetadata = fInputEvent->GetReadoutMetadata();
    }
 
    if (fReadoutMetadata == nullptr && !fChannelTypes.empty()) {
        cerr << "TRestRawSignalRemoveChannelsProcess::ProcessEvent: readout metadata is null, cannot filter "
                "the process by signal type"
             << endl;
        exit(1);
    }
 
    for (int n = 0; n < fInputEvent->GetNumberOfSignals(); n++) {
        TRestRawSignal* signal = fInputEvent->GetSignal(n);
 
        bool removeSignal = false;
 
        // Check if the channel ID matches any specified for removal
        for (int fChannelId : fChannelIds) {
            if (signal->GetID() == fChannelId) {
                removeSignal = true;
                break;
            }
        }
 
        // Check if the channel type matches any specified for removal
        if (!removeSignal && !fChannelTypes.empty()) {
            const auto signalId = signal->GetSignalID();
            string channelType = fReadoutMetadata->GetTypeForChannelDaqId(signalId);
            if (find(fChannelTypes.begin(), fChannelTypes.end(), channelType) != fChannelTypes.end()) {
                removeSignal = true;
                // Add the channel type and ID to the vector
                if (fChannelTypesToRemove.find(signalId) != fChannelTypesToRemove.end() &&
                    fChannelTypesToRemove.at(signalId) != channelType) {
                    throw runtime_error(
                        "TRestRawSignalRemoveChannelsProcess: Signal was already recorded to have some type, "
                        "but it changed");
                }
                fChannelTypesToRemove[signalId] = channelType;
            }
        }
 
        if (!removeSignal) {
            fOutputEvent->AddSignal(*signal);
        }
 
        // Logging messages
        if (GetVerboseLevel() >= TRestStringOutput::REST_Verbose_Level::REST_Extreme) {
            cout << "Channel ID : " << signal->GetID() << endl;
        }
 
        if (GetVerboseLevel() >= TRestStringOutput::REST_Verbose_Level::REST_Debug && removeSignal) {
            cout << "Removing channel id : " << signal->GetID() << endl;
        }
    }
 
    if (GetVerboseLevel() >= TRestStringOutput::REST_Verbose_Level::REST_Extreme) {
        GetChar();
    }
 
    return fOutputEvent;
}
 
void TRestRawSignalRemoveChannelsProcess::InitFromConfigFile() {
    size_t pos = 0;
 
    string removeChannelDefinition;
    while (!(removeChannelDefinition = GetKEYDefinition("removeChannel", pos)).empty()) {
        Int_t id = StringToInteger(GetFieldValue("id", removeChannelDefinition));
        if (id < 0) {
            continue;
        }
        fChannelIds.push_back(id);
    }
 
    pos = 0;
    while (!(removeChannelDefinition = GetKEYDefinition("removeChannels", pos)).empty()) {
        TVector2 v = StringTo2DVector(GetFieldValue("range", removeChannelDefinition));
        if (v.X() == -1 && v.Y() == -1) {
            continue;
        }
        if (v.X() >= 0 && v.Y() >= 0 && v.Y() > v.X()) {
            for (int n = (Int_t)v.X(); n <= (Int_t)v.Y(); n++) {
                fChannelIds.push_back(n);
            }
        }
    }
 
    pos = 0;
    while (!(removeChannelDefinition = GetKEYDefinition("removeChannels", pos)).empty()) {
        string type = GetFieldValue("type", removeChannelDefinition);
        if (type.empty() || type == "Not defined") {
            continue;
        }
        fChannelTypes.push_back(type);
    }
}
 
void TRestRawSignalRemoveChannelsProcess::PrintMetadata() {
    BeginPrintProcess();
 
    for (int channelId : fChannelIds) {
        RESTMetadata << "Channel id to remove: " << channelId << RESTendl;
    }
 
    if (!fChannelTypes.empty()) {
        RESTMetadata << "Channel types to be removed: ";
        for (const auto& type : fChannelTypes) {
            RESTMetadata << type << " ";
        }
        RESTMetadata << RESTendl;
    }
 
    for (const auto& [signalId, type] : fChannelTypesToRemove) {
        RESTMetadata << "Removing channel of type '" << type << "' and id " << signalId << RESTendl;
    }
 
    EndPrintProcess();
}