FastJet  3.3.3
Public Member Functions | List of all members
fastjet::AreaDefinition Class Reference

class that holds a generic area definition More...

#include <fastjet/AreaDefinition.hh>

Public Member Functions

 AreaDefinition ()
 default constructor, which provides a ghosted active area, with sensible defaults for the ghosts. More...
 
 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 More...
 
AreaType area_type () const
 return info about the type of area being used by this defn
 
const GhostedAreaSpecghost_spec () const
 return a reference to the active area spec
 
GhostedAreaSpecghost_spec ()
 
const VoronoiAreaSpecvoronoi_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

◆ AreaDefinition()

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.

Member Function Documentation

◆ description()

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.


The documentation for this class was generated from the following files: