class that holds a generic area definition More...
#include <AreaDefinition.hh>
Collaboration diagram for fastjet::AreaDefinition:
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 a description of the current area definition | |
| 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 | |
Detailed Description
class that holds a generic area definition
Definition at line 82 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 87 of file AreaDefinition.hh.
{
_area_type = active_area;
_ghost_spec = GhostedAreaSpec();
}
Member Function Documentation
| string fastjet::AreaDefinition::description | ( | ) | const |
return a description of the current area definition
return info about the type of area being used by this defn
Definition at line 48 of file AreaDefinition.cc.
References area_type(), fastjet::VoronoiAreaSpec::description(), fastjet::GhostedAreaSpec::description(), ghost_spec(), and voronoi_spec().
Referenced by main().
{
ostringstream ostr;
switch(area_type()) {
case active_area:
ostr << "Active area (hidden ghosts) with " ;
ostr << ghost_spec().description();
break;
case active_area_explicit_ghosts:
ostr << "Active area (explicit ghosts) with " ;
ostr << ghost_spec().description();
break;
case one_ghost_passive_area:
ostr << "Passive area (one ghost at a time) with " ;
ostr << ghost_spec().description();
break;
case passive_area:
ostr << "Passive area (optimal alg. based on jet.def.), where relevant with " ;
ostr << ghost_spec().description() ;
break;
case voronoi_area:
ostr << voronoi_spec().description();
break;
default:
cerr << "Error: unrecognized area_type in AreaDefinition::description():"
<< area_type() << endl;
exit(-1);
}
return ostr.str();
}
The documentation for this class was generated from the following files:
- include/fastjet/AreaDefinition.hh
- src/AreaDefinition.cc
