fermipy.diffuse subpackage¶
fermipy.diffuse.binning module¶
Small helper class to represent the binning used for a single component of a summed likelihood in diffuse analysis
-
class
fermipy.diffuse.binning.
Component
(**kwargs)[source]¶ Bases:
object
Small helper class to represent the binning used for a single component of a summed likelihood in diffuse analysis
Parameters: - log_emin (float) – Log base 10 of minimum energy for this component
- log_emax (float) – Log base 10 of maximum energy for this component
- enumbins (int) – Number of energy bins for this component
- zmax (float) – Maximum zenith angle cube for this component in degrees
- mktimefilters (list) – Filters for gtmktime.
- hpx_order (int) – HEALPix order to use for this component
- coordsys (str) – Coodinate system, ‘CEL’ or ‘GAL’
-
classmethod
build_from_energy_dict
(ebin_name, input_dict)[source]¶ Build a list of components from a dictionary for a single energy range
-
emax
¶ Maximum energy for this component
-
emin
¶ Minimum energy for this component
-
evtype
¶ Event type bit mask for this component
fermipy.diffuse.defaults module¶
Analysis framework for all-sky diffuse emission fitting
fermipy.diffuse.name_policy module¶
Handle the naming conventions for composite likelihood analysis
-
class
fermipy.diffuse.name_policy.
NameFactory
(**kwargs)[source]¶ Bases:
object
Helper class to define file names and keys consistently.
-
angprofile_format
= 'templates/profile_{sourcekey}.fits'¶
-
bexpcube_format
= 'bexp_cubes/bexcube_{dataset}_{mktime}_{component}_{coordsys}_{irf_ver}.fits'¶
-
bexpcubemoon_format
= 'bexp_cubes/bexcube_{dataset}_{mktime}_{component}_{irf_ver}_moon.fits'¶
-
bexpcubesun_format
= 'bexp_cubes/bexcube_{dataset}_{mktime}_{component}_{irf_ver}_sun.fits'¶
-
catalog_split_yaml_format
= 'models/catalog_{sourcekey}.yaml'¶
-
ccube_format
= 'counts_cubes/ccube_{dataset}_{mktime}_{component}_{coordsys}.fits'¶
-
comp_srcmdl_xml_format
= 'analysis/model_{modelkey}/srcmdl_{modelkey}_{component}.xml'¶
-
component_format
= '{zcut}_{ebin}_{psftype}'¶
-
dataset_format
= '{data_pass}_{data_ver}_{data_time}_{evclass}'¶
-
diffuse_template_format
= 'templates/template_{sourcekey}.fits'¶
-
ft1file_format
= '{dataset}_{zcut}.lst'¶
-
ft2file_format
= 'ft2_files/ft2_{data_time}.lst'¶
-
fullpath_format
= '{basedir}/{localpath}'¶
-
galprop_gasmap_format
= 'gasmap/{sourcekey}_{projtype}_{galprop_run}.gz'¶
-
galprop_ringkey
(**kwargs)[source]¶ return the sourcekey for galprop input maps : specifies the component and ring
-
galprop_ringkey_format
= '{source_name}_{ringkey}'¶
-
galprop_rings_yaml_format
= 'models/galprop_rings_{galkey}.yaml'¶
-
galprop_sourcekey
(**kwargs)[source]¶ return the sourcekey for merged galprop maps : specifies the merged component and merging scheme
-
galprop_sourcekey_format
= '{source_name}_{galpropkey}'¶
-
generic
(input_string, **kwargs)[source]¶ return a generic filename for a given dataset and component
-
ltcube_format
= 'lt_cubes/ltcube_{data_time}_{mktime}_{zcut}.fits'¶
-
ltcubemoon_format
= 'sunmoon/ltcube_{data_time}_{mktime}_{zcut}_moon.fits'¶
-
ltcubesun_format
= 'sunmoon/ltcube_{data_time}_{mktime}_{zcut}_sun.fits'¶
-
master_srcmdl_xml_format
= 'analysis/model_{modelkey}/srcmdl_{modelkey}_master.xml'¶
-
mcube_format
= 'model_cubes/mcube_{sourcekey}_{dataset}_{mktime}_{component}_{coordsys}_{irf_ver}.fits'¶
-
merged_gasmap_format
= 'merged_gasmaps/{sourcekey}_{projtype}.fits'¶
-
merged_sourcekey
(**kwargs)[source]¶ return the sourcekey for merged sets of point sources : specifies the catalog and merging rule
-
merged_sourcekey_format
= '{catalog}_{rulekey}'¶
-
merged_srcmaps_format
= 'analysis/model_{modelkey}/srcmaps_{dataset}_{mktime}_{component}_{coordsys}_{irf_ver}.fits'¶
-
mktime_format
= 'counts_cubes/mktime_{dataset}_{mktime}_{component}.fits'¶
-
model_yaml_format
= 'models/model_{modelkey}.yaml'¶
-
nested_srcmdl_xml
(**kwargs)[source]¶ return the file name for source model xml files of nested sources
-
nested_srcmdl_xml_format
= 'srcmdls/{sourcekey}_sources.xml'¶
-
residual_cr_format
= 'residual_cr/residual_cr_{dataset}_{mktime}_{component}_{coordsys}_{irf_ver}.fits'¶
-
select_format
= 'counts_cubes/select_{dataset}_{component}.fits'¶
-
sourcekey
(**kwargs)[source]¶ Return a key that specifies the name and version of a source or component
-
sourcekey_format
= '{source_name}_{source_ver}'¶
-
spectral_template_format
= 'templates/spectral_{sourcekey}.txt'¶
-
srcmaps_format
= 'srcmaps/srcmaps_{sourcekey}_{dataset}_{mktime}_{component}_{coordsys}_{irf_ver}.fits'¶
-
srcmdl_xml_format
= 'srcmdls/{sourcekey}.xml'¶
-
stamp_format
= 'stamps/{linkname}.stamp'¶
-
templatesunmoon_format
= 'templates/template_{sourcekey}_{zcut}.fits'¶
-
fermipy.diffuse.spectral module¶
Classes and utilities that manage spectral model specific to diffuse analyses
fermipy.diffuse.source_factory module¶
Classes and utilities that create fermipy source objects
-
class
fermipy.diffuse.source_factory.
SourceFactory
[source]¶ Bases:
object
Small helper class to build and keep track of sources
-
classmethod
copy_selected_sources
(roi, source_names)[source]¶ Build and return a
fermipy.roi_model.ROIModel
object by copying selected sources from another such object
-
static
make_fermipy_roi_model_from_catalogs
(cataloglist)[source]¶ Build and return a
fermipy.roi_model.ROIModel object from a list of fermipy.catalog.Catalog
objects
-
classmethod
make_roi
(sources=None)[source]¶ Build and return a
fermipy.roi_model.ROIModel
object from a dict with information about the sources
-
source_info_dict
¶ Return the dictionary of source_info objects used to build sources
-
sources
¶ Return the dictionary of sources
-
classmethod
-
fermipy.diffuse.source_factory.
make_catalog_sources
(catalog_roi_model, source_names)[source]¶ Construct and return dictionary of sources that are a subset of sources in catalog_roi_model.
Parameters: - catalog_roi_model (dict or
fermipy.roi_model.ROIModel
) – Input set of sources - source_names (list) – Names of sourcs to extract
- dict mapping source_name to fermipy.roi_model.Source object (Returns) –
- catalog_roi_model (dict or
-
fermipy.diffuse.source_factory.
make_composite_source
(name, spectrum)[source]¶ Construct and return a
fermipy.roi_model.CompositeSource
object
-
fermipy.diffuse.source_factory.
make_isotropic_source
(name, Spectrum_Filename, spectrum)[source]¶ Construct and return a
fermipy.roi_model.IsoSource
object
-
fermipy.diffuse.source_factory.
make_mapcube_source
(name, Spatial_Filename, spectrum)[source]¶ Construct and return a
fermipy.roi_model.MapCubeSource
object
-
fermipy.diffuse.source_factory.
make_point_source
(name, src_dict)[source]¶ Construct and return a
fermipy.roi_model.Source
object
fermipy.diffuse.catalog_src_manager module¶
Classes and utilities that manage catalog sources
-
class
fermipy.diffuse.catalog_src_manager.
CatalogSourceManager
(**kwargs)[source]¶ Bases:
object
Small helper class to keep track of how we deal with catalog sources
This keeps track of two dictionaries
One of the dictionaries is keyed by catalog name, and contains information about complete catalogs catalog_comp_info_dicts[catalog_name] :
model_component.CatalogInfo
The other dictionary is keyed by [{catalog_name}_{split_ver}][{split_key}] Where: {catalog_name} is something like ‘3FGL’ {split_ver} is somthing like ‘v00’ and specifes how to divide sources in the catalog {split_key} refers to a specific sub-selection of sources
split_comp_info_dicts[splitkey] :
model_component.ModelComponentInfo
-
catalog_components
(catalog_name, split_ver)[source]¶ Return the set of merged components for a particular split key
-
make_catalog_comp_info
(full_cat_info, split_key, rule_key, rule_val, sources)[source]¶ Make the information about a single merged component
Parameters: - full_cat_info (
_model_component.CatalogInfo
) – Information about the full catalog - split_key (str) – Key identifying the version of the spliting used
- rule_key (str) – Key identifying the specific rule for this component
- rule_val (list) – List of the cuts used to define this component
- sources (list) – List of the names of the sources in this component
- CompositeSourceInfo or CatalogSourcesInfo (Returns) –
- full_cat_info (
-
make_catalog_comp_info_dict
(catalog_sources)[source]¶ Make the information about the catalog components
Parameters: catalog_sources (dict) – Dictionary with catalog source defintions Returns: - catalog_ret_dict (dict) – Dictionary mapping catalog_name to
model_component.CatalogInfo
- split_ret_dict (dict) – Dictionary mapping sourcekey to
model_component.ModelComponentInfo
- catalog_ret_dict (dict) – Dictionary mapping catalog_name to
-
split_comp_info
(catalog_name, split_ver, split_key)[source]¶ Return the info for a particular split key
-
-
fermipy.diffuse.catalog_src_manager.
make_catalog_comp_dict
(**kwargs)[source]¶ Build and return the information about the catalog components
-
fermipy.diffuse.catalog_src_manager.
make_mask
(cat_table, cut)[source]¶ Mask a bit mask selecting the rows that pass a selection
-
fermipy.diffuse.catalog_src_manager.
mask_extended
(cat_table)[source]¶ Remove rows representing extended sources from a catalog table
fermipy.diffuse.diffuse_src_manager module¶
Classes and utilities that manage the diffuse emission background models
-
class
fermipy.diffuse.diffuse_src_manager.
DiffuseModelManager
(**kwargs)[source]¶ Bases:
object
Small helper class to keep track of diffuse component templates
This keeps track of the ‘diffuse component infomation’ dictionary
This keyed by: key = {source_name}_{source_ver} Where: {source_name} is something like ‘loopI’ {source_ver} is somthinng like v00
The dictioary is diffuse_comp_info_dict[key] - >
model_component.ModelComponentInfo
Note that some components ( those that represent moving sources or are selection depedent ) will have a sub-dictionary of diffuse_comp_info_dict object for each sub-component
The compoents are defined in a file called config/diffuse_components.yaml
-
make_diffuse_comp_info
(source_name, source_ver, diffuse_dict, components=None, comp_key=None)[source]¶ Make a dictionary mapping the merged component names to list of template files
Parameters: - source_name (str) – Name of the source
- source_ver (str) – Key identifying the version of the source
- diffuse_dict (dict) – Information about this component
- comp_key (str) – Used when we need to keep track of sub-components, i.e., for moving and selection dependent sources.
- model_component.ModelComponentInfo or (Returns) –
- model_component.IsoComponentInfo –
-
make_diffuse_comp_info_dict
(diffuse_sources, components)[source]¶ Make a dictionary maping from diffuse component to information about that component
Parameters: Returns: ret_dict – Dictionary mapping sourcekey to
model_component.ModelComponentInfo
Return type:
-
make_template_name
(model_type, sourcekey)[source]¶ Make the name of a template file for particular component
Parameters:
-
-
class
fermipy.diffuse.diffuse_src_manager.
GalpropMapManager
(**kwargs)[source]¶ Bases:
object
Small helper class to keep track of Galprop gasmaps
This keeps track of two types of dictionaries. Both are keyed by: key = {source_name}_{ring}_{galkey}
Where: {source_name} is something like ‘merged_C0’ {ring} is the ring index {galkey} is a key specifying which version of galprop rings to use.
The two dictionaries are: ring_dict[key] =
model_component.GalpropMergedRingInfo
diffuse_comp_info_dict[key] ]model_component.ModelComponentInfo
The dictionaries are defined in files called. models/galprop_rings_{galkey}.yaml
-
diffuse_comp_info_dicts
(galkey)[source]¶ Return the components info dictionary for a particular galprop key
-
make_diffuse_comp_info
(merged_name, galkey)[source]¶ Make the information about a single merged component
Parameters:
-
make_diffuse_comp_info_dict
(galkey)[source]¶ Make a dictionary maping from merged component to information about that component
Parameters: galkey (str) – A short key identifying the galprop parameters
-
make_merged_name
(source_name, galkey, fullpath)[source]¶ Make the name of a gasmap file for a set of merged rings
Parameters:
-
make_ring_dict
(galkey)[source]¶ Make a dictionary mapping the merged component names to list of template files
Parameters: - galkey (str) – Unique key for this ring dictionary
- model_component.GalpropMergedRingInfo (Returns) –
-
make_ring_filelist
(sourcekeys, rings, galprop_run)[source]¶ Make a list of all the template files for a merged component
Parameters: - sourcekeys (list-like of str) – The names of the componenents to merge
- rings (list-like of int) – The indices of the rings to merge
- galprop_run (str) – String identifying the galprop parameters
-
make_ring_filename
(source_name, ring, galprop_run)[source]¶ Make the name of a gasmap file for a single ring
Parameters:
-
fermipy.diffuse.model_component module¶
Small helper classes that wrap information about model components
-
class
fermipy.diffuse.model_component.
CatalogInfo
(**kwargs)[source]¶ Bases:
object
Information about a source catalog
Parameters: - catalog_name (str) – The name given to the merged component, e.g., merged_CO or merged_HI
- catalog_file (str) – Fits file with catalog data
- catalog_extdir (str) – Directory with extended source templates
- catalog_type (str) – Identifies the format of the catalog fits file: e.g., ‘3FGL’ or ‘4FGLP’
- catalog (
fermipy.catalog.Catalog
) – Catalog object - roi_model (
fermipy.roi_model.ROIModel
) – Fermipy object describing all the catalog sources - srcmdl_name (str) – Name of xml file with the catalog source model
-
class
fermipy.diffuse.model_component.
CatalogSourcesInfo
(**kwargs)[source]¶ Bases:
fermipy.diffuse.model_component.ModelComponentInfo
Information about a model component consisting of sources from a catalog
Parameters: - source_names (list) – The names of the nested sources
- catalog_info (
model_component.CatalogInfo
or None) – Information about the catalog containing the nested sources - roi_model (
fermipy.roi_model.ROIModel
) – Fermipy object describing the nested sources
-
class
fermipy.diffuse.model_component.
CompositeSourceInfo
(**kwargs)[source]¶ Bases:
fermipy.diffuse.model_component.ModelComponentInfo
Information about a model component represented by a CompositeSource
Parameters: - source_names (list) – The names of the nested sources
- catalog_info (
model_component.CatalogInfo
or None) – Information about the catalog containing the nested sources - roi_model (
fermipy.roi_model.ROIModel
) – Fermipy object describing the nested sources
-
class
fermipy.diffuse.model_component.
GalpropMergedRingInfo
(**kwargs)[source]¶ Bases:
object
Information about a set of Merged Galprop Rings
Parameters: - source_name (str) – The name given to the merged component, e.g., merged_CO or merged_HI
- ring (int) – The index of the merged ring
- sourcekey (str) – Key that identifies this component, e.g., merged_CO_1, or merged_HI_3
- galkey (str) – Key that identifies how to merge the galprop rings, e.g., ‘ref’
- galprop_run (str) – Key that idenfifies the galprop run used to make the input rings
- files (str) – List of files of the input gasmap files
- merged_gasmap (str) – Filename for the merged gasmap
-
class
fermipy.diffuse.model_component.
IsoComponentInfo
(**kwargs)[source]¶ Bases:
fermipy.diffuse.model_component.ModelComponentInfo
Information about a model component represented by a IsoSource
Parameters: Spectral_Filename (str) – Name of the template file for the spatial model
-
class
fermipy.diffuse.model_component.
MapCubeComponentInfo
(**kwargs)[source]¶ Bases:
fermipy.diffuse.model_component.ModelComponentInfo
Information about a model component represented by a MapCubeSource
Parameters: Spatial_Filename (str) – Name of the template file for the spatial model
-
class
fermipy.diffuse.model_component.
ModelComponentInfo
(**kwargs)[source]¶ Bases:
object
Information about a model component
Parameters: - source_name (str) – The name given to the component, e.g., loop_I or moon
- source_ver (str) – Key to indentify the model version of the source, e.g., v00
- sourcekey (str) – Key that identifies this component, e.g., loop_I_v00 or moon_v00
- model_type (str) – Type of model, ‘MapCubeSource’ | ‘IsoSource’ | ‘CompositeSource’ | ‘Catalog’ | ‘PointSource’
- srcmdl_name (str) – Name of the xml file with the xml just for this component
- moving (bool) – Flag for moving sources (i.e., the sun and moon)
- selection_dependent (bool) – Flag for selection dependent sources (i.e., the residual cosmic ray model)
- no_psf (bool) – Flag to indicate that we do not smear this component with the PSF
- components (dict) – Sub-dictionary of
ModelComponentInfo
objects for moving and selection_dependent sources - comp_key (str) – Component key for this component of moving and selection_dependent sources
-
add_component_info
(compinfo)[source]¶ Add sub-component specific information to a particular data selection
Parameters: compinfo ( ModelComponentInfo
object) – Sub-component being added
-
clone_and_merge_sub
(key)[source]¶ Clones self and merges clone with sub-component specific information
Parameters: - key (str) – Key specifying which sub-component
- ModelComponentInfo object (Returns) –
-
class
fermipy.diffuse.model_component.
PointSourceInfo
(**kwargs)[source]¶ Bases:
fermipy.diffuse.model_component.ModelComponentInfo
Information about a model component represented by a PointSource
fermipy.diffuse.model_manager module¶
Classes and utilities that manage fitting models for diffuse analyses
-
class
fermipy.diffuse.model_manager.
ModelComponent
(**kwargs)[source]¶ Bases:
object
Small helper class to tie a ModelComponentInfo to a spectrum
-
class
fermipy.diffuse.model_manager.
ModelInfo
(**kwargs)[source]¶ Bases:
object
Small helper class to keep track of a single fitting model
-
component_names
¶ Return the list of name of the components
-
edisp_disable_list
()[source]¶ Return the list of source for which energy dispersion should be turned off
-
make_model_rois
(components, name_factory)[source]¶ Make the fermipy roi_model objects for each of a set of binning components
-
make_srcmap_manifest
(components, name_factory)[source]¶ Build a yaml file that specfies how to make the srcmap files for a particular model
Parameters: - components (list) – The binning components used in this analysis
- name_factory (
NameFactory
) – Object that handles naming conventions - a dictionary that contains information about where to find the (Returns) –
- maps for each component of the model (source) –
-
-
class
fermipy.diffuse.model_manager.
ModelManager
(**kwargs)[source]¶ Bases:
object
Small helper class to create fitting models and manager XML files for fermipy
This class contains a ‘library’, which is a dictionary of all the source components:
specifically it maps:
sourcekey :
model_component.ModelComponentInfo
-
csm
¶ Return the CatalogSourceManager
-
dmm
¶ Return the DiffuseModelManager
-
static
get_sub_comp_info
(source_info, comp)[source]¶ Build and return information about a sub-component for a particular selection
-
gmm
¶ Return the GalpropMapManager
-
make_fermipy_config_yaml
(modelkey, components, data, **kwargs)[source]¶ Build a fermipy top-level yaml configuration file
Parameters:
-
make_library
(diffuse_yaml, catalog_yaml, binning_yaml)[source]¶ Build up the library of all the components
Parameters:
-
make_model_info
(modelkey)[source]¶ Build a dictionary with the information for a particular model.
Parameters: - modelkey (str) – Key used to identify this particular model
- ModelInfo (Return) –
-
fermipy.diffuse.job_library module¶
Module to collect configuration to run specific jobs
-
class
fermipy.diffuse.job_library.
GatherSrcmaps_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for
Link_FermipyGatherSrcmaps
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- library (<type 'str'>) – Path to yaml file defining model components. [models/library.yaml]
-
appname
= 'fermipy-gather-srcmaps-sg'¶
-
clientclass
¶ alias of
Link_FermipyGatherSrcmaps
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>)}¶
-
description
= 'Submit fermipy-gather-srcmaps jobs in parallel'¶
-
job_time
= 300¶
-
usage
= 'fermipy-gather-srcmaps-sg [options]'¶
-
class
fermipy.diffuse.job_library.
Gtexpcube2_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for
Gtlink_expcube2
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- hpx_order_max (<type 'int'>) – Maximum HEALPIX order for exposure cubes. [6]
-
appname
= 'fermipy-gtexcube2-sg'¶
-
clientclass
¶ alias of
Gtlink_expcube2
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'hpx_order_max': (6, 'Maximum HEALPIX order for exposure cubes.', <type 'int'>)}¶
-
description
= 'Submit gtexpube2 jobs in parallel'¶
-
job_time
= 300¶
-
usage
= 'fermipy-gtexcube2-sg [options]'¶
-
class
fermipy.diffuse.job_library.
Gtlink_bin
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtbin :param algorithm: Binning alogrithm [HEALPIX] :type algorithm: <type ‘str’> :param emin: Minimum energy [MeV] [100.0] :type emin: <type ‘float’> :param emax: Maximum energy [MeV] [100000.0] :type emax: <type ‘float’> :param hpx_order: HEALPIX order parameter [6] :type hpx_order: <type ‘int’> :param evfile: Input FT1 eventfile [None] :type evfile: <type ‘str’> :param outfile: Output file [None] :type outfile: <type ‘str’> :param pfiles: PFILES directory [None] :type pfiles: <type ‘str’> :param coordsys: Coordinate system [GAL] :type coordsys: <type ‘str’> :param enumbins: Number of energy bins [16] :type enumbins: <type ‘int’>
-
appname
= 'gtbin'¶
-
default_file_args
= {'evfile': 33, 'outfile': 34}¶
-
default_options
= {'algorithm': ('HEALPIX', 'Binning alogrithm', <type 'str'>), 'coordsys': ('GAL', 'Coordinate system', <type 'str'>), 'emax': (100000.0, 'Maximum energy [MeV]', <type 'float'>), 'emin': (100.0, 'Minimum energy [MeV]', <type 'float'>), 'enumbins': (16, 'Number of energy bins', <type 'int'>), 'evfile': (None, 'Input FT1 eventfile', <type 'str'>), 'hpx_order': (6, 'HEALPIX order parameter', <type 'int'>), 'outfile': (None, 'Output file', <type 'str'>), 'pfiles': (None, 'PFILES directory', <type 'str'>)}¶
-
description
= 'Link to run gtbin'¶
-
linkname_default
= 'gtbin'¶
-
usage
= 'gtbin [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtlink_expcube2
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtexpcube2 :param irfs: Instrument response functions [CALDB] :type irfs: <type ‘str’> :param outfile: Output file [None] :type outfile: <type ‘str’> :param cmap: Input counts cube file [None] :type cmap: <type ‘str’> :param coordsys: Coordinate system [GAL] :type coordsys: <type ‘str’> :param evtype: Event type selections [None] :type evtype: <type ‘int’> :param hpx_order: HEALPIX order parameter [6] :type hpx_order: <type ‘int’> :param infile: Input livetime cube file [None] :type infile: <type ‘str’>
-
appname
= 'gtexpcube2'¶
-
default_file_args
= {'cmap': 1, 'infile': 1, 'outfile': 2}¶
-
default_options
= {'cmap': (None, 'Input counts cube file', <type 'str'>), 'coordsys': ('GAL', 'Coordinate system', <type 'str'>), 'evtype': (None, 'Event type selections', <type 'int'>), 'hpx_order': (6, 'HEALPIX order parameter', <type 'int'>), 'infile': (None, 'Input livetime cube file', <type 'str'>), 'irfs': ('CALDB', 'Instrument response functions', <type 'str'>), 'outfile': (None, 'Output file', <type 'str'>)}¶
-
description
= 'Link to run gtexpcube2'¶
-
linkname_default
= 'gtexpcube2'¶
-
usage
= 'gtexpcube2 [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtlink_ltcube
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtltcube :param dcostheta: Step size in cos(theta) [0.025] :type dcostheta: <type ‘float’> :param phibins: Number of phi bins [0] :type phibins: <type ‘int’> :param evfile: Input FT1 File [None] :type evfile: <type ‘str’> :param zmin: Minimum zenith angle [0] :type zmin: <type ‘float’> :param outfile: Output Livetime cube File [None] :type outfile: <type ‘str’> :param pfiles: PFILES directory [None] :type pfiles: <type ‘str’> :param binsz: Pixel size (degrees) [1.0] :type binsz: <type ‘float’> :param zmax: Maximum zenith angle [105] :type zmax: <type ‘float’> :param scfile: Input FT2 file [None] :type scfile: <type ‘str’>
-
appname
= 'gtltcube'¶
-
default_file_args
= {'evfile': 33, 'outfile': 34, 'scfile': 33}¶
-
default_options
= {'binsz': (1.0, 'Pixel size (degrees)', <type 'float'>), 'dcostheta': (0.025, 'Step size in cos(theta)', <type 'float'>), 'evfile': (None, 'Input FT1 File', <type 'str'>), 'outfile': (None, 'Output Livetime cube File', <type 'str'>), 'pfiles': (None, 'PFILES directory', <type 'str'>), 'phibins': (0, 'Number of phi bins', <type 'int'>), 'scfile': (None, 'Input FT2 file', <type 'str'>), 'zmax': (105, 'Maximum zenith angle', <type 'float'>), 'zmin': (0, 'Minimum zenith angle', <type 'float'>)}¶
-
description
= 'Link to run gtltcube'¶
-
linkname_default
= 'gtltcube'¶
-
usage
= 'gtltcube [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtlink_ltsum
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtltsum :param outfile: Output file [None] :type outfile: <type ‘str’> :param infile2: Livetime cube 2 [none] :type infile2: <type ‘str’> :param infile1: Livetime cube 1 or list of files [None] :type infile1: <type ‘str’>
-
appname
= 'gtltsum'¶
-
default_file_args
= {'infile1': 1, 'outfile': 2}¶
-
default_options
= {'infile1': (None, 'Livetime cube 1 or list of files', <type 'str'>), 'infile2': ('none', 'Livetime cube 2', <type 'str'>), 'outfile': (None, 'Output file', <type 'str'>)}¶
-
description
= 'Link to run gtltsum'¶
-
linkname_default
= 'gtltsum'¶
-
usage
= 'gtltsum [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtlink_mktime
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtmktime :param filter: Filter expression [None] :type filter: <type ‘str’> :param evfile: Input FT1 File [None] :type evfile: <type ‘str’> :param pfiles: PFILES directory [None] :type pfiles: <type ‘str’> :param outfile: Output FT1 File [None] :type outfile: <type ‘str’> :param roicut: Apply ROI-based zenith angle cut [False] :type roicut: <type ‘bool’> :param scfile: Input FT2 file [None] :type scfile: <type ‘str’>
-
appname
= 'gtmktime'¶
-
default_file_args
= {'evfile': 33, 'outfile': 34, 'scfile': 33}¶
-
default_options
= {'evfile': (None, 'Input FT1 File', <type 'str'>), 'filter': (None, 'Filter expression', <type 'str'>), 'outfile': (None, 'Output FT1 File', <type 'str'>), 'pfiles': (None, 'PFILES directory', <type 'str'>), 'roicut': (False, 'Apply ROI-based zenith angle cut', <type 'bool'>), 'scfile': (None, 'Input FT2 file', <type 'str'>)}¶
-
description
= 'Link to run gtmktime'¶
-
linkname_default
= 'gtmktime'¶
-
usage
= 'gtmktime [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtlink_scrmaps
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtscrmaps :param irfs: Instrument response functions [CALDB] :type irfs: <type ‘str’> :param expcube: Input Livetime cube file [None] :type expcube: <type ‘str’> :param cmap: Input counts cube file [None] :type cmap: <type ‘str’> :param srcmdl: Input source model xml file [None] :type srcmdl: <type ‘str’> :param outfile: Output file [None] :type outfile: <type ‘str’> :param bexpmap: Input binned exposure map file [None] :type bexpmap: <type ‘str’>
-
appname
= 'gtscrmaps'¶
-
default_file_args
= {'bexpmap': 1, 'cmap': 1, 'expcube': 1, 'outfile': 2, 'srcmdl': 1}¶
-
default_options
= {'bexpmap': (None, 'Input binned exposure map file', <type 'str'>), 'cmap': (None, 'Input counts cube file', <type 'str'>), 'expcube': (None, 'Input Livetime cube file', <type 'str'>), 'irfs': ('CALDB', 'Instrument response functions', <type 'str'>), 'outfile': (None, 'Output file', <type 'str'>), 'srcmdl': (None, 'Input source model xml file', <type 'str'>)}¶
-
description
= 'Link to run gtscrmaps'¶
-
linkname_default
= 'gtscrmaps'¶
-
usage
= 'gtscrmaps [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtlink_select
(**kwargs)[source]¶ Bases:
fermipy.jobs.gtlink.Gtlink
Small wrapper to run gtselect :param zmax: Maximum zenith angle [degrees] [100.0] :type zmax: <type ‘float’> :param emin: Minimum energy [MeV] [100.0] :type emin: <type ‘float’> :param emax: Maximum energy [MeV] [100000.0] :type emax: <type ‘float’> :param outfile: Output file [None] :type outfile: <type ‘str’> :param pfiles: PFILES directory [None] :type pfiles: <type ‘str’> :param evtype: Event type selections [None] :type evtype: <type ‘int’> :param evclass: Event Class [None] :type evclass: <type ‘int’> :param infile: Input file [None] :type infile: <type ‘str’>
-
appname
= 'gtselect'¶
-
default_file_args
= {'infile': 1, 'outfile': 2}¶
-
default_options
= {'emax': (100000.0, 'Maximum energy [MeV]', <type 'float'>), 'emin': (100.0, 'Minimum energy [MeV]', <type 'float'>), 'evclass': (None, 'Event Class', <type 'int'>), 'evtype': (None, 'Event type selections', <type 'int'>), 'infile': (None, 'Input file', <type 'str'>), 'outfile': (None, 'Output file', <type 'str'>), 'pfiles': (None, 'PFILES directory', <type 'str'>), 'zmax': (100.0, 'Maximum zenith angle [degrees]', <type 'float'>)}¶
-
description
= 'Link to run gtselect'¶
-
linkname_default
= 'gtselect'¶
-
usage
= 'gtselect [options]'¶
-
-
class
fermipy.diffuse.job_library.
Gtltsum_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for
Gtlink_ltsum
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- ft1file (<type 'str'>) – Input FT1 file [None]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
-
appname
= 'fermipy-gtltsum-sg'¶
-
clientclass
¶ alias of
Gtlink_ltsum
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'ft1file': (None, 'Input FT1 file', <type 'str'>)}¶
-
description
= 'Submit gtltsum jobs in parallel'¶
-
job_time
= 300¶
-
usage
= 'fermipy-gtltsum-sg [options]'¶
-
class
fermipy.diffuse.job_library.
Healview_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for
Link_FermipyHealview
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- library (<type 'str'>) – Path to yaml file defining model components. [models/library.yaml]
-
appname
= 'fermipy-healviw-sg'¶
-
clientclass
¶ alias of
Link_FermipyHealview
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>)}¶
-
description
= 'Submit fermipy-healviw jobs in parallel'¶
-
job_time
= 60¶
-
usage
= 'fermipy-healviw-sg [options]'¶
-
class
fermipy.diffuse.job_library.
Link_FermipyCoadd
(**kwargs)[source]¶ Bases:
fermipy.jobs.app_link.AppLink
Small wrapper to run fermipy-coadd :param output: Output file [None] :type output: <type ‘str’> :param args: List of input files [[]] :type args: <type ‘list’>
-
appname
= 'fermipy-coadd'¶
-
default_file_args
= {'args': 1, 'output': 2}¶
-
default_options
= {'args': ([], 'List of input files', <type 'list'>), 'output': (None, 'Output file', <type 'str'>)}¶
-
description
= 'Link to run fermipy-coadd'¶
-
linkname_default
= 'coadd'¶
-
usage
= 'fermipy-coadd [options]'¶
-
-
class
fermipy.diffuse.job_library.
Link_FermipyGatherSrcmaps
(**kwargs)[source]¶ Bases:
fermipy.jobs.app_link.AppLink
Small wrapper to run fermipy-gather-srcmaps :param gzip: Compress output [False] :type gzip: <type ‘bool’> :param rm: Remove input files [False] :type rm: <type ‘bool’> :param args: List of input files [[]] :type args: <type ‘list’> :param clobber: Overwrite output [False] :type clobber: <type ‘bool’> :param output: Output file name [None] :type output: <type ‘str’>
-
appname
= 'fermipy-gather-srcmaps'¶
-
default_file_args
= {'args': 1, 'output': 2}¶
-
default_options
= {'args': ([], 'List of input files', <type 'list'>), 'clobber': (False, 'Overwrite output', <type 'bool'>), 'gzip': (False, 'Compress output', <type 'bool'>), 'output': (None, 'Output file name', <type 'str'>), 'rm': (False, 'Remove input files', <type 'bool'>)}¶
-
description
= 'Link to run fermipy-gather-srcmaps'¶
-
linkname_default
= 'gather-srcmaps'¶
-
usage
= 'fermipy-gather-srcmaps [options]'¶
-
-
class
fermipy.diffuse.job_library.
Link_FermipyHealview
(**kwargs)[source]¶ Bases:
fermipy.jobs.app_link.AppLink
Small wrapper to run fermipy-healview :param output: Output file name [None] :type output: <type ‘str’> :param zscale: Scaling for color scale [log] :type zscale: <type ‘str’> :param extension: FITS HDU with HEALPix map [None] :type extension: <type ‘str’> :param input: Input file [None] :type input: <type ‘str’>
-
appname
= 'fermipy-healview'¶
-
default_file_args
= {'args': 1, 'output': 2}¶
-
default_options
= {'extension': (None, 'FITS HDU with HEALPix map', <type 'str'>), 'input': (None, 'Input file', <type 'str'>), 'output': (None, 'Output file name', <type 'str'>), 'zscale': ('log', 'Scaling for color scale', <type 'str'>)}¶
-
description
= 'Link to run fermipy-healview'¶
-
linkname_default
= 'fermipy-healview'¶
-
usage
= 'fermipy-healview [options]'¶
-
-
class
fermipy.diffuse.job_library.
Link_FermipyVstack
(**kwargs)[source]¶ Bases:
fermipy.jobs.app_link.AppLink
Small wrapper to run fermipy-vstack :param hdu: Name of HDU to stack [None] :type hdu: <type ‘str’> :param rm: Remove input files [False] :type rm: <type ‘bool’> :param gzip: Compress output [False] :type gzip: <type ‘bool’> :param output: Output file name [None] :type output: <type ‘str’> :param args: List of input files [[]] :type args: <type ‘list’> :param clobber: Overwrite output [False] :type clobber: <type ‘bool’>
-
appname
= 'fermipy-vstack'¶
-
default_file_args
= {'args': 1, 'output': 2}¶
-
default_options
= {'args': ([], 'List of input files', <type 'list'>), 'clobber': (False, 'Overwrite output', <type 'bool'>), 'gzip': (False, 'Compress output', <type 'bool'>), 'hdu': (None, 'Name of HDU to stack', <type 'str'>), 'output': (None, 'Output file name', <type 'str'>), 'rm': (False, 'Remove input files', <type 'bool'>)}¶
-
description
= 'Link to run fermipy-vstack'¶
-
linkname_default
= 'vstack'¶
-
usage
= 'fermipy-vstack [options]'¶
-
-
class
fermipy.diffuse.job_library.
SumRings_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
- Small class to generate configurations for
Link_FermipyCoadd
- to sum galprop ring gasmaps
Parameters: - library (<type 'str'>) – Path to yaml file defining model components. [models/library.yaml]
- outdir (<type 'str'>) – Output directory [None]
-
appname
= 'fermipy-sum-rings-sg'¶
-
clientclass
¶ alias of
Link_FermipyCoadd
-
default_options
= {'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>), 'outdir': (None, 'Output directory', <type 'str'>)}¶
-
description
= 'Submit fermipy-coadd jobs in parallel to sum GALProp rings'¶
-
job_time
= 300¶
-
usage
= 'fermipy-sum-rings-sg [options]'¶
- Small class to generate configurations for
-
class
fermipy.diffuse.job_library.
Vstack_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
- Small class to generate configurations for
Link_FermipyVstack
- to merge source maps
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- library (<type 'str'>) – Path to yaml file defining model components. [models/library.yaml]
-
appname
= 'fermipy-vstack-sg'¶
-
clientclass
¶ alias of
Link_FermipyVstack
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>)}¶
-
description
= 'Submit fermipy-vstack jobs in parallel'¶
-
job_time
= 300¶
-
usage
= 'fermipy-vstack-sg [options]'¶
- Small class to generate configurations for
fermipy.diffuse.gt_assemble_model module¶
Merge source maps to build composite sources
-
class
fermipy.diffuse.gt_assemble_model.
AssembleModel
(**kwargs)[source]¶ Bases:
fermipy.jobs.link.Link
Small class to assemple source map files for fermipy analysis.
This is useful for re-merging after parallelizing source map creation.
-
static
append_hdus
(hdulist, srcmap_file, source_names, hpx_order)[source]¶ Append HEALPix maps to a list
Parameters:
-
appname
= 'fermipy-assemble-model'¶
-
static
assemble_component
(compname, compinfo, hpx_order)[source]¶ Assemble the source map file for one binning component
Parameters:
-
static
copy_ccube
(ccube, outsrcmap, hpx_order)[source]¶ Copy a counts cube into outsrcmap file reducing the HEALPix order to hpx_order if needed.
-
default_options
= {'compname': (None, 'Component name.', <type 'str'>), 'hpx_order': (7, 'Maximum HEALPIX order for model fitting.', <type 'int'>), 'input': (None, 'Input yaml file', <type 'str'>)}¶
-
description
= 'Assemble sourcemaps for model fitting'¶
-
linkname_default
= 'assemble-model'¶
-
usage
= 'fermipy-assemble-model [options]'¶
-
static
-
class
fermipy.diffuse.gt_assemble_model.
AssembleModelChain
(**kwargs)[source]¶ Bases:
fermipy.jobs.chain.Chain
Small class to split, apply mktime and bin data according to some user-provided specification
-
appname
= 'fermipy-assemble-model-chain'¶
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'dry_run': (False, 'Print commands but do not run them', <type 'bool'>), 'hpx_order': (7, 'Maximum HEALPIX order for model fitting.', <type 'int'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>), 'models': ('models/modellist.yaml', 'Path to yaml file defining models.', <type 'str'>)}¶
-
description
= 'Run init-model and assemble-model'¶
-
linkname_default
= 'assemble-model-chain'¶
-
usage
= 'fermipy-assemble-model-chain [options]'¶
-
-
class
fermipy.diffuse.gt_assemble_model.
AssembleModel_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for this script
Parameters: - --compname (binning component definition yaml file) –
- --data (datset definition yaml file) –
- --models (model definitino yaml file) –
- args (Names of models to assemble source maps for) –
-
appname
= 'fermipy-assemble-model-sg'¶
-
clientclass
¶ alias of
AssembleModel
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'models': ('models/modellist.yaml', 'Path to yaml file defining models.', <type 'str'>)}¶
-
description
= 'Copy source maps from the library to a analysis directory'¶
-
job_time
= 300¶
-
usage
= 'fermipy-assemble-model-sg [options]'¶
-
class
fermipy.diffuse.gt_assemble_model.
InitModel
(**kwargs)[source]¶ Bases:
fermipy.jobs.link.Link
Small class to preprate files fermipy analysis.
Specifically this create the srcmap_manifest and fermipy_config_yaml files
-
appname
= 'fermipy-init-model'¶
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'hpx_order': (7, 'Maximum HEALPIX order for model fitting.', <type 'int'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>), 'models': ('models/modellist.yaml', 'Path to yaml file defining models.', <type 'str'>)}¶
-
description
= 'Initialize model fitting directory'¶
-
linkname_default
= 'init-model'¶
-
usage
= 'fermipy-init-model [options]'¶
-
fermipy.diffuse.gt_coadd_split module¶
Prepare data for diffuse all-sky analysis
-
class
fermipy.diffuse.gt_coadd_split.
CoaddSplit
(**kwargs)[source]¶ Bases:
fermipy.jobs.chain.Chain
Small class to merge counts cubes for a series of binning components
This chain consists multiple
Link
objects:- coadd-EBIN-ZCUT-FILTER-EVTYPE :
_Link_FermipyCoadd
- Link to coadd data of a particular type.
Parameters: - nfiles (<type 'int'>) – Number of input files [96]
- do_ltsum (<type 'bool'>) – Sum livetime cube files [False]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- dry_run (<type 'bool'>) – Print commands but do not run them [False]
- comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
-
appname
= 'fermipy-coadd-split'¶
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'do_ltsum': (False, 'Sum livetime cube files', <type 'bool'>), 'dry_run': (False, 'Print commands but do not run them', <type 'bool'>), 'nfiles': (96, 'Number of input files', <type 'int'>)}¶
-
description
= 'Merge a set of counts cube files'¶
-
linkname_default
= 'coadd-split'¶
-
usage
= 'fermipy-coadd-split [options]'¶
- coadd-EBIN-ZCUT-FILTER-EVTYPE :
-
class
fermipy.diffuse.gt_coadd_split.
CoaddSplit_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for fermipy-coadd
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- ft1file (<type 'str'>) – Input FT1 file [None]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
-
appname
= 'fermipy-coadd-split-sg'¶
-
clientclass
¶
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'ft1file': (None, 'Input FT1 file', <type 'str'>)}¶
-
description
= 'Submit fermipy-coadd-split- jobs in parallel'¶
-
job_time
= 300¶
-
usage
= 'fermipy-coadd-split-sg [options]'¶
fermipy.diffuse.gt_merge_srcmaps module¶
Merge source maps to build composite sources
-
class
fermipy.diffuse.gt_merge_srcmaps.
GtMergeSrcmaps
(**kwargs)[source]¶ Bases:
fermipy.jobs.link.Link
Small class to merge source maps for composite sources.
This is useful for parallelizing source map creation.Parameters: - irfs (<type 'str'>) – Instrument response functions [CALDB]
- expcube (<type 'str'>) – Input Livetime cube file [None]
- srcmaps (<type 'str'>) – Input source maps file [None]
- srcmdl (<type 'str'>) – Input source model xml file [None]
- outxml (<type 'str'>) – Output source model xml file [None]
- bexpmap (<type 'str'>) – Input binned exposure map file [None]
- outfile (<type 'str'>) – Output file [None]
- gzip (<type 'bool'>) – Compress output file [False]
- merged (<type 'str'>) – Name of merged source [None]
-
NULL_MODEL
= 'srcmdls/null.xml'¶
-
appname
= 'fermipy-merge-srcmaps'¶
-
default_file_args
= {'bexpmap': 1, 'cmap': 1, 'expcube': 1, 'outfile': 2, 'outxml': 2, 'srcmdl': 1}¶
-
default_options
= {'bexpmap': (None, 'Input binned exposure map file', <type 'str'>), 'expcube': (None, 'Input Livetime cube file', <type 'str'>), 'gzip': (False, 'Compress output file', <type 'bool'>), 'irfs': ('CALDB', 'Instrument response functions', <type 'str'>), 'merged': (None, 'Name of merged source', <type 'str'>), 'outfile': (None, 'Output file', <type 'str'>), 'outxml': (None, 'Output source model xml file', <type 'str'>), 'srcmaps': (None, 'Input source maps file', <type 'str'>), 'srcmdl': (None, 'Input source model xml file', <type 'str'>)}¶
-
description
= 'Mrege source maps from a set of sources'¶
-
linkname_default
= 'merge-srcmaps'¶
-
usage
= 'fermipy-merge-srcmaps [options]'¶
-
class
fermipy.diffuse.gt_merge_srcmaps.
MergeSrcmaps_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for
GtMergeSrcmaps
Parameters: - comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- library (<type 'str'>) – Path to yaml file defining model components. [models/library.yaml]
-
appname
= 'fermipy-merge-srcmaps-sg'¶
-
clientclass
¶ alias of
GtMergeSrcmaps
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>)}¶
-
description
= 'Merge diffuse maps for all-sky analysis'¶
-
job_time
= 300¶
-
usage
= 'fermipy-merge-srcmaps-sg [options]'¶
fermipy.diffuse.gt_split_and_bin module¶
Prepare data for diffuse all-sky analysis
-
class
fermipy.diffuse.gt_split_and_bin.
SplitAndBin
(**kwargs)[source]¶ Bases:
fermipy.jobs.chain.Chain
Small class to split and bin data according to some user-provided specification
This chain consists multiple
Link
objects:- select-energy-EBIN-ZCUT :
Gtlink_select
- Initial splitting by energy bin and zenith angle cut
- select-type-EBIN-ZCUT-FILTER-TYPE :
Gtlink_select
- Refinement of selection from event types
- bin-EBIN-ZCUT-FILTER-TYPE :
Gtlink_bin
- Final binning of the data for each event type
Parameters: - ft1file (<type 'str'>) – Input FT1 file [None]
- dry_run (<type 'bool'>) – Print commands but do not run them [False]
- scratch (<type 'str'>) – Scratch area [None]
- outkey (<type 'str'>) – Key for this particular output file [None]
- pfiles (<type 'str'>) – Directory for .par files [None]
- hpx_order_max (<type 'int'>) – Maximum HEALPIX order for binning counts data. [9]
- evclass (<type 'int'>) – Event class bit mask [128]
- comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- outdir (<type 'str'>) – Base name for output files [counts_cubes_cr]
-
appname
= 'fermipy-split-and-bin'¶
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'dry_run': (False, 'Print commands but do not run them', <type 'bool'>), 'evclass': (128, 'Event class bit mask', <type 'int'>), 'ft1file': (None, 'Input FT1 file', <type 'str'>), 'hpx_order_max': (9, 'Maximum HEALPIX order for binning counts data.', <type 'int'>), 'outdir': ('counts_cubes_cr', 'Base name for output files', <type 'str'>), 'outkey': (None, 'Key for this particular output file', <type 'str'>), 'pfiles': (None, 'Directory for .par files', <type 'str'>), 'scratch': (None, 'Scratch area', <type 'str'>)}¶
-
description
= 'Run gtselect and gtbin together'¶
-
linkname_default
= 'split-and-bin'¶
-
usage
= 'fermipy-split-and-bin [options]'¶
- select-energy-EBIN-ZCUT :
-
class
fermipy.diffuse.gt_split_and_bin.
SplitAndBinChain
(**kwargs)[source]¶ Bases:
fermipy.jobs.chain.Chain
Chain to run split and bin and then make exposure cubes
This chain consists of:
- split-and-bin :
SplitAndBin_SG
- Chain to make the binned counts maps for each input file
- coadd-split :
CoaddSplit_SG
- Link to co-add the binnec counts maps files
- expcube2 :
Gtexpcube2_SG
- Link to make the corresponding binned exposure maps
Parameters: - ft1file (<type 'str'>) – Path to list of input FT1 files [P8_P305_8years_source_zmax105.lst]
- hpx_order_ccube (<type 'int'>) – Maximum HEALPIX order for binning counts data. [9]
- dry_run (<type 'bool'>) – Print commands but do not run them [False]
- hpx_order_expcube (<type 'int'>) – Maximum HEALPIX order for exposure cubes. [6]
- scratch (<type 'str'>) – Path to scratch area. [None]
- comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
-
appname
= 'fermipy-split-and-bin-chain'¶
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'dry_run': (False, 'Print commands but do not run them', <type 'bool'>), 'ft1file': ('P8_P305_8years_source_zmax105.lst', 'Path to list of input FT1 files', <type 'str'>), 'hpx_order_ccube': (9, 'Maximum HEALPIX order for binning counts data.', <type 'int'>), 'hpx_order_expcube': (6, 'Maximum HEALPIX order for exposure cubes.', <type 'int'>), 'scratch': (None, 'Path to scratch area.', <type 'str'>)}¶
-
description
= 'Run split-and-bin, coadd-split and exposure'¶
-
linkname_default
= 'split-and-bin-chain'¶
-
usage
= 'fermipy-split-and-bin-chain [options]'¶
- split-and-bin :
-
class
fermipy.diffuse.gt_split_and_bin.
SplitAndBin_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for SplitAndBin
Parameters: - scratch (<type 'str'>) – Path to scratch area [None]
- ft1file (<type 'str'>) – Input FT1 file [None]
- hpx_order_max (<type 'int'>) – Maximum HEALPIX order for binning counts data. [9]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
-
appname
= 'fermipy-split-and-bin-sg'¶
-
clientclass
¶ alias of
SplitAndBin
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'ft1file': (None, 'Input FT1 file', <type 'str'>), 'hpx_order_max': (9, 'Maximum HEALPIX order for binning counts data.', <type 'int'>), 'scratch': (None, 'Path to scratch area', <type 'str'>)}¶
-
description
= 'Prepare data for diffuse all-sky analysis'¶
-
job_time
= 1500¶
-
usage
= 'fermipy-split-and-bin-sg [options]'¶
fermipy.diffuse.gt_srcmap_partial module¶
Run gtsrcmaps for a single energy plane for a single source
This is useful to parallize the production of the source maps
-
class
fermipy.diffuse.gt_srcmap_partial.
GtSrcmapsDiffuse
(**kwargs)[source]¶ Bases:
fermipy.jobs.link.Link
- Small class to create srcmaps for only once source in a model,
and optionally for only some of the energy layers.
This is useful for parallelizing source map creation.
Parameters: - irfs (<type 'str'>) – Instrument response functions [CALDB]
- expcube (<type 'str'>) – Input Livetime cube file [None]
- srcmdl (<type 'str'>) – Input source model xml file [None]
- outfile (<type 'str'>) – Output file [None]
- kmin (<type 'int'>) – Minimum Energy Bin [0]
- bexpmap (<type 'str'>) – Input binned exposure map file [None]
- source (<type 'str'>) – Input source [None]
- kmax (<type 'int'>) – Maximum Energy Bin [-1]
- cmap (<type 'str'>) – Input counts cube file [None]
- gzip (<type 'bool'>) – Compress output file [False]
- no_psf (<type 'bool'>) – Do not apply PSF smearing [False]
-
NULL_MODEL
= 'srcmdls/null.xml'¶
-
appname
= 'fermipy-srcmaps-diffuse'¶
-
default_file_args
= {'bexpmap': 1, 'cmap': 1, 'expcube': 1, 'outfile': 2, 'srcmdl': 1}¶
-
default_options
= {'bexpmap': (None, 'Input binned exposure map file', <type 'str'>), 'cmap': (None, 'Input counts cube file', <type 'str'>), 'expcube': (None, 'Input Livetime cube file', <type 'str'>), 'gzip': (False, 'Compress output file', <type 'bool'>), 'irfs': ('CALDB', 'Instrument response functions', <type 'str'>), 'kmax': (-1, 'Maximum Energy Bin', <type 'int'>), 'kmin': (0, 'Minimum Energy Bin', <type 'int'>), 'no_psf': (False, 'Do not apply PSF smearing', <type 'bool'>), 'outfile': (None, 'Output file', <type 'str'>), 'source': (None, 'Input source', <type 'str'>), 'srcmdl': (None, 'Input source model xml file', <type 'str'>)}¶
-
description
= 'Run gtsrcmaps for one or more energy planes for a single source'¶
-
linkname_default
= 'srcmaps-diffuse'¶
-
usage
= 'fermipy-srcmaps-diffuse [options]'¶
-
class
fermipy.diffuse.gt_srcmap_partial.
SrcmapsDiffuse_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for
GtSrcmapsDiffuse
Parameters: - make_xml (<type 'bool'>) – Write xml files needed to make source maps [True]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- library (<type 'str'>) – Path to yaml file defining model components. [models/library.yaml]
- comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
-
appname
= 'fermipy-srcmaps-diffuse-sg'¶
-
clientclass
¶ alias of
GtSrcmapsDiffuse
-
default_options
= {'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'library': ('models/library.yaml', 'Path to yaml file defining model components.', <type 'str'>), 'make_xml': (True, 'Write xml files needed to make source maps', <type 'bool'>)}¶
-
description
= 'Run gtsrcmaps for diffuse sources'¶
-
job_time
= 1500¶
-
usage
= 'fermipy-srcmaps-diffuse-sg [options]'¶
fermipy.diffuse.residual_cr module¶
Compute the residual cosmic-ray contamination
-
class
fermipy.diffuse.residual_cr.
ResidualCR
(**kwargs)[source]¶ Bases:
fermipy.jobs.link.Link
Small class to analyze the residual cosmic-ray contaimination.
Parameters: - bexpcube_clean (<type 'str'>) – Input exposure cube for clean event class. [None]
- ccube_clean (<type 'str'>) – Input counts cube for clean event class. [None]
- full_output (<type 'bool'>) – Include diagnostic output [False]
- mask_factor (<type 'float'>) – Pixel selection factor for output mask [2.0]
- hpx_order (<type 'int'>) – HEALPIX order parameter [6]
- clobber (<type 'bool'>) – Overwrite files [False]
- outfile (<type 'str'>) – Output file [None]
- bexpcube_dirty (<type 'str'>) – Input exposure cube for dirty event class. [None]
- sigma (<type 'float'>) – Width of gaussian to smooth output maps [degrees] [3.0]
- ccube_dirty (<type 'str'>) – Input counts cube for dirty event class. [None]
- select_factor (<type 'float'>) – Pixel selection factor for Aeff Correction [5.0]
-
appname
= 'fermipy-residual-cr'¶
-
default_file_args
= {'bexpcube_clean': 1, 'bexpcube_dirty': 1, 'ccube_clean': 1, 'ccube_dirty': 1, 'outfile': 2}¶
-
default_options
= {'bexpcube_clean': (None, 'Input exposure cube for clean event class.', <type 'str'>), 'bexpcube_dirty': (None, 'Input exposure cube for dirty event class.', <type 'str'>), 'ccube_clean': (None, 'Input counts cube for clean event class.', <type 'str'>), 'ccube_dirty': (None, 'Input counts cube for dirty event class.', <type 'str'>), 'clobber': (False, 'Overwrite files', <type 'bool'>), 'full_output': (False, 'Include diagnostic output', <type 'bool'>), 'hpx_order': (6, 'HEALPIX order parameter', <type 'int'>), 'mask_factor': (2.0, 'Pixel selection factor for output mask', <type 'float'>), 'outfile': (None, 'Output file', <type 'str'>), 'select_factor': (5.0, 'Pixel selection factor for Aeff Correction', <type 'float'>), 'sigma': (3.0, 'Width of gaussian to smooth output maps [degrees]', <type 'float'>)}¶
-
description
= 'Compute the residual cosmic-ray contamination'¶
-
linkname_default
= 'residual-cr'¶
-
usage
= 'fermipy-residual-cr [options]'¶
-
class
fermipy.diffuse.residual_cr.
ResidualCRChain
(**kwargs)[source]¶ Bases:
fermipy.jobs.chain.Chain
Chain to preform analysis of residual cosmic-ray contamination
This chain consists of:
- split-and-mktime :
SplitAndMktimeChain
- Chain to bin up the data and make exposure cubes
- residual-cr :
ResidualCR
- Residual CR analysis
Parameters: config (<type 'str'>) – Config yaml file [None] -
appname
= 'fermipy-residual-cr-chain'¶
-
default_options
= {'config': (None, 'Config yaml file', <type 'str'>)}¶
-
description
= 'Run residual cosmic ray analysis'¶
-
linkname_default
= 'residual-cr-chain'¶
-
usage
= 'fermipy-residual-cr-chain [options]'¶
- split-and-mktime :
-
class
fermipy.diffuse.residual_cr.
ResidualCR_SG
(link, **kwargs)[source]¶ Bases:
fermipy.jobs.scatter_gather.ScatterGather
Small class to generate configurations for this script
Parameters: - mktimefilter (<type 'str'>) – Key for gtmktime selection [None]
- full_output (<type 'bool'>) – Include diagnostic output [False]
- mask_factor (<type 'float'>) – Pixel selection factor for output mask [2.0]
- hpx_order (<type 'int'>) – HEALPIX order parameter [6]
- sigma (<type 'float'>) – Width of gaussian to smooth output maps [degrees] [3.0]
- dirty (<type 'str'>) – Dirty event class [source]
- clean (<type 'str'>) – Clean event class [ultracleanveto]
- comp (<type 'str'>) – Path to yaml file defining binning. [config/binning.yaml]
- data (<type 'str'>) – Path to yaml file defining dataset. [config/dataset_source.yaml]
- select_factor (<type 'float'>) – Pixel selection factor for Aeff Correction [5.0]
-
appname
= 'fermipy-residual-cr-sg'¶
-
clientclass
¶ alias of
ResidualCR
-
default_options
= {'clean': ('ultracleanveto', 'Clean event class', <type 'str'>), 'comp': ('config/binning.yaml', 'Path to yaml file defining binning.', <type 'str'>), 'data': ('config/dataset_source.yaml', 'Path to yaml file defining dataset.', <type 'str'>), 'dirty': ('source', 'Dirty event class', <type 'str'>), 'full_output': (False, 'Include diagnostic output', <type 'bool'>), 'hpx_order': (6, 'HEALPIX order parameter', <type 'int'>), 'mask_factor': (2.0, 'Pixel selection factor for output mask', <type 'float'>), 'mktimefilter': (None, 'Key for gtmktime selection', <type 'str'>), 'select_factor': (5.0, 'Pixel selection factor for Aeff Correction', <type 'float'>), 'sigma': (3.0, 'Width of gaussian to smooth output maps [degrees]', <type 'float'>)}¶
-
description
= 'Compute the residual cosmic-ray contamination'¶
-
job_time
= 300¶
-
usage
= 'fermipy-residual-cr-sg [options]'¶