cscripts.csinfo Namespace Reference

Functions
	get_command_output (cmd)
	csinfo_list_tools ()
	csinfo_setup_check ()
	csinfo_setup_info ()
	get_pkg_config_info (info, library)
	csinfo_print_help ()
	csinfo (argv)

Variables
str	CTOOL_LIST
str	CSCRIPT_LIST
str	COMSCRIPT_LIST

Function Documentation

csinfo()

cscripts.csinfo.csinfo

(

argv

)

Print information about Gammalib and ctools to the console

Definition at line 355 of file csinfo.py.

References cscripts.csinfo.csinfo_list_tools(), cscripts.csinfo.csinfo_print_help(), cscripts.csinfo.csinfo_setup_check(), and cscripts.csinfo.csinfo_setup_info().

csinfo_list_tools()

cscripts.csinfo.csinfo_list_tools

(

)

Print available ctools with one-line description to the console

Definition at line 138 of file csinfo.py.

Referenced by cscripts.csinfo.csinfo().

csinfo_print_help()

cscripts.csinfo.csinfo_print_help

(

)

Print help text into console

Definition at line 336 of file csinfo.py.

Referenced by cscripts.csinfo.csinfo().

csinfo_setup_check()

cscripts.csinfo.csinfo_setup_check

(

)

Print check information

Definition at line 161 of file csinfo.py.

Referenced by cscripts.csinfo.csinfo().

csinfo_setup_info()

cscripts.csinfo.csinfo_setup_info

(

)

Print setup information

Definition at line 244 of file csinfo.py.

References cscripts.csinfo.get_pkg_config_info().

Referenced by cscripts.csinfo.csinfo().

get_command_output()

cscripts.csinfo.get_command_output

(

cmd

)

Utility function to get command output on old and new Python versions

Parameters
----------
cmd : str
    Command string

Returns
-------
output : str
    Command output

Definition at line 110 of file csinfo.py.

Referenced by cscripts.csinfo.get_pkg_config_info().

get_pkg_config_info()

cscripts.csinfo.get_pkg_config_info	(		info,
			library )

Get information from pkg-config

Parameters
----------
info : str
    Information to extract
library : str
    Library name for which information is to be extracted

Returns
-------
out : str
    Information string, 'Not available' if pkg-config is not installed

Definition at line 303 of file csinfo.py.

References cscripts.csinfo.get_command_output().

Referenced by cscripts.csinfo.csinfo_setup_info().

Variable Documentation

COMSCRIPT_LIST

str cscripts.csinfo.COMSCRIPT_LIST

Initial value:

=  """
   comgendb      Generate COMPTEL database
   comlixfit     Fit model to data using SRCLIX algorithm
   comlixmap     Create TS map using SRCLIX algorithm
   comobsadd     Combine observations
   comobsback    Generate background model for COMPTEL observations
   comobsbin     Bin COMPTEL observations
   comobsmodel   Generate model for binned COMPTEL observations
   comobsres     Generate residuals of COMPTEL observations
   comobsselect  Select observations from COMPTEL database
   comobssim     Simulate COMPTEL observations
   compulbin     Generate pulse profiles for pulsars
   comsrcdetect  Detect source in TS map
"""

Definition at line 91 of file csinfo.py.

CSCRIPT_LIST

str cscripts.csinfo.CSCRIPT_LIST

Definition at line 52 of file csinfo.py.

CTOOL_LIST

str cscripts.csinfo.CTOOL_LIST

Initial value:

=  """
   ctbin         Generates counts cube
   ctbkgcube     Generates background cube
   ctbutterfly   Compute butterfly
   ctcubemask    Filter counts cube
   ctedispcube   Generates energy dispersion cube
   cterror       Calculates likelihood profile errors
   ctexpcube     Generates exposure cube
   ctfindvar     Search for source variability
   ctlike        Performs maximum likelihood fitting
   ctmapcube     Generates a map cube
   ctmodel       Computes model counts cube
   ctobssim      Simulate CTA observations
   ctphase       Computes the phase of each event
   ctprob        Computes event probability for a given model
   ctpsfcube     Generates point spread function cube
   ctselect      Selects event data
   ctskymap      Generates sky map
   cttsmap       Generates Test Statistics map
   ctulimit      Calculates upper limit
"""

Definition at line 27 of file csinfo.py.