next up previous contents index
Next: 5. File Formats Up: aXeSIM 1.1 User Manual Previous: 3. Illustrated aXeSIM examples   Contents   Index

Subsections

4. The aXeSIM tasks


4.1 High Level Tasks - Low Level Tasks

Following the tradition of the aXe software package, aXeSIM contains two levels of tasks, the so called Low Level Tasks and the so called High Level Tasks (curently there exists only one of the latter, simdata).

While the Low Level Tasks perform one special step each, the High Level Tasks successively do a series of processing steps to generate complete simulated images as output from the basic input. The High Level Tasks use the Low Level Tasks for the individual steps.

The 'normal' user who simulates only one object will likely just use the High Level Task. For specific applications and large series of simulations, e.g. to determine limiting depths in deep fields, it might have advantages to use the Low Level Tasks saving time if successive steps need to be repeated.


4.2 High Level Tasks


4.2.1 SIMDATA

4.2.1.1 Description

This task generates the simulated data, which is the simulated dispersed image and, if requested, the simulated direct image. simdata comprises all the simulation possibilities available in aXeSIM, hence this is the only task most users will ever use.
Internally, simdata executes several to all Low Level Tasks (depending on the parameters).

4.2.1.2 Usage

simdata incat config [...]

4.2.1.3 Parameters

incat, mandatory, [string]
    The filename of the Model Object Table with the source list to be
    simulated. There is a minimal list of columns and additional columns
    which have to be present for certain direct image models.

config, mandatory [string]
    The name of the aXe configuration file to be used in the simulations.

output_root, optional [string]
    Root name for all output products. If not given, the root name is derived
    from the name of the Model Object Table

silent, optional [boolean, default='yes']
    The silent mode reduces the output written to the screen.

inlist_spec, mandatory, [string]
    The name of the Spectrum Template List. The template spectra therein can
    have ASCII or fits format.

tpass_flux, optional [string]
    Total passband to be used for the scaling of the template spectra in the
    flux space. This is either an ASCII- or fits-file name, or an expression
    of the form ``lambda_min, lambda_max'' [nm]. In the latter case the
    passband has a boxcar shape with lambda_min and lambda_max
    as boundaries.

inlist_ima, mandatory, [string]
    The Image Template List. The template images listed therein must
    have fits format.

lambda_psf, optional [float]
    The wavelength where the object extent A_IMAGE and B_IMAGE was determined.

nx_disp, optional, [int]
    The dimension of the simulated dispersed image in x

ny_disp, optional, [int]
    The dimension of the simulated dispersed image in y

exptime_disp, optional [float]
    The exposure time. If given, noise will be added to the simulated
    dispersed image.

bck_flux_disp, optional [float/string]
    The background flux rate or a background image, both in [e/s],
    for the dispersed image.

extraction, optional [boolean, default='yes']
    Flag to initialize a dummy spectral extraction on the simulated
    dispersed image.

tpass_direct, optional [string]
    Total passband of the optical system to be simulated.
    The can be in fits- or ASCII format. In case this parameter is
    not given, no direct image will be produced.

nx_dir, optional, [int]
    The dimension of the simulated direct image in x

ny_dir, optional, [int]
    The dimension of the simulated direct image in y

exptime_dir, optional [float]
    The exposure time. If given, noise will be added to the simulated
    direct image.

bck_flux_dir, optional [float/string]
    The background flux rate or a background image, both in [e/s],
    for the direct image.

version, optional [string]
    Parameter to always have the version number accessible. No need to
    ever change/use or even touch it.

4.2.1.4 Input an Output

Input:

Output:

% latex2html id marker 3666
$\textstyle \parbox{4.5in}{{\bf Usage scenario for ...
...m Now simulate the slitless image using the task {\tt simdispim}
\end{itemize}}$


4.3 Low Level Tasks

As aleady mentioned in previous chapters, few users will benefit from using the Low Level Tasks for their simulations. The box on page [*] describes a usage scenario based on Low Level Tasks. Most users will exclusively work with the High Level Task presented in Sect. 4.2.


4.3.1 PREPIMAGES

4.3.1.1 Description

This task generates the multi-extension fits image with normalized image templates to be used in simdata, simdispim or simdirim. The input is a list of template images in fits format. These templates are normalized to an integrated intensity of 1.0 and stored as a multi-extension fits image.

4.3.1.2 Usage

prepimages inlist [...]

4.3.1.3 Parameters

inlist, mandatory, [string]
    The Image Template List. The template images listed therein must
    have fits format.

model_images, optional, [string]
    Name of the multi-extension fits images containing the normalized
    template images.

4.3.1.4 Input an Output

Input:

Output:


4.3.2 PREPSPECTRA

4.3.2.1 Description

This task generates the multi-extension fits table with the spectra to be used by the tasks simdata, simdispim or simdirim. The task uses as input the template spectra (assumed restframe) in a two column ASCII- or fits-format plus a description concerning the redshift and flux scale. This description is given in the form of an input catalogue called Model Object Table. The output is a multi-dimension fits table. Every extension represents a template spectrum shifted to a certain redshift and scaled to some flux value specified in the corresponding row of the input table.

4.3.2.2 Usage

prepspectra inlist incat tpass_flux [...]

4.3.2.3 Parameters

inlist, mandatory, [string]
    The name of the Spectrum Template List. The template spectra therein can
    have ASCII or fits format.

incat, mandatory, [string]
    The Model Object Table with the magnitude values and redshift values
    to shift the template spectra in flux and redshift.

tpass_flux, mandatory [string]
    Total passband to be used for the scaling of the template spectra in the
    flux space. This is either an ASCII- or fits-file name, or an expression
    of the form ``lambda_min, lambda_max'' [nm]. In the latter case the
    passband has a boxcar shape with lambda_min and lambda_max
    as boundaries.

model_spectra, optional, [string]
    Name of the output multi-extension fits table to store the shifted
    template spectra.

4.3.2.4 Input an Output

Input:

Output:


4.3.3 SIMDIRIM

4.3.3.1 Description

This task generates a simulated direct image. The objects to be simulated are given in a Model Object Table. The total passband (parameter tpass_direct) and the object spectra determine the simulated object flux in [e/s]. It is possible to add Poisson noise (from sources, background and readout). The final output image will be in units of [e/s].

4.3.3.2 Usage

simdirim incat config [...]

4.3.3.3 Parameters

incat, mandatory, [string]
    The filename of the Model Object Table with the source list to be
    simulated.

config, mandatory [string]
    The name of the aXe configuration file to be used in the simulations.

tpass_direct, mandatory [string]
    Total passband of the optical system to be simulated.
    This can be in fits- or ASCII format.

dirima_name, optional [string]
    The name of the simulated image created by this task. If not given,
    a filename is derived from the name of the Model Object Table.

model_spectra, optional, [string]
    The multi-extension fits table with the input spectra to be used
    in the simulations.

model_images, optional, [string]
    The multi-extension fits image with the image templates to be used
    in the simulations.

nx, optional, [int]
    The dimension of the simulated direct image in x

ny, optional, [int]
    The dimension of the simulated direct image in y

exptime, optional [float]
    The exposure time. If given, noise will be added to the simulated
    direct image.

bck_flux, optional [float]
    The background flux rate or a background image, both in [e/s].

silent, optional [boolean, default='yes']
    The silent mode reduces the output written to the screen.

4.3.3.4 Input an Output

Input:

Output:


4.3.4 SIMDISPIM

4.3.4.1 Description

The task generates a simulated dispersed image. The objects to be simulated are given in a Model Object Table. The Model Object Table may contain references to extensions in a Model Spectra file and Model Image file to be used for specific objects. It is possible to add Poisson noise from sources, background and readout. The final output image will be in units of [e/s].

4.3.4.2 Usage

simdispim incat config [...]

4.3.4.3 Parameters

incat, mandatory, [string]
    The filename of the Model Object Table with the source list to be
    simulated.

config, mandatory [string]
    The name of the aXe configuration file to be used in the simulations.

dispim_name, optional [string]
    The name of the simulated dispersed image created by this task. If not
    given, a filename is derived from the name of the Model Object Table.

lambda_psf, optional [float]
    The wavelength where the object extent A_IMAGE and B_IMAGE was determined.

model_spectra, optional, [string]
    The multi-extension fits table with the input spectra to be used
    in the simulations.

model_images, optional, [string]
    The multi-extension fits image with the image templates to be used
    in the simulations.

nx, optional, [int]
    The dimension of the simulated dispersed image in x

ny, optional, [int]
    The dimension of the simulated dispersed image in y

exptime, optional [float]
    The exposure time. If given, noise will be added to the simulated
    dispersed image.

bck_flux, optional [float]
    The background flux rate or a background image, both in [e/s].

extraction, optional [boolean, default='yes']
    Flag to initialize a dummy spectral extraction on the simulated
    dispersed image.

silent, optional [boolean, default='yes']
    The silent mode reduces the output written to the screen.

4.3.4.4 Input an Output

Input:

Output:


next up previous contents index
Next: 5. File Formats Up: aXeSIM 1.1 User Manual Previous: 3. Illustrated aXeSIM examples   Contents   Index
mkuemmel@eso.org