Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

fastjet::AreaDefinition Class Reference

class that holds a generic area definition More...

#include <AreaDefinition.hh>

Collaboration diagram for fastjet::AreaDefinition:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AreaDefinition ()
 default constructor, which provides a ghosted active area, with sensible defaults for the ghosts.

 AreaDefinition (AreaType type, const GhostedAreaSpec &spec)
 constructor for an area definition based on an area type and a ghosted area specification

 AreaDefinition (AreaType type, const VoronoiAreaSpec &spec)
 constructor for an area definition based on an area type and a voronoi area specification (type must be voronoi_area)

 AreaDefinition (AreaType type)
 constructor for an area definition based on an area type and which attempts to provide sensible defaults for everything else

 AreaDefinition (const GhostedAreaSpec &spec, AreaType type=active_area)
 constructor for an area definition based on an ghosted area specification, and an option to select which ghosted area you want

 AreaDefinition (const VoronoiAreaSpec &spec)
 constructor for an area definition based on a voronoi area specification

std::string description () const
 return info about the type of area being used by this defn

AreaType area_type () const
 return info about the type of area being used by this defn

const GhostedAreaSpec & ghost_spec () const
 return a reference to the active area spec

GhostedAreaSpec & ghost_spec ()
const VoronoiAreaSpec & voronoi_spec () const
 return a reference to the voronoi area spec


Private Attributes

AreaType _area_type
GhostedAreaSpec _ghost_spec
VoronoiAreaSpec _voronoi_spec

Detailed Description

class that holds a generic area definition

Definition at line 77 of file AreaDefinition.hh.

Constructor & Destructor Documentation

fastjet::AreaDefinition::AreaDefinition (   )  [inline]
 

default constructor, which provides a ghosted active area, with sensible defaults for the ghosts.

Definition at line 82 of file AreaDefinition.hh.

References fastjet::active_area. 

00082                    {
00083     _area_type  = active_area;
00084     _ghost_spec = GhostedAreaSpec();
00085   }

fastjet::AreaDefinition::AreaDefinition (  AreaType  type,
const GhostedAreaSpec &  spec
)  [inline]
 

constructor for an area definition based on an area type and a ghosted area specification

Definition at line 89 of file AreaDefinition.hh.

References fastjet::voronoi_area. 

00089                                                               {
00090     _ghost_spec = spec;
00091     _area_type   = type;
00092     assert(type != voronoi_area);
00093   }

fastjet::AreaDefinition::AreaDefinition (  AreaType  type,
const VoronoiAreaSpec &  spec
)  [inline]
 

constructor for an area definition based on an area type and a voronoi area specification (type must be voronoi_area)

Definition at line 97 of file AreaDefinition.hh.

References fastjet::voronoi_area. 

00097                                                               {
00098     _voronoi_spec = spec;
00099     _area_type   = type;
00100     assert(type == voronoi_area);
00101   }

fastjet::AreaDefinition::AreaDefinition (  AreaType  type  )  [inline]
 

constructor for an area definition based on an area type and which attempts to provide sensible defaults for everything else

Definition at line 105 of file AreaDefinition.hh.

References fastjet::voronoi_area. 

00105                                 {
00106     _area_type   = type;
00107     if (type == voronoi_area) {
00108       _voronoi_spec = VoronoiAreaSpec();
00109     } else {
00110       _ghost_spec = GhostedAreaSpec();
00111     }
00112   }

fastjet::AreaDefinition::AreaDefinition (  const GhostedAreaSpec &  spec,
AreaType  type = active_area
)  [inline]
 

constructor for an area definition based on an ghosted area specification, and an option to select which ghosted area you want

Definition at line 116 of file AreaDefinition.hh.

References fastjet::voronoi_area. 

00116                                                                             {
00117     _ghost_spec = spec;
00118     _area_type   = type;
00119     assert(type != voronoi_area);
00120   }

fastjet::AreaDefinition::AreaDefinition (  const VoronoiAreaSpec &  spec  )  [inline]
 

constructor for an area definition based on a voronoi area specification

Definition at line 124 of file AreaDefinition.hh.

References fastjet::voronoi_area. 

00124                                                {
00125     _voronoi_spec = spec;
00126     _area_type    = voronoi_area;
00127   }

Member Function Documentation

AreaType fastjet::AreaDefinition::area_type (   )  const [inline]
 

return info about the type of area being used by this defn

Definition at line 133 of file AreaDefinition.hh.

References fastjet::AreaType.

Referenced by fastjet::ClusterSequenceArea::_warn_if_range_unsuitable(), description(), and fastjet::ClusterSequenceArea::initialize_and_run_cswa(). 

00133 {return _area_type;}

string fastjet::AreaDefinition::description (   )  const
 

return info about the type of area being used by this defn

Definition at line 48 of file AreaDefinition.cc.

References fastjet::active_area, fastjet::active_area_explicit_ghosts, area_type(), fastjet::VoronoiAreaSpec::description(), fastjet::GhostedAreaSpec::description(), ghost_spec(), fastjet::one_ghost_passive_area, fastjet::passive_area, fastjet::voronoi_area, and voronoi_spec().

Referenced by main(). 

00048                                          {
00049   ostringstream ostr;
00050 
00051   switch(area_type()) {
00052   case active_area:
00053     ostr << "Active area (hidden ghosts) with " ;
00054     ostr << ghost_spec().description();
00055     break;
00056   case active_area_explicit_ghosts:
00057     ostr << "Active area (explicit ghosts) with " ;
00058     ostr << ghost_spec().description();
00059     break;
00060   case one_ghost_passive_area:
00061     ostr << "Passive area (one ghost at a time) with " ;
00062     ostr << ghost_spec().description();
00063     break;
00064   case passive_area:
00065     ostr << "Passive area (optimal alg. based on jet.def.), where relevant with " ;
00066     ostr << ghost_spec().description()  ;
00067     break;
00068   case voronoi_area:
00069     ostr << voronoi_spec().description();
00070     break;
00071   default:
00072     cerr << "Error: unrecognized area_type in AreaDefinition::description():" 
00073          << area_type() << endl;
00074     exit(-1);
00075   }
00076   return ostr.str();
00077 }

GhostedAreaSpec& fastjet::AreaDefinition::ghost_spec (   )  [inline]
 

Definition at line 137 of file AreaDefinition.hh. 

00137 {return _ghost_spec;}

const GhostedAreaSpec& fastjet::AreaDefinition::ghost_spec (   )  const [inline]
 

return a reference to the active area spec

Definition at line 136 of file AreaDefinition.hh.

Referenced by fastjet::ClusterSequenceArea::_warn_if_range_unsuitable(), description(), and fastjet::ClusterSequenceArea::initialize_and_run_cswa(). 

00136 {return _ghost_spec;}

const VoronoiAreaSpec& fastjet::AreaDefinition::voronoi_spec (   )  const [inline]
 

return a reference to the voronoi area spec

Definition at line 140 of file AreaDefinition.hh.

Referenced by description(), and fastjet::ClusterSequenceArea::initialize_and_run_cswa(). 

00140 {return _voronoi_spec;}

Member Data Documentation

AreaType fastjet::AreaDefinition::_area_type [private]
 

Definition at line 144 of file AreaDefinition.hh.

GhostedAreaSpec fastjet::AreaDefinition::_ghost_spec [private]
 

Definition at line 145 of file AreaDefinition.hh.

VoronoiAreaSpec fastjet::AreaDefinition::_voronoi_spec [private]
 

Definition at line 146 of file AreaDefinition.hh.

The documentation for this class was generated from the following files:
Generated on Mon Dec 3 11:53:59 2007 for fastjet by doxygen 1.3.4