FastJet 3.0.2
ClusterSequencePassiveArea.hh
00001 //STARTHEADER
00002 // $Id: ClusterSequencePassiveArea.hh 2687 2011-11-14 11:17:51Z soyez $
00003 //
00004 // Copyright (c) 2005-2011, Matteo Cacciari, Gavin P. 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, see <http://www.gnu.org/licenses/>.
00026 //----------------------------------------------------------------------
00027 //ENDHEADER
00028 
00029 #ifndef __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__
00030 #define __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__
00031 
00032 
00033 #include "fastjet/PseudoJet.hh"
00034 #include "fastjet/ClusterSequence1GhostPassiveArea.hh"
00035 #include<iostream>
00036 #include<vector>
00037 
00038 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
00039 
00040 //using namespace std;
00041 
00042 /// @ingroup sec_area_classes
00043 /// \class ClusterSequencePassiveArea
00044 /// Like ClusterSequence with computation of the passive jet area
00045 ///
00046 /// Class that behaves essentially like ClusterSequence except
00047 /// that it also provides access to the area of a jet (which
00048 /// will be a random quantity... Figure out what to do about seeds 
00049 /// later...)
00050 ///
00051 /// This class should not be used directly. Rather use
00052 /// ClusterSequenceArea with the appropriate AreaDefinition
00053 class ClusterSequencePassiveArea : public ClusterSequence1GhostPassiveArea {
00054 public:
00055 
00056   /// constructor based on JetDefinition and PassiveAreaSpec
00057   template<class L> ClusterSequencePassiveArea
00058          (const std::vector<L> & pseudojets, 
00059           const JetDefinition & jet_def_in,
00060           const GhostedAreaSpec & area_spec,
00061           const bool & writeout_combinations = false) ;
00062 
00063   /// return an empty area that's appropriate to the passive area
00064   /// determination carried out
00065   virtual double empty_area(const Selector & selector) const;
00066 
00067 private:
00068 
00069   /// does the initialisation and running specific to the passive
00070   /// areas class
00071   void _initialise_and_run_PA (const JetDefinition & jet_def_in,
00072                                const GhostedAreaSpec & area_spec,
00073                                const bool & writeout_combinations = false);
00074 
00075 };
00076 
00077 
00078 
00079 
00080 template<class L> ClusterSequencePassiveArea::ClusterSequencePassiveArea 
00081 (const std::vector<L> & pseudojets, 
00082  const JetDefinition & jet_def_in,
00083  const GhostedAreaSpec & area_spec,
00084  const bool & writeout_combinations) {
00085 
00086   // transfer the initial jets (type L) into our own array
00087   _transfer_input_jets(pseudojets);
00088 
00089   // run the clustering for passive areas
00090   _initialise_and_run_PA(jet_def_in, area_spec, writeout_combinations);
00091 
00092 }
00093 
00094 
00095   
00096 FASTJET_END_NAMESPACE
00097 
00098 #endif // __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends