
csmodelsois
===========

Generate a map cube from a subset of models in an input model.


Synopsis
----------

This script generates a map cube from a subset of sky model components contained
in an input model. A map cube is a series of sky maps, each spanned by Right
Ascension or Galactic longitude and Declination or Galactic latitude. Each map
corresponds to a specific photon energy. The energy binning of the map cube may
be either linear, logarithmic, or custom defined using an input file.

csmodelsois generates a map cube FITS file comprising two extensions. The
primary extension contains a 3-dimensional image containing the map cube
values. A second extension named ENERGIES contains a binary table that
defines the energy values of each map in the cube.

Optionally, csmodelsois can also output an updated model XML file in which all
sources from the input model XML file used to generate the map cube are
replaced with an updated model that uses the generated map cube. This is done
by specifying the outmodel parameter. The soilist parameter specifies a
list of source names (separated by ,) to be excluded from the generated
cube.


General parameters
------------------

inmodel [file]
    Input model XML file.

outcube [file]
    Output map cube file.

(ptsrcsig = 1.0) [real]
    Sigma of Gaussian to be used for point sources (in arcmin).

soilist [string]
    CSV list of source names to be excluded from the generated map cube.

outmodel [file]
    Output model XML file (not generated if set to NONE).

ebinalg <FILE|LIN|LOG> [string]
    Algorithm for defining energy bins. For FILE, the energy bins are defined
    in a FITS file that is specified by the ebinfile parameter, for LIN
    and LOG there will be enumbins energy bins spaced linearly or
    logarithmically between emin and emax, respectively.

emin [real]
    Lower energy value for first energy bin (in TeV).

emax [real]
    Upper energy value for last energy bin (in TeV).

enumbins [integer]
    Number of energy bins.

ebinfile [file]
    Name of the file containing the energy bin definition. You may use csebins
    to generate a file with appropriate energy bins.

nxpix [integer]
    Number of map cube bins in Right Ascension or Galactic longitude.

nypix [integer]
    Number of map cube bins in Declination or Galactic latitude.

binsz [real]
    Image scale (in degrees/pixel).

coordsys <CEL|GAL> [string]
    Coordinate system (CEL - celestial, GAL - galactic).

proj <AIT|AZP|CAR|GLS|MER|MOL|SFL|SIN|STG|TAN> [string]
    Projection method.

ra [real]
    Right Ascension of map cube centre (J2000, in degrees).

dec [real]
    Declination of map cube centre (J2000, in degrees).

glon [real]
    Galactic longitude of map cube centre (in degrees).

glat [real]
    Galactic latitude of map cube centre (in degrees).


Standard parameters
-------------------

(publish = no) [boolean]
    Specifies whether the map cube should be published on VO Hub.

(chatter = 2) [integer]
    Verbosity of the executable:
     chatter = 0: no information will be logged

     chatter = 1: only errors will be logged

     chatter = 2: errors and actions will be logged

     chatter = 3: report about the task execution

     chatter = 4: detailed report about the task execution

(clobber = yes) [boolean]
    Specifies whether an existing output counts cube file should be overwritten.

(debug = no) [boolean]
    Enables debug mode. In debug mode the executable will dump any log file output to the console.

(mode = ql) [string]
    Mode of automatic parameters (default is ql, i.e. "query and learn").

(logfile = csmodelsois.log) [string]
    Name of log file.


Related tools or scripts
------------------------

ctmapcube
