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
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.

                   {
    _area_type  = active_area;
    _ghost_spec = GhostedAreaSpec();
  }

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.

                                                              {
    _ghost_spec = spec;
    _area_type   = type;
    assert(type != voronoi_area);
  }

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.

                                                              {
    _voronoi_spec = spec;
    _area_type   = type;
    assert(type == voronoi_area);
  }

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.

                                {
    _area_type   = type;
    if (type == voronoi_area) {
      _voronoi_spec = VoronoiAreaSpec();
    } else {
      _ghost_spec = GhostedAreaSpec();
    }
  }

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.

                                                                            {
    _ghost_spec = spec;
    _area_type   = type;
    assert(type != voronoi_area);
  }

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.

                                               {
    _voronoi_spec = spec;
    _area_type    = voronoi_area;
  }

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.

{return _area_type;}

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 fastjet::active_area, fastjet::active_area_explicit_ghosts, fastjet::one_ghost_passive_area, fastjet::passive_area, and fastjet::voronoi_area.

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();
}