CompositeJetStructure.hh

00001 //STARTHEADER
00002 // $Id: CompositeJetStructure.hh 1985 2011-03-09 22:26:40Z soyez $
00003 //
00004 // Copyright (c) 2005-2011, Matteo Cacciari, Gavin Salam and Gregory Soyez
00005 //
00006 //----------------------------------------------------------------------
00007 // This file is part of FastJet.
00008 //
00009 //  FastJet is free software; you can redistribute it and/or modify
00010 //  it under the terms of the GNU General Public License as published by
00011 //  the Free Software Foundation; either version 2 of the License, or
00012 //  (at your option) any later version.
00013 //
00014 //  The algorithms that underlie FastJet have required considerable
00015 //  development and are described in hep-ph/0512210. If you use
00016 //  FastJet as part of work towards a scientific publication, please
00017 //  include a citation to the FastJet paper.
00018 //
00019 //  FastJet is distributed in the hope that it will be useful,
00020 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
00021 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00022 //  GNU General Public License for more details.
00023 //
00024 //  You should have received a copy of the GNU General Public License
00025 //  along with FastJet; if not, write to the Free Software
00026 //  Foundation, Inc.:
00027 //      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00028 //----------------------------------------------------------------------
00029 //ENDHEADER
00030 
00031 
00032 #ifndef __FASTJET_COMPOSITEJET_STRUCTURE_HH__
00033 #define __FASTJET_COMPOSITEJET_STRUCTURE_HH__
00034 
00035 #include <fastjet/PseudoJet.hh>
00036 #include <fastjet/PseudoJetStructureBase.hh>
00037 
00038 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00039 
00040 /// @ingroup tools
00041 /// \class CompositeJetStructure
00042 /// The structure for a jet made of pieces
00043 ///
00044 /// This stores the vector of the pieces that make the jet and provide
00045 /// the methods to access them
00046 class CompositeJetStructure : public PseudoJetStructureBase{
00047 public:
00048   // basic class info
00049   //------------------------------------------------------------------------------
00050   /// default ctor
00051   CompositeJetStructure(){};
00052 
00053   /// ctor with initialisation
00054   CompositeJetStructure(const std::vector<PseudoJet> & initial_pieces) : _pieces(initial_pieces){};
00055 
00056   /// default dtor
00057   virtual ~CompositeJetStructure(){};
00058 
00059   /// description
00060   virtual std::string description() const;
00061 
00062   // things reimplemented from the base structure
00063   //------------------------------------------------------------------------------
00064   /// true if the jet has constituents (i.e. all pieces do)
00065   virtual bool has_constituents() const;
00066 
00067   /// return the constituents (i.e. the union of the constituents of each piece)
00068   /// 
00069   /// If any of the pieces has no constituent, an error is thrown
00070   virtual std::vector<PseudoJet> constituents(const PseudoJet &jet) const;
00071 
00072   /// true if it has pieces (always the case)
00073   virtual bool has_pieces() const {return true;};
00074 
00075   /// returns the pieces
00076   virtual std::vector<PseudoJet> pieces(const PseudoJet &jet) const;
00077 
00078 protected:
00079   std::vector<PseudoJet> _pieces;  ///< the pieces building the jet
00080 };
00081 
00082 
00083 
00084 FASTJET_END_NAMESPACE      // defined in fastjet/internal/base.hh
00085 
00086 #endif // __FASTJET_MERGEDJET_STRUCTURE_HH__