APRILContentApi.h

Go to the documentation of this file.

/*
 *
 * APRILContentApi.h header template automatically generated by a class generator
 * Creation date : mar. avr. 28 2015
 *
 * This file is part of APRILContent libraries.
 * 
 * APRILContent 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.
 * based upon these libraries are permitted. Any copy of these libraries
 * must include this copyright notice.
 * 
 * APRILContent 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 received a copy of the GNU General Public License
 * along with APRILContent.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * @author Remi Ete
 * @copyright CNRS , IPNL
 */


#ifndef APRILCONTENTAPI_H
#define APRILCONTENTAPI_H

#include "Api/PandoraContentApi.h"
#include "APRILApi/APRILInputTypes.h"
#include "Objects/Cluster.h"
#include "APRILObjects/Cluster.h"
#include "APRILApi/ObjectFactories.h"

namespace april_content { class CaloHit; class Connector; }

// logging macro
#define APRIL_LOG( message ) if( PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo() ) std::cout << message


class APRILContentApi 
{
public:
    class CaloHitMetadata : public PandoraContentApi::CaloHit::Metadata
    {
    public:
        pandora::InputFloat             m_surroundingEnergy;
        pandora::InputFloat             m_density;
    };

    static pandora::StatusCode AlterMetadata(const pandora::Algorithm &algorithm, const april_content::CaloHit *const pCaloHit, const CaloHitMetadata &caloHitMetadata);

public:
    // Connector related Api

    static bool IsConnected(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2);

    static bool IsConnected(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2, april_content::ConnectorDirection direction);

    static pandora::StatusCode FindConnector(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2, const april_content::Connector *&pConnector);

    static pandora::StatusCode FindConnector(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2, april_content::ConnectorDirection direction,
            const april_content::Connector *&pConnector);

    static bool HasAnyConnection(const april_content::CaloHit *const pCaloHit);

    static const april_content::ConnectorList &GetConnectorList(const april_content::CaloHit *const pCaloHit);

    static const april_content::ConnectorList &GetConnectorList(const april_content::CaloHit *const pCaloHit, april_content::ConnectorDirection direction);

    static bool IsSeed(const april_content::CaloHit *const pCaloHit);

    static bool IsLeaf(const april_content::CaloHit *const pCaloHit);

    static pandora::StatusCode Connect(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2,
            april_content::ConnectorDirection direction, float referenceLength = 1.f, unsigned int creationStage = -1);

    static pandora::StatusCode Connect(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2,
            april_content::ConnectorDirection direction, const april_content::Connector *&pConnector, float referenceLength = 1.f,
            unsigned int creationStage = -1);

    static pandora::StatusCode RemoveConnectionBetween(const april_content::CaloHit *const pCaloHit1, const april_content::CaloHit *const pCaloHit2);

    static pandora::StatusCode RemoveAndDeleteConnector(const april_content::Connector *const pConnector);

    static pandora::StatusCode RemoveAndDeleteAllConnections(const april_content::CaloHit *const pCaloHit);

    // calo hit related Api

    static pandora::StatusCode Tag(const april_content::CaloHit *const pCaloHit, april_content::HitTag tag, bool value);

    static bool IsTagged(const april_content::CaloHit *const pCaloHit, april_content::HitTag tag);

    static pandora::StatusCode ResetTags(const april_content::CaloHit *const pCaloHit);

    static pandora::StatusCode InitializeReclustering(const pandora::Algorithm &algorithm, const pandora::TrackList &inputTrackList,
            const pandora::ClusterList &inputClusterList, std::string &originalClustersListName);

    static pandora::StatusCode RunReclusteringAlgorithm(const pandora::Algorithm &algorithm, const std::string &clusteringAlgorithmName,
            const pandora::ClusterList *&pNewClusterList, std::string &newClusterListName);

    static pandora::StatusCode PostRunReclusteringAlgorithm(const pandora::Algorithm &algorithm, const std::string &clusterListName);

    static pandora::StatusCode EndReclustering(const pandora::Algorithm &algorithm, const std::string &selectedClusterListName);

    static pandora::StatusCode Create(const pandora::Algorithm &algorithm, 
        PandoraContentApi::Cluster::Parameters clusterParameters, const pandora::Cluster *&pCluster);

    static pandora::StatusCode CreateAPRILCluster(const pandora::Algorithm &algorithm, 
        PandoraContentApi::Cluster::Parameters clusterParameters, const pandora::Cluster *&pCluster);

    static pandora::StatusCode AddToCluster(const pandora::Algorithm &algorithm, 
        const pandora::Cluster *const pCluster, const pandora::CaloHitList *const pCaloHitList);

    static pandora::StatusCode MergeAndDeleteClusters(const pandora::Algorithm &algorithm, 
        const pandora::Cluster *const pClusterToEnlarge, const pandora::Cluster *pClusterToDelete);

    static pandora::StatusCode RemoveFromCluster(const pandora::Algorithm &algorithm, 
        const pandora::Cluster *const pCluster, const pandora::CaloHit *const pCaloHit);

    static pandora::StatusCode RemoveConnector(const april_content::Connector *const pConnector);

    template <typename T>
    static T *Modifiable(const T *const pT);

private:
    static april_content::ClusterFactory m_clusterFactory;
}; 


#endif  //  APRILCONTENTAPI_H