__init__.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
 
 
 
import basf2 as b2
 
 
def add_svd_reconstruction(path, isROIsimulation=False, createRecoDigits=False, applyMasking=False):
    """
    Adds the SVD reconstruction to the path.
 
    Reconstruction starts with :ref:`SVDShaperDigits<svdshapers>`
    and :ref:`SVDEventInfo<svdeventinfo>` and provides
    :ref:`SVDClusters<svdclusters>` and :ref:`SVDSpacePoints<svdsps>`.
 
    @param path: add the modules to this basf2 path.
    @param isROIsimulation: SVD reconstruction can be run during simulation\
    in order to simulate the PXD Data Reduction with ROI finding.
    @param createRecoDigits: if True, :ref:`SVDRecoDigits<svdrecos>` are created.
    @param applyMasking: if True, hot strips found in :ref:`SVDHotStripsCalibration<svdhotstrips>` are masked.
    """
 
    # setup the event level tracking info to log errors and stuff
    if isROIsimulation:
        nameTrackingInfoModule = "RegisterEventLevelTrackingInfo__ROI"
        nameEventTrackingInfo = "EventLevelTrackingInfo__ROI"
        nameSVDTrackingEventLevelMdstInfoFiller = "SVDTrackingEventLevelMdstInfoFiller__ROI"
    else:
        nameTrackingInfoModule = "RegisterEventLevelTrackingInfo"
        nameEventTrackingInfo = "EventLevelTrackingInfo"
        nameSVDTrackingEventLevelMdstInfoFiller = "SVDTrackingEventLevelMdstInfoFiller"
 
    if nameTrackingInfoModule not in path:
        registerEventlevelTrackingInfo = b2.register_module('RegisterEventLevelTrackingInfo')
        registerEventlevelTrackingInfo.set_name(nameTrackingInfoModule)
        registerEventlevelTrackingInfo.param('EventLevelTrackingInfoName', nameEventTrackingInfo)
        path.add_module(registerEventlevelTrackingInfo)
 
    if(isROIsimulation):
        clusterizerName = '__ROISVDClusterizer'
        timeGroupComposerName = '__ROISVDTimeGrouping'
        recocreatorName = '__ROISVDRecoDigitCreator'
        dataFormatName = '__ROISVDDataFormat'
        # recoDigitsName = '__ROIsvdRecoDigits'
        clustersName = '__ROIsvdClusters'
        shaperDigitsName = ""
        missingAPVsClusterCreatorName = '__ROISVDMissingAPVsClusterCreator'
    else:
        clusterizerName = 'SVDClusterizer'
        timeGroupComposerName = 'SVDTimeGrouping'
        recocreatorName = 'SVDRecoDigitCreator'
        dataFormatName = 'SVDDataFormat'
        # recoDigitsName = ""
        clustersName = ""
        shaperDigitsName = ""
        missingAPVsClusterCreatorName = 'SVDMissingAPVsClusterCreator'
 
        # mask HotStrips from SVDHotStripsCalibration payloads
    if(applyMasking):
        if(isROIsimulation):
            shaperDigitsName = '__ROISVDShaperDigitsUnmasked'
            maskingName = '__ROISVDStripMasking'
        else:
            shaperDigitsName = 'SVDShaperDigitsUnmasked'
            maskingName = 'SVDStripMasking'
 
        if maskingName not in [e.name() for e in path.modules()]:
            masking = b2.register_module('SVDStripMasking')
            masking.set_name(maskingName)
            masking.param('ShaperDigitsUnmasked', shaperDigitsName)
            path.add_module(masking)
 
    # data format check NOT appended
    if dataFormatName not in [e.name() for e in path.modules()]:
        dataFormat = b2.register_module('SVDDataFormatCheck')
        dataFormat.param('ShaperDigits', shaperDigitsName)
 
    if clusterizerName not in [e.name() for e in path.modules()]:
        clusterizer = b2.register_module('SVDClusterizer')
        clusterizer.set_name(clusterizerName)
        clusterizer.param('ShaperDigits', shaperDigitsName)
        clusterizer.param('Clusters', clustersName)
        path.add_module(clusterizer)
 
    if missingAPVsClusterCreatorName not in [e.name() for e in path.modules()]:
        missingAPVCreator = b2.register_module('SVDMissingAPVsClusterCreator')
        missingAPVCreator.set_name(missingAPVsClusterCreatorName)
        path.add_module(missingAPVCreator)
 
    if nameSVDTrackingEventLevelMdstInfoFiller not in path:
        svdTrackingEventLevelMdstInfoFiller = b2.register_module('SVDTrackingEventLevelMdstInfoFiller')
        svdTrackingEventLevelMdstInfoFiller.set_name(nameSVDTrackingEventLevelMdstInfoFiller)
        svdTrackingEventLevelMdstInfoFiller.param('EventLevelTrackingInfoName', nameEventTrackingInfo)
        svdTrackingEventLevelMdstInfoFiller.param('svdClustersName', clustersName)
        path.add_module(svdTrackingEventLevelMdstInfoFiller)
 
    if timeGroupComposerName not in [e.name() for e in path.modules()]:
        svdTimeGrouping = b2.register_module('SVDTimeGrouping')
        svdTimeGrouping.set_name(timeGroupComposerName)
        svdTimeGrouping.param('SVDClusters', clustersName)
        path.add_module(svdTimeGrouping)
 
    # Add SVDSpacePointCreator
    add_svd_SPcreation(path, isROIsimulation)
 
    if createRecoDigits and not isROIsimulation:
        # Add SVDRecoDigit creator module if not ROI simulation
        # useful for SVD performance studies
        add_svd_create_recodigits(path, recocreatorName, shaperDigitsName)
 
 
def add_svd_create_recodigits(path, recocreatorName="SVDRecoDigitCreator", shaperDigitsName=""):
    """
    Adds the strip reconstruction to the path.
 
    Produce :ref:`SVDRecoDigits<svdrecos>` from :ref:`SVDShaperDigits<svdshapers>`.
 
    @param path: add the modules to this basf2 path.
    @param recocreatorName: name of the module.
    @param shaperDigitsName: name of the SVDShaperDigits StoreArray.
 """
 
    if recocreatorName not in [e.name() for e in path.modules()]:
        recoDigitCreator = b2.register_module('SVDRecoDigitCreator')
        recoDigitCreator.param('ShaperDigits', shaperDigitsName)
        recoDigitCreator.param('timeAlgorithm6Samples', "CoG3")
        recoDigitCreator.param('timeAlgorithm3Samples', "CoG3")
        recoDigitCreator.param('chargeAlgorithm6Samples', "MaxSample")
        recoDigitCreator.param('chargeAlgorithm3Samples', "MaxSample")
        recoDigitCreator.param('useDB', False)
        path.add_module(recoDigitCreator)
 
 
def add_rel5_svd_reconstruction(path, isROIsimulation=False, applyMasking=False):
    """
    Adds the old (up to release-05) SVD recontruction to the path.
 
    Reconstruction starts with :ref:`SVDShaperDigits<svdshapers>` and
    :ref:`SVDEventInfo<svdeventinfo>` and provides :ref:`SVDClusters<svdclusters>`
    and :ref:`SVDSpacePoints<svdsps>`.
 
    @param path: add the modules to this basf2 path.
    @param isROIsimulation: SVD reconstruction can be run during simulation\
    in order to simulate the PXD Data Reduction with ROI finding.
    @param applyMasking: if True, hot strips found in :ref:`SVDHotStripsCalibration<svdhotstrips>` are masked.
    """
 
    # setup the event level tracking info to log errors and stuff
    if isROIsimulation:
        nameTrackingInfoModule = "RegisterEventLevelTrackingInfo__ROI"
        nameEventTrackingInfo = "EventLevelTrackingInfo__ROI"
        nameSVDTrackingEventLevelMdstInfoFiller = "SVDTrackingEventLevelMdstInfoFiller__ROI"
    else:
        nameTrackingInfoModule = "RegisterEventLevelTrackingInfo"
        nameEventTrackingInfo = "EventLevelTrackingInfo"
        nameSVDTrackingEventLevelMdstInfoFiller = "SVDTrackingEventLevelMdstInfoFiller"
 
    if nameTrackingInfoModule not in path:
        registerEventlevelTrackingInfo = b2.register_module('RegisterEventLevelTrackingInfo')
        registerEventlevelTrackingInfo.set_name(nameTrackingInfoModule)
        registerEventlevelTrackingInfo.param('EventLevelTrackingInfoName', nameEventTrackingInfo)
        path.add_module(registerEventlevelTrackingInfo)
 
    if(isROIsimulation):
        fitterName = '__ROISVDCoGTimeEstimator'
        clusterizerName = '__ROISVDSimpleClusterizer'
        timeGroupComposerName = '__ROISVDTimeGrouping'
        dataFormatName = '__ROISVDDataFormat'
        clusterName = '__ROIsvdClusters'
        recoDigitsName = '__ROIsvdRecoDigits'
        shaperDigitsName = ""
        missingAPVsClusterCreatorName = '__ROISVDMissingAPVsClusterCreator'
    else:
        fitterName = 'SVDCoGTimeEstimator'
        clusterizerName = 'SVDSimpleClusterizer'
        timeGroupComposerName = 'SVDTimeGrouping'
        dataFormatName = 'SVDDataFormat'
        clusterName = ""
        recoDigitsName = ""
        shaperDigitsName = ""
        missingAPVsClusterCreatorName = 'SVDMissingAPVsClusterCreator'
 
        # add strip masking if needed
    if(applyMasking):
        if(isROIsimulation):
            shaperDigitsName = '__ROISVDShaperDigitsUnmasked'
            maskingName = '__ROISVDStripMasking'
        else:
            shaperDigitsName = 'SVDShaperDigitsUnmasked'
            maskingName = 'SVDStripMasking'
 
        if maskingName not in [e.name() for e in path.modules()]:
            masking = b2.register_module('SVDStripMasking')
            masking.set_name(maskingName)
            masking.param('ShaperDigitsUnmasked', shaperDigitsName)
            path.add_module(masking)
 
    if dataFormatName not in [e.name() for e in path.modules()]:
        dataFormat = b2.register_module('SVDDataFormatCheck')
        dataFormat.param('ShaperDigits', shaperDigitsName)
 
    if fitterName not in [e.name() for e in path.modules()]:
        fitter = b2.register_module('SVDCoGTimeEstimator')
        fitter.set_name(fitterName)
        fitter.param('RecoDigits', recoDigitsName)
        path.add_module(fitter)
 
    if clusterizerName not in [e.name() for e in path.modules()]:
        clusterizer = b2.register_module('SVDSimpleClusterizer')
        clusterizer.set_name(clusterizerName)
        clusterizer.param('RecoDigits', recoDigitsName)
        clusterizer.param('Clusters', clusterName)
        clusterizer.param('useDB', True)
        path.add_module(clusterizer)
 
    if missingAPVsClusterCreatorName not in [e.name() for e in path.modules()]:
        missingAPVCreator = b2.register_module('SVDMissingAPVsClusterCreator')
        missingAPVCreator.set_name(missingAPVsClusterCreatorName)
        path.add_module(missingAPVCreator)
 
    if nameSVDTrackingEventLevelMdstInfoFiller not in path:
        svdTrackingEventLevelMdstInfoFiller = b2.register_module('SVDTrackingEventLevelMdstInfoFiller')
        svdTrackingEventLevelMdstInfoFiller.set_name(nameSVDTrackingEventLevelMdstInfoFiller)
        svdTrackingEventLevelMdstInfoFiller.param('EventLevelTrackingInfoName', nameEventTrackingInfo)
        svdTrackingEventLevelMdstInfoFiller.param('svdClustersName', clusterName)
        path.add_module(svdTrackingEventLevelMdstInfoFiller)
 
    if timeGroupComposerName not in [e.name() for e in path.modules()]:
        svdTimeGrouping = b2.register_module('SVDTimeGrouping')
        svdTimeGrouping.set_name(timeGroupComposerName)
        svdTimeGrouping.param('SVDClusters', clusterName)
        path.add_module(svdTimeGrouping)
 
    # Add SVDSpacePointCreator
    add_svd_SPcreation(path, isROIsimulation)
 
 
def add_svd_simulation(path, useConfigFromDB=False, daqMode=2, relativeShift=9):
    """
    Adds the SVD simulation to the path.
 
    Simulation ends with :ref:`SVDShaperDigits<svdshapers>` and :ref:`SVDEventInfo<svdeventinfo>`.
 
    @param path: add the modules to this basf2 path.
    @param useConfigFromDB: if True, read the SVD configuration from :ref:`SVDGlobalConfigParameters<svdglobalconfig>`.
    @param daqMode: = 2 for the default 6-sample mode, = 1 for the 3-sample mode, = 3 for the 3-mixed-6 sample mode.
    @param relativeShift: relative time shift between the 3-sample and the 6-sample mode in units of 1/4 of APV clock.\
    If ``useConfigFromDB`` is True, the value of this parameter is overwritten.
    """
 
    svdevtinfoset = b2.register_module("SVDEventInfoSetter")
    svdevtinfoset.param("useDB", useConfigFromDB)
    path.add_module(svdevtinfoset)
 
    digitizer = b2.register_module('SVDDigitizer')
    path.add_module(digitizer)
 
    if not useConfigFromDB:
        if daqMode != 2 and daqMode != 1 and daqMode != 3:
            message = 'OOPS the acquisition mode that you want to simulate is not available.\n' \
                      'Please choose among daqMode = 2 (6-sample) and daqMode = 1 (3-sample).'
            b2.B2FATAL(message)
 
        # TODO add check of relative shift value
        svdevtinfoset.param("daqMode", daqMode)
        svdevtinfoset.param("relativeShift", relativeShift)
 
 
def add_svd_unpacker(path):
    """
    Adds the SVD Unpacker to the path.
 
    The unpacker produces :ref:`SVDShaperDigits<svdshapers>` and :ref:`SVDEventInfo<svdeventinfo>`.
 
    @param path: add the modules to this basf2 path.
    """
 
    unpacker = b2.register_module('SVDUnpacker')
    path.add_module(unpacker)
 
 
def add_svd_unpacker_simulate3sampleDAQ(path, latencyShift=-1, relativeShift=-1):
    """
    Adds the SVD Unpacker to the path, emulating the 3-sample mode from the 6-sample mode.
 
    @param path: add the modules to this basf2 path.
    @param latencyShift: relative time shift between the 3-sample and the 6-sample mode, in APV clocks.\
                         0 <= latencyShift <=3
    @param relativeShift: relative time shift between the 3-sample and the 6-sample mode, in units of 1/4 of APV clock.\
                         0 <= relativeShift <=12
 
    .. warning:: at least one between ``relativeShift`` and ``latencyShift`` should be set (different from -1).
    """
 
    if relativeShift != -1 and latencyShift != -1:
        b2.B2FATAL("OOPS please choose only one between relativeShift and latencyShift. Exiting now.")
 
    unpacker = b2.register_module('SVDUnpacker')
    unpacker.param("SVDEventInfo", "SVDEventInfoOriginal")
    unpacker.param("svdShaperDigitListName", "SVDShaperDigitsOriginal")
    path.add_module(unpacker)
 
    # emulate the 3-sample acquisition
    emulator = b2.register_module("SVD3SamplesEmulator")
    emulator.param("SVDEventInfo", "SVDEventInfoOriginal")
    emulator.param("SVDShaperDigits", "SVDShaperDigitsOriginal")
    if latencyShift == -1:
        emulator.param("chooseStartingSample", False)
    else:
        emulator.param("chooseStartingSample", True)
        if latencyShift < 0 or latencyShift > 3:
            b2.B2FATAL("the latencyShift must be an integer >=0 and <= 3")
        else:
            emulator.param("StartingSample", latencyShift)
 
    if relativeShift == -1:
        emulator.param("chooseRelativeShift", False)
    else:
        emulator.param("chooseRelativeShift", True)
        if relativeShift < 0 or relativeShift > 12:
            b2.B2FATAL("the relativeShift must be an integer >=0 and <= 12")
        else:
            emulator.param("relativeShift", relativeShift)
 
    emulator.param("outputSVDEventInfo", "SVDEventInfo")
    emulator.param("outputSVDShaperDigits", "SVDShaperDigits3SampleAll")
    path.add_module(emulator)
 
    # emulate online zero-suppression
    zsonline = b2.register_module("SVDZeroSuppressionEmulator")
    zsonline.param("ShaperDigits", "SVDShaperDigits3SampleAll")
    zsonline.param("ShaperDigitsIN", "SVDShaperDigits")
    path.add_module(zsonline)
 
 
def add_svd_packer(path):
    """
    Adds the SVD Packer to the path.
 
    @param path: add the modules to this basf2 path.
    """
 
    packer = b2.register_module('SVDPacker')
    path.add_module(packer)
 
 
def add_svd_SPcreation(path, isROIsimulation=False):
    """
    Adds the SVD SpacePoint Creator to the path.
 
    @param path: add the modules to this basf2 path.
    @param isROIsimulation: SVD reconstruction can be run during simulation\
    in order to simulate the PXD Data Reduction with ROI finding.
    """
 
    # register EventTrackingInfo
    if isROIsimulation:
        nameTrackingInfoModule = "RegisterEventLevelTrackingInfo__ROI"
        nameEventTrackingInfo = "EventLevelTrackingInfo__ROI"
    else:
        nameTrackingInfoModule = "RegisterEventLevelTrackingInfo"
        nameEventTrackingInfo = "EventLevelTrackingInfo"
 
    if nameTrackingInfoModule not in path:
        registerEventlevelTrackingInfo = b2.register_module('RegisterEventLevelTrackingInfo')
        registerEventlevelTrackingInfo.set_name(nameTrackingInfoModule)
        registerEventlevelTrackingInfo.param('EventLevelTrackingInfoName', nameEventTrackingInfo)
        path.add_module(registerEventlevelTrackingInfo)
 
    if(isROIsimulation):
        svdSPCreatorName = '__ROISVDSpacePointCreator'
        svd_clusters = '__ROIsvdClusters'
        nameSPs = 'SVDSpacePoints__ROI'
    else:
        svdSPCreatorName = 'SVDSpacePointCreator'
        svd_clusters = ''
        nameSPs = 'SVDSpacePoints'
 
    if svdSPCreatorName not in [e.name() for e in path.modules()]:
        spCreatorSVD = b2.register_module('SVDSpacePointCreator')
        spCreatorSVD.set_name(svdSPCreatorName)
        spCreatorSVD.param('NameOfInstance', 'SVDSpacePoints')
        spCreatorSVD.param('SpacePoints', nameSPs)
        spCreatorSVD.param('SVDClusters', svd_clusters)
        spCreatorSVD.param('EventLevelTrackingInfoName', nameEventTrackingInfo)
        path.add_module(spCreatorSVD)