L1Menu/src/ReducedSample.cpp

#include "l1menu/ReducedSample.h"

#include <vector>
#include <stdexcept>
#include <fcntl.h>
#include <algorithm>
#include <iostream>
#include <sstream>
#include "l1menu/ReducedEvent.h"
#include "l1menu/FullSample.h"
#include "l1menu/TriggerMenu.h"
#include "l1menu/ITrigger.h"
#include "l1menu/ICachedTrigger.h"
#include "l1menu/L1TriggerDPGEvent.h"
#include "l1menu/IEvent.h"
#include "l1menu/IMenuRate.h"
#include "l1menu/ITriggerRate.h"
#include "l1menu/tools/tools.h"
#include "l1menu/implementation/MenuRateImplementation.h"
#include "protobuf/l1menu.pb.h"
#include <google/protobuf/io/zero_copy_stream_impl.h>
#include <google/protobuf/io/gzip_stream.h>

namespace // unnamed namespace
{
        /** @brief Sentry that closes a Unix file descriptor when it goes out of scope.
         * @author Mark Grimes (mark.grimes@bristol.ac.uk)
         * @date 07/Jun/2013
         */
        class UnixFileSentry
        {
        public:
                UnixFileSentry( int fileDescriptor ) : fileDescriptor_(fileDescriptor) {}
                ~UnixFileSentry() { close(fileDescriptor_); }
        private:
                int fileDescriptor_;
        };

        /** @brief An object that stores pointers to trigger parameters to avoid costly string comparisons.
         *
         * @author Mark Grimes (mark.grimes@bristol.ac.uk)
         * @date 26/Jun/2013
         */
        class CachedTriggerImplementation : public l1menu::ICachedTrigger
        {
        public:
                CachedTriggerImplementation( const l1menu::ReducedSample& sample, const l1menu::ITrigger& trigger )
                {
                        const auto& parameterIdentifiers=sample.getTriggerParameterIdentifiers(trigger);

                        for( const auto& identifier : parameterIdentifiers )
                        {
                                identifiers_.push_back( std::make_pair( identifier.second, &trigger.parameter(identifier.first) ) );
                        }
                }
                virtual bool apply( const l1menu::IEvent& event )
                {
                        // Not happy using a static_cast, but this method is called in many, many loops.
                        // I should probably find out how much faster this is than a dynamic_cast, maybe
                        // it's not even worth it. Anyway, I'm banking that no one will ever pass an
                        // event that wasn't created with the same sample that this proxy was created
                        // with.
                        const l1menu::ReducedEvent* pEvent=static_cast<const l1menu::ReducedEvent*>(&event);
                        for( const auto& identifier : identifiers_ )
                        {
                                if( pEvent->parameterValue(identifier.first) < *identifier.second ) return false;
                        }

                        // If control got this far then all of the thresholds passed, and
                        // I can pass the event.
                        return true;
                }
        protected:
                std::vector< std::pair<l1menu::ReducedEvent::ParameterID,const float*> > identifiers_;
        }; // end of class ReducedSampleCachedTrigger

        float sumWeights( const l1menuprotobuf::Run& run )
        {
                float returnValue=0;
                for( const auto& event : run.event() )
                {
                        if( event.has_weight() ) returnValue+=event.weight();
                        else returnValue+=1;
                }
                return returnValue;
        }
}

namespace l1menu
{
        /** @brief Private members for the ReducedSample class
         *
         * @author Mark Grimes (mark.grimes@bristol.ac.uk)
         * @date 28/May/2013
         */
        class ReducedSamplePrivateMembers
        {
        private:
                l1menu::TriggerMenu mutableTriggerMenu_;
        public:
                ReducedSamplePrivateMembers( const l1menu::ReducedSample& thisObject, const l1menu::TriggerMenu& newTriggerMenu );
                ReducedSamplePrivateMembers( const l1menu::ReducedSample& thisObject, const std::string& filename );
                //void copyMenuToProtobufSample();
                l1menu::ReducedEvent event;
                const l1menu::TriggerMenu& triggerMenu; // External const access to mutableTriggerMenu_
                float eventRate;
                float sumOfWeights;
                l1menuprotobuf::SampleHeader protobufSampleHeader;
                // Protobuf doesn't implement move semantics so I'll use pointers
                std::vector<std::unique_ptr<l1menuprotobuf::Run> > protobufRuns;
                const static int EVENTS_PER_RUN;
                const static char PROTOBUF_MESSAGE_DELIMETER;
                const static std::string FILE_FORMAT_MAGIC_NUMBER;
        };

        const int ReducedSamplePrivateMembers::EVENTS_PER_RUN=20000;
        const char ReducedSamplePrivateMembers::PROTOBUF_MESSAGE_DELIMETER='\n';
        const std::string ReducedSamplePrivateMembers::FILE_FORMAT_MAGIC_NUMBER="l1menuReducedSample";
}

l1menu::ReducedSamplePrivateMembers::ReducedSamplePrivateMembers( const l1menu::ReducedSample& thisObject, const l1menu::TriggerMenu& newTriggerMenu )
        : mutableTriggerMenu_( newTriggerMenu ), event(thisObject), triggerMenu( mutableTriggerMenu_ ), eventRate(1), sumOfWeights(0)
{
        GOOGLE_PROTOBUF_VERIFY_VERSION;

        // I need to copy the details of the trigger menu into the protobuf storage.
        // This means I'm holding a duplicate, but I need it to write the sample to a
        // protobuf file, so I might as well do it now.
        for( size_t triggerNumber=0; triggerNumber<triggerMenu.numberOfTriggers(); ++triggerNumber )
        {
                const l1menu::ITrigger& trigger=triggerMenu.getTrigger(triggerNumber);

                l1menuprotobuf::Trigger* pProtobufTrigger=protobufSampleHeader.add_trigger();
                pProtobufTrigger->set_name( trigger.name() );
                pProtobufTrigger->set_version( trigger.version() );

                // Record all of the parameters. It's not strictly necessary to record the values
                // of the parameters that are recorded for each event, but I might as well so that
                // the trigger menu is loaded exactly as it was saved.
                const auto parameterNames=trigger.parameterNames();
                for( const auto& parameterName : parameterNames )
                {
                        l1menuprotobuf::Trigger_TriggerParameter* pProtobufParameter=pProtobufTrigger->add_parameter();
                        pProtobufParameter->set_name(parameterName);
                        pProtobufParameter->set_value( trigger.parameter(parameterName) );
                }

                // Make a note of the names of the parameters that are recorded for each event. For this
                // I'm just recording the parameters that refer to the thresholds.
                const auto thresholdNames=l1menu::tools::getThresholdNames(trigger);
                for( const auto& thresholdName : thresholdNames ) pProtobufTrigger->add_varying_parameter(thresholdName);

        } // end of loop over triggers

        // Always make sure there is at least one Run ready to be added to
        std::unique_ptr<l1menuprotobuf::Run> pNewRun( new l1menuprotobuf::Run );
        protobufRuns.push_back( std::move( pNewRun ) );

}

l1menu::ReducedSamplePrivateMembers::ReducedSamplePrivateMembers( const l1menu::ReducedSample& thisObject, const std::string& filename )
        : event(thisObject), triggerMenu(mutableTriggerMenu_), eventRate(1), sumOfWeights(0)
{
        GOOGLE_PROTOBUF_VERIFY_VERSION;

        // Open the file with read ability
        int fileDescriptor = open( filename.c_str(), O_RDONLY );
        if( fileDescriptor==0 ) throw std::runtime_error( "ReducedSample initialise from file - couldn't open file" );
        ::UnixFileSentry fileSentry( fileDescriptor ); // Use this as an exception safe way of closing the input file
        google::protobuf::io::FileInputStream fileInput( fileDescriptor );

        // First read the magic number at the start of the file and make sure it
        // matches what I expect. This is uncompressed so I'll wrap it in a block
        // to make sure the CodedInputStream is destructed before creating a new
        // one with gzip input.
        {
                google::protobuf::io::CodedInputStream codedInput( &fileInput );

                // As a read buffer, I'll create a string the correct size (filled with an arbitrary
                // character) and read straight into that.
                std::string readMagicNumber;
                if( !codedInput.ReadString( &readMagicNumber, FILE_FORMAT_MAGIC_NUMBER.size() ) ) throw std::runtime_error( "ReducedSample initialise from file - error reading magic number" );
                if( readMagicNumber!=FILE_FORMAT_MAGIC_NUMBER ) throw std::runtime_error( "ReducedSample - tried to initialise with a file that is not the correct format" );

                google::protobuf::uint32 fileformatVersion;
                if( !codedInput.ReadVarint32( &fileformatVersion ) ) throw std::runtime_error( "ReducedSample initialise from file - error reading file format version" );
                // So far I only have (and ever expect to have) one version of the file
                // format, imaginatively versioned "1". You never know though...
                if( fileformatVersion>1 ) std::cerr << "Warning: Attempting to read a ReducedSample with version " << fileformatVersion << " with code that only knows up to version 1." << std::endl;
        }

        google::protobuf::io::GzipInputStream gzipInput( &fileInput );
        google::protobuf::io::CodedInputStream codedInput( &gzipInput );

        // Disable warnings on this input stream (second parameter, -1). The
        // first parameter is the default. I'll change this if necessary in
        // the loop later.
        size_t totalBytesLimit=67108864;
        codedInput.SetTotalBytesLimit( totalBytesLimit, -1 );

        google::protobuf::uint64 messageSize;

        // Read the size of the header message
        if( !codedInput.ReadVarint64( &messageSize ) ) throw std::runtime_error( "ReducedSample initialise from file - error reading message size for header" );
        google::protobuf::io::CodedInputStream::Limit readLimit=codedInput.PushLimit(messageSize);
        if( !protobufSampleHeader.ParseFromCodedStream( &codedInput ) ) throw std::runtime_error( "ReducedSample initialise from file - some unknown error while reading header" );
        codedInput.PopLimit(readLimit);

        // Keep looping until there is nothing more to be read from the file.
        while( codedInput.ReadVarint64( &messageSize ) )
        {
                readLimit=codedInput.PushLimit(messageSize);

                // Make sure the CodedInputStream doesn't refuse to read the message because it's
                // read too much already. I'll also add an arbitrary 50 on to always make sure
                // I can read the next messageSize if there is one.
                if( gzipInput.ByteCount()+messageSize+50 > totalBytesLimit )
                {
                        totalBytesLimit+=messageSize*5; // Might as well set it a little higher than necessary while I'm at it.
                        codedInput.SetTotalBytesLimit( totalBytesLimit, -1 );
                }
                std::unique_ptr<l1menuprotobuf::Run> pNewRun( new l1menuprotobuf::Run );
                if( !pNewRun->ParseFromCodedStream( &codedInput ) ) throw std::runtime_error( "ReducedSample initialise from file - some unknown error while reading run" );
                protobufRuns.push_back( std::move( pNewRun ) );

                codedInput.PopLimit(readLimit);
        }


        // Always make sure there is at least one Run ready to be added to. Later
        // code assumes there is already a run there.
        if( protobufRuns.empty() )
        {
                std::unique_ptr<l1menuprotobuf::Run> pNewRun( new l1menuprotobuf::Run );
                protobufRuns.push_back( std::move( pNewRun ) );
        }

        // Count up the sum of the weights of all events
        for( const auto& pRun : protobufRuns )
        {
                sumOfWeights+=sumWeights( *pRun );
        }

        // I have all of the information in the protobuf members, but I also need the trigger information
        // in the form of l1menu::TriggerMenu. Copy out the required information.
        for( int triggerNumber=0; triggerNumber<protobufSampleHeader.trigger_size(); ++triggerNumber )
        {
                const l1menuprotobuf::Trigger& inputTrigger=protobufSampleHeader.trigger(triggerNumber);

                mutableTriggerMenu_.addTrigger( inputTrigger.name(), inputTrigger.version() );
                // Get a reference to the trigger I just created
                l1menu::ITrigger& trigger=mutableTriggerMenu_.getTrigger(triggerNumber);

                // Run through all of the parameters and set them to what they were
                // when the sample was made.
                for( int parameterNumber=0; parameterNumber<inputTrigger.parameter_size(); ++parameterNumber )
                {
                        const auto& inputParameter=inputTrigger.parameter(parameterNumber);
                        trigger.parameter(inputParameter.name())=inputParameter.value();
                }

                // I should probably check the threshold names exist. I'll do it another time.
        }

}

l1menu::ReducedSample::ReducedSample( const l1menu::FullSample& originalSample, const l1menu::TriggerMenu& triggerMenu )
        : pImple_( new l1menu::ReducedSamplePrivateMembers( *this, triggerMenu ) )
{
        addSample( originalSample );
        setEventRate( originalSample.eventRate() );
}

l1menu::ReducedSample::ReducedSample( const l1menu::TriggerMenu& triggerMenu )
        : pImple_( new l1menu::ReducedSamplePrivateMembers( *this, triggerMenu ) )
{
        // No operation besides the initialiser list
}

l1menu::ReducedSample::ReducedSample( const std::string& filename )
        : pImple_( new l1menu::ReducedSamplePrivateMembers( *this, filename ) )
{
        // No operation except the initialiser list
}

l1menu::ReducedSample::~ReducedSample()
{
        // No operation. Just need one defined otherwise the default one messes up
        // the unique_ptr deletion because ReducedSamplePrivateMembers isn't
        // defined elsewhere.
}

void l1menu::ReducedSample::addSample( const l1menu::FullSample& originalSample )
{
        l1menuprotobuf::Run* pCurrentRun=pImple_->protobufRuns.back().get();

        for( size_t eventNumber=0; eventNumber<originalSample.numberOfEvents(); ++eventNumber )
        {
                // Split the events up into groups in arbitrary numbers. This is to get around
                // a protobuf aversion to long messages.
                if( pCurrentRun->event_size() >= pImple_->EVENTS_PER_RUN )
                {
                        // Gone over the arbitrary limit, so create a new protobuf Run and start
                        // using that instead.
                        std::unique_ptr<l1menuprotobuf::Run> pNewRun( new l1menuprotobuf::Run );
                        pImple_->protobufRuns.push_back( std::move( pNewRun ) );
                        pCurrentRun=pImple_->protobufRuns.back().get();
                }

                const l1menu::L1TriggerDPGEvent& event=originalSample.getFullEvent( eventNumber );
                l1menuprotobuf::Event* pProtobufEvent=pCurrentRun->add_event();
                if( event.weight()!=1 ) pProtobufEvent->set_weight( event.weight() );

                // Loop over all of the triggers
                for( size_t triggerNumber=0; triggerNumber<pImple_->triggerMenu.numberOfTriggers(); ++triggerNumber )
                {
                        std::unique_ptr<l1menu::ITrigger> pTrigger=pImple_->triggerMenu.getTriggerCopy(triggerNumber);
                        std::vector<std::string> thresholdNames=l1menu::tools::getThresholdNames(*pTrigger);

                        try
                        {
                                l1menu::tools::setTriggerThresholdsAsTightAsPossible( event, *pTrigger, 0.001 );
                                // Set all of the parameters to match the thresholds in the trigger
                                for( const auto& thresholdName : thresholdNames )
                                {
                                        pProtobufEvent->add_threshold( pTrigger->parameter(thresholdName) );
                                }
                        }
                        catch( std::exception& error )
                        {
                                // setTriggerThresholdsAsTightAsPossible() couldn't find thresholds so record
                                // -1 for everything.
                                // Range based for loop gives me a warning because I don't use the thresholdName.
                                for( size_t index=0; index<thresholdNames.size(); ++index ) pProtobufEvent->add_threshold(-1);
                        } // end of try block that sets the trigger thresholds

                } // end of loop over triggers

                pImple_->sumOfWeights+=event.weight();
        } // end of loop over events
}

void l1menu::ReducedSample::saveToFile( const std::string& filename ) const
{
        // Open the file. Parameters are filename, write ability and create, rw-r--r-- permissions.
        int fileDescriptor = open( filename.c_str(), O_WRONLY | O_CREAT, 0644 );
        if( fileDescriptor==0 ) throw std::runtime_error( "ReducedSample save to file - couldn't open file" );
        ::UnixFileSentry fileSentry( fileDescriptor ); // Use this as an exception safe way of closing the output file

        // Setup the protobuf file handlers
        google::protobuf::io::FileOutputStream fileOutput( fileDescriptor );

        // I want the magic number and file format identifier uncompressed, so
        // I'll write those before switching to using gzipped output.
        { // Block to make sure codedOutput is destructed before the gzip version is created
                google::protobuf::io::CodedOutputStream codedOutput( &fileOutput );

                // Write a magic number at the start of all files
                codedOutput.WriteString( pImple_->FILE_FORMAT_MAGIC_NUMBER );
                // Write an integer that specifies what version of the file format I'm using. I
                // have no intention of changing the format but I might as well keep the option
                // open.
                codedOutput.WriteVarint32( 1 );
        }

        google::protobuf::io::GzipOutputStream gzipOutput( &fileOutput );
        google::protobuf::io::CodedOutputStream codedOutput( &gzipOutput );

        // Write the size of the header message into the file...
        codedOutput.WriteVarint64( pImple_->protobufSampleHeader.ByteSize() );
        // ...and then write the header
        pImple_->protobufSampleHeader.SerializeToCodedStream( &codedOutput );

        // Now go through each of the runs and do the same for those
        for( const auto& pRun : pImple_->protobufRuns )
        {
                codedOutput.WriteVarint64( pRun->ByteSize() );
                pRun->SerializeToCodedStream( &codedOutput );
        }

}

size_t l1menu::ReducedSample::numberOfEvents() const
{
        size_t numberOfEvents=0;
        for( const auto& pRun : pImple_->protobufRuns ) numberOfEvents+=pRun->event_size();
        return numberOfEvents;
}

const l1menu::TriggerMenu& l1menu::ReducedSample::getTriggerMenu() const
{
        return pImple_->triggerMenu;
}

bool l1menu::ReducedSample::containsTrigger( const l1menu::ITrigger& trigger, bool allowOlderVersion ) const
{
        // Loop over all of the triggers in the menu, and see if there is one
        // where the name and version match.
        for( size_t triggerNumber=0; triggerNumber<pImple_->triggerMenu.numberOfTriggers(); ++triggerNumber )
        {
                const l1menu::ITrigger& triggerInMenu=pImple_->triggerMenu.getTrigger(triggerNumber);
                if( triggerInMenu.name()!=trigger.name() ) continue;
                if( allowOlderVersion )
                {
                        if( triggerInMenu.version()>trigger.version() ) continue;
                }
                else
                {
                        if( triggerInMenu.version()!=trigger.version() ) continue;
                }

                // If control got this far then there is a trigger with the required name
                // and sufficient version. I now need to check all of the non threshold parameters
                // to make sure they match, i.e. make sure the ReducedSample was made with the same
                // eta cuts or whatever.
                // I don't care if the thresholds don't match because that's what's stored in the
                // ReducedSample.
                std::vector<std::string> parameterNames=l1menu::tools::getNonThresholdParameterNames( trigger );
                bool allParametersMatch=true;
                for( const auto& parameterName : parameterNames )
                {
                        if( trigger.parameter(parameterName)!=triggerInMenu.parameter(parameterName) ) allParametersMatch=false;
                }

                if( allParametersMatch ) return true;
        } // end of loop over triggers

        // If control got this far then no trigger was found that matched
        return false;
}

const std::map<std::string,size_t> l1menu::ReducedSample::getTriggerParameterIdentifiers( const l1menu::ITrigger& trigger, bool allowOlderVersion ) const
{
        std::map<std::string,size_t> returnValue;

        // Need to find out how many parameters there are for each event. Basically the sum
        // of the number of thresholds for all triggers.
        size_t parameterNumber=0;
        bool triggerWasFound=true;
        for( size_t triggerNumber=0; triggerNumber<pImple_->triggerMenu.numberOfTriggers(); ++triggerNumber )
        {
                const l1menu::ITrigger& triggerInMenu=pImple_->triggerMenu.getTrigger(triggerNumber);

                triggerWasFound=true; // Set to true, then back to false if any of the tests fail
                // See if this trigger in the menu is the same as the one passed as a parameter
                if( triggerInMenu.name()!=trigger.name() ) triggerWasFound=false;
                if( allowOlderVersion )
                {
                        if( triggerInMenu.version()>trigger.version() ) triggerWasFound=false;
                }
                else
                {
                        if( triggerInMenu.version()!=trigger.version() ) triggerWasFound=false;
                }

                // If control got this far then there is a trigger with the required name
                // and sufficient version. I now need to check all of the non threshold parameters
                // to make sure they match, i.e. make sure the ReducedSample was made with the same
                // eta cuts or whatever.
                // I don't care if the thresholds don't match because that's what's stored in the
                // ReducedSample.
                if( triggerWasFound ) // Trigger can still fail, but no point doing this check if it already has
                {
                        std::vector<std::string> parameterNames=l1menu::tools::getNonThresholdParameterNames( trigger );
                        for( const auto& parameterName : parameterNames )
                        {
                                if( trigger.parameter(parameterName)!=triggerInMenu.parameter(parameterName) ) triggerWasFound=false;
                        }
                }

                std::vector<std::string> thresholdNames=l1menu::tools::getThresholdNames(triggerInMenu);
                if( triggerWasFound )
                {
                        for( const auto& thresholdName : thresholdNames )
                        {
                                returnValue[thresholdName]=parameterNumber;
                                ++parameterNumber;
                        }
                        break;
                }
                else parameterNumber+=thresholdNames.size();
        }

        // There could conceivably be a trigger that was found but has no thresholds
        // (I guess - it would be a pretty pointless trigger though). To indicate the
        // difference between that and a trigger that wasn't found I'll respectively
        // return the empty vector or throw an exception.
        if( !triggerWasFound ) throw std::runtime_error( "l1menu::ReducedSample::getTriggerParameterIdentifiers() called for a trigger that was not used to create the sample - "+trigger.name() );

        return returnValue;
}

const l1menu::IEvent& l1menu::ReducedSample::getEvent( size_t eventNumber ) const
{
        for( const auto& pRun : pImple_->protobufRuns )
        {
                if( eventNumber<static_cast<size_t>(pRun->event_size()) )
                {
                        pImple_->event.pProtobufEvent_=pRun->mutable_event(eventNumber);
                        return pImple_->event;
                }
                // Event must be in a later run, so reduce the number by how many events
                // were in this run and look again.
                eventNumber-=pRun->event_size();
        }

        // Should always find the event before getting to this point, so throw an
        // exception if this happens.
        throw std::runtime_error( "ReducedSample::getEvent(eventNumber) was asked for an invalid eventNumber" );
}

std::unique_ptr<l1menu::ICachedTrigger> l1menu::ReducedSample::createCachedTrigger( const l1menu::ITrigger& trigger ) const
{
        return std::unique_ptr<l1menu::ICachedTrigger>( new CachedTriggerImplementation(*this,trigger) );
}

float l1menu::ReducedSample::eventRate() const
{
        return pImple_->eventRate;
}

void l1menu::ReducedSample::setEventRate( float rate )
{
        pImple_->eventRate=rate;
}

float l1menu::ReducedSample::sumOfWeights() const
{
        return pImple_->sumOfWeights;
}

std::unique_ptr<const l1menu::IMenuRate> l1menu::ReducedSample::rate( const l1menu::TriggerMenu& menu ) const
{
        // TODO make sure the TriggerMenu is valid for this sample
        return std::unique_ptr<const l1menu::IMenuRate>( new l1menu::implementation::MenuRateImplementation( menu, *this ) );
}
Revision:	1.3
Committed:	Wed Jul 24 11:48:55 2013 UTC (11 years, 9 months ago) by grimes
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.2:	+1 -47 lines
Log Message:	Big commit of lots of changes before migrating to Git.