package FluxSvc

v6r53

Authors:

Toby Burnett, Sean Robinson, Theodore Hierath, and others.

Introduction

This package implements the Gaudi objects:

• FluxSvc: mangages (using the package flux) the sources. Also implements the Runnable interface
• FluxAlg: generates the current incoming particl
• ExposureAlg: if a Clock (or "TimeTick") pseudo-particle was geneated, puts the info into the exposure history
• PointInfoAlg; Manages calculation of position and orientation entries in the "merit" tuple, with an entry per event, and the pointing info tuple, fed by ExposureAlg.
  
  Usage is primarily via the FluxAlg algorithm, which access the service to generate a particle and place it in the TDS.

---

FluxSvc jobOptions

Parameters:

FluxSvc.source_lib	[$(FLUXSVCROOT)/xml/source_library.xml] list of file names containing source_lib elements
FluxSvc.dtd_file	[$(FLUXSVCROOT)/xml/source.dtd] DTD file used to parse the XML files
FluxSvc.EvtMax	[0] If non-zero, used as a maximum in the FluxSvc loop
FluxSvc.StartTimeEnvVar	[""] If set (e.g., to "runName") use this as the source of the start time. It has two forms: a number, or optionally a number for the start time offset, followed by a comma ant the delta time
FluxSvc.StartTime	[0] Mission elapsed time start
FluxSvc.EndTime	[0] Mission elapsed time end--if non-zero, will be the end.
FluxSvc.DeltaTime	[0] Maximum elapsed time.
FluxSvc.StartDate	[""] Date, in form "2004-07-25 18:00" note that if both StartDate and StartTime are specified, the latter is added to form the actual start
FluxSvc.SampleInterval	[1.0] Governs the minimum time that must elapse before a the GPS observers are notified to update pointing and attitude information.
FluxSvc.OrbitInclination	[25.3] Orbit inclination angle, in degrees for default orbit
FluxSvc.SAApolyLat	[{}] list of latitudes defining the SAA exclusion polygon
FluxSvc.SAApolyLon	[{}] longitudes
FluxSvc.xmlListFile	[""] name of a file containing a list of xml file names, multiple source_lib entries, consistent with obssim
FluxSvc.EnableAberration	[false] enable stellar aberration for celestial sources

FluxAlg jobOptions

Parameters:

FluxAlg.source_name	["default"] source name, name must be in the source_lib files
FluxAlg.sources	[{}] if used, can specify multiple sources. Overrides source_name
FluxAlg.MCrun	[100] Initial run number
FluxAlg.area	[6.0] target area in m^2
FluxAlg.backoff	[2.0] backoff distance in m
FluxAlg.rocking_angle	[0 deg] Rotation angle for Glast, about E-W axis. If set, so to 35 degress, and there is no pointing history file, the mode will be to use the interal orbit description, with rocking on alternate orbits.
FluxAlg.alignment	[{}] Set three rotation angles to align GLAST
FluxAlg.misalignment	[{}] Set three rotation angles to mis-align GLAST
FluxAlg.pointingDirection	[{}] Set (ra,dec) for pointed mode. Other rocking stuff ignored.
FluxAlg.AvoidSAA	[false] set true to skip events during SAA interval
FluxAlg.zenithTheta	[-99] if overridden, set to this angle in local zenith frame
FluxAlg.PointingHistory	[{}] Up to three strings: (1) file name (text or FITS FT2), (2) date-time offset needed for text format, (3) any string, if present, will trigger the horizontal orientation
FluxAlg.filterCone	[{}] Triplet: ra, dec, radius of cone to apply to celestial sources
FluxAlg.sourceListFile	[""] File with a list of source names to be added to the "sources" list. Consistent with obssim
FluxAlg.abortOnExceptioni	[false] What to do if flux generates an exception.

ExposureAlg jobOptions

Parameters:

ExposureAlg.root_tree	["pointing_history"] name for the root tree to be filled if there are clock ticks
ExposureAlg.PrintFrequency	[1] number of INFO entries to create per tick
ExposureAlg.clockName	["clock"] The source name that will trigger entries

PointInfoAlg jobOptions

Parameters:

PointInfoAlg.pointing_info_tree_name

["MeritTuple"]If set, copy "Pt" values to it. See point_info for definitions. aparam PointInfoAlg.save_pointing_info [false] Set true to save all entries in the pointing tuple. Normally saved by merit.

OrbitSvc jobOptions

Parameters:

OrbitSvc.zenithTheta	[-99] if overridden, set to this angle in local zenith frame
OrbitSvc.pointingDirection	[{}] Set (ra,dec) for pointed mode. Other rocking stuff ignored.
OrbitSvc.PointingHistory	[{}] Up to three strings: (1) file name (text or FITS FT2), (2) date-time offset needed for text format, (3) any string, if present, will trigger the horizontal orientation
OrbitSvc.rocking_angle	[0 deg] Rotation angle for Glast, about E-W axis. If set, say to 35 degress, and there is no pointing history file, the mode will be to use the interal orbit description, with rocking on alternate orbits.

---

Sources

The sources names and definitions are defined by the XML files that are loaded. See xml/source_library.xml in the flux package, and xml/source_library.xml in the CRflux package.

---

This is extracted from

Defining an external source

See the interface definition IRegisterSource for information on how to link code external to this package.

---

release notes

release.notes

requirements

package FluxSvc
version v6r53

# $Id: requirements,v 1.202 2008/01/10 00:54:45 burnett Exp $
author  T. Burnett <tburnett@u.washington.edu>

branches FluxSvc cmt doc test_FluxSvc
use GlastPolicy v*

# this is a Gaudi shrared component package
apply_pattern packageShr
apply_pattern package_include

use GaudiInterface * IExternal
use CLHEP * IExternal
use facilities *
use astro *
use extFiles v* IExternal

# for livetime
use Trigger *

# libraries that are only linked locally
use flux             * -no_auto_imports
use celestialSources * -no_auto_imports

#this is needed to find the path to the source xml files
#set FLUX_XML $(flux_root)/xml

# and this makes 
set GENERICSOURCES_XML $(genericSources_root)/xml

#  set  path to particle properties (used by Gaudi ParticlePropertySvc) 
#  $(FlUXSVCROOT)/cdf/particleproperty.cdf
set LHCBDBASE       "${EXTFILESSYS}/gaudi"
set PARAMFILESROOT  "${EXTFILESSYS}/gaudi"


# _____________________________________________________________

private
use Event       v*
use GlastSvc    v*

use ntupleWriterSvc v*
use XMLEXT * IExternal

use gr_app v*

macro_append includes ' $(ppcmd)"$(flux_root)" '
macro_append includes ' $(ppcmd)"$(celestialSources_root)" ' 

#  shared component library 
apply_pattern package_Cshlibflags

private
#macro_append ROOT_libs " -lHist -lGraf "\
#                 WIN32 " libHist.lib libGraf.lib " 

macro  source  "*.cxx"  WIN32 "*.h *.cxx *.txt"


library  FluxSvc \
    -import=flux -import=GRB  -import=tip -import=celestialSources -import=f2c \
     -s=../FluxSvc $(source) \
     -s=Dll *.cxx\
     -s=../src $(source)

---

---

Todo:

Complete and recalibrate the CompositeDiffuse structure

---