TOC PREV NEXT INDEX

Put your logo here!


4 REFERENCE

This chapter provides a detailed description of the FIERA CCD software programmatic interface, namely functions, programs (including Command Definition Tables), scripts and include files, together with various template files.

4.1 Functions

Functions provided by the FIERA CCD software are grouped in the library libfcd.a, available on Workstation only.

The functions provided by the FIERA CCD software to external software are:

1. fcdCheckSetup. It checks the validity of a complete setup and returns also some computed values.
2. fcdGetCIName. It returns the name of the FIERA CCD Command Interface process.
3. fcdGetConf. It returns all configuration values for the camera used.
4. fcdGetIndexFromId. It returns the index of the exposure from its Id.

4.1.1 fcdCheckSetup
NAME
fcdCheckSetup, fcdCheckSetupWindow - Check a setup for a CCD camera


SYNOPSIS
#include "fcd.h"

ccsCOMPL_STAT fcdCheckSetup (
fcdCONFIG *config,
fcdSETUP *setup,
fcdSETUPRES *results,
ccsERROR *error
)

ccsCOMPL_STAT fcdCheckSetupWindow (
fcdCONFIG *config,
fcdSETUP *setup,
fcdSETUPRES *results,
ccsERROR *error
)


DESCRIPTION
These functions perform a static check of the defined setup parameters
against the configuration. This check does NOT do any dynamic check
against the current state of the camera.
The check is stopped after the first error detection and the function
returns with FAILURE.

fcdCheckSetup checks a complete setup. It also returns values derived
from the setup parameters.

fcdCheckSetupWindow checks only the part of the setup concerning
the windowed readout.

<config> IN information about camera configuration (see fcdGetConf)
<setup> IN/OUT structure containing exposure setup (see ccd.h)
<results> OUT structure containing check results (see ccd.h)
<error> OUT error structure



RETURN VALUES
SUCCESS if everything OK
FAILURE if error occurs


EXAMPLES
#include "fcd.h"
....
fcdCAMERA camera = {"myccd", ccsLOCAL_ENV};
fcdCONFIG config;
fcdSETUP setup;
fcdSETUPRES results;
ccsERROR error;
....
if (fcdGetConf(&camera, &config, &error) != SUCCESS)
{
... handle failure
}
....
fill in values in setup structure
....
if (fcdCheckSetup(&config, &setup, &results, &error) != SUCCESS)
{
... handle failure
}



SEE ALSO
fcdGetConf




- - - - - -
Last change: 11/04/01-11:45


4.1.2 fcdGetCIName
NAME
fcdGetCIName - Get name of Command Interface Process for a CCD camera


SYNOPSIS
#include "fcd.h"
void fcdGetCIName(fcdCAMERANAME camera,
ccsPROCNAME procName)


DESCRIPTION
This function returns the name of the only FIERA process communicating
with external sw through the CCS message system to control a specific
CCD camera.
<camera> IN name of the camera used
<procName> OUT name of the Command Interface process for camera used


RETURN VALUES
None


EXAMPLES
#include "fcd.h"
....
fcdCAMERA camera = {"myccd", ccsLOCAL_ENV};
ccsPROCESS fcdProcess;
....
fcdGetCIName(camera.name, fcdProcess);
... fcdProcess is now set to "ccdconCI_myccd"




- - - - - -
Last change: 11/04/01-11:45



4.1.3 fcdGetConf
NAME
fcdGetConf - Get information about a CCD camera configuration


SYNOPSIS
#include "fcd.h"
ccsCOMPL_STAT fcdGetConf(fcdCAMERA *camera,
fcdCONFIG *config,
ccsERROR *error)


DESCRIPTION
This function returns information concerning the configuration of a
CCD camera, which might be needed by software packages using the
FIERA sw.
<camera> IN structure containing the following elements:
- name name of the camera used
- envName name of the CCS environment where
FIERA software runs. It can be set to
ccsLOCAL_ENV for local env.
<config> OUT information about camera configuration
<error> OUT error structure


RETURN VALUES
SUCCESS if everything OK
FAILURE if error occurs


EXAMPLES
#include "fcd.h"
....
fcdCAMERA camera = {"myccd", ccsLOCAL_ENV};
fcdCONFIG config;
ccsERROR error;
....
if (fcdGetConf(&camera, &config, &error) != SUCCESS)
{
... handle failure
}




- - - - - -
Last change: 11/04/01-11:45



4.1.4 fcdGetIndexFromId
NAME
fcdGetIndexFromId - extract exposure index from exposure id


SYNOPSIS
#include "fcd.h"

vltINT32 fcdGetIndexFromId( vltINT32 expId )


DESCRIPTION
This routine returns the exposure index of the database attribute
exposures:exposure_<expIndex> for the exposure associated to expId

<expId> IN exposure id


RETURN VALUES
Exposure Index (vltINT32)


EXAMPLES
#include "fcd.h"
....
vltINT32 expIndex;
vltINT32 expId;
....
expId = 1231;
expIndex = fcdGetIndexFromId(expId);
... expIndex is 1




- - - - - -
Last change: 11/04/01-11:45


4.2 Programs

The name of all CCD processes within their respective environment is built as <program name>_$CCDNAME.

The only program representing the Command Interface to external application software is fcdconCI, which runs on Workstation. The corresponding process for the camera myccd is therefore fcdconCI_myccd.

4.2.1 Command Definition Table for program fcdconCI

The Command Definition Table for the program fcdconCI_myccd can be found in $VLTROOT/CDT/fcdconCI.cdt (or $INTROOT/CDT/fcdconCI.cdt, if INTROOT is used).

4.3 Scripts

The scripts available on Workstation are:

1. fcdInstall.sh. Installation of files needed by the FIERA CCD sw for the camera used.
2. fcdDcsStart.sh. Cold Startup script.
3. fcdDcsWarmStart.sh. Warm Startup script.
4. fcdDcsStop.sh. Shutdown script.
5. fcdDcsDbSave.sh. Save current FIERA CCD configuration.
6. fcdDcsScan.sh. Define scan table for FIERA CCD DCS part
7. fcdosScan.sh. Define scan table for FIERA CCD standalone part.
8. fcdDcsWcs.sh. Set values in the FIERA CCD OLDB for World Coordinates display.
9. fcdDcsSetLogMask.sh. Set source mask for FITS logs
10. fcdDcsSlcuHalt.sh. Halt the SPARC LCU before shutting it down.
11. fcdDcsSlcuReboot.sh. Reboot the SPARC LCU.

4.3.1 fcdInstall.sh
NAME
fcdInstall.sh - Install FIERA files in INS_ROOT


SYNOPSIS
fcdInstall.sh <DbFile> [<ins_root_dir>]


DESCRIPTION
This shell script installs all files needed to run a FIERA system in the
root directory for the instrument it belongs to. Additionally, it
stores in the on-line database the values contained in configuration
files.

<DbFile> Name of the .dbcfg file in $VLTROOT/config containing DB
init values.
<ins_root_dir> root directory for the instrument the FIERA belongs to
Default: $INS_ROOT (env. variable)


FILES
$VLTROOT/config/fcd*.dbcfg
Files containing on-line database initialisation values for FIERA systems
known.
For scientific CCDs there is one file for each system to be delivered.
They normally have to be checked and possibly modified by experts of
the specific CCD system. The name is fcdSci<id>.dbcfg whereby <id> is
a symbolic name of the system.
Example: "myccd" CCD ---> fcdSciMyccd.dbcfg



ENVIRONMENT
CCDNAME CCD camera name
RTAPENV FIERA Rtap environment name
INS_ROOT default instrument root directory
INS_USER default to SYSTEM


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
> fcdInstall.sh fcdSciMyccd.dbcfg
Install all what needed for "myccd" scientific CCD


SEE ALSO
INS common sw specification




- - - - - -
Last change: 11/04/01-11:46


4.3.2 fcdDcsStart.sh
NAME
fcdDcsStart.sh - startup of FIERA DCS


SYNOPSIS
fcdDcsStart.sh [<camera>] [<WS env.>] [<SLCU env.>] [<INS root>] [kill]


DESCRIPTION
This shell script performs a startup of FIERA DCS.
No FIERA stand-alone module is started.
To be run once at startup only!
It performs the following steps:
1 - Load database configuration values on WS
2 - Run warm startup (fcdDcsWarmStart.sh)

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<WS env.> name of workstation environment (default env. var. RTAPENV)
If value is 0, no action on WS part of FIERA sw is taken
<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
If value is 0, no action on SLCU part of FIERA sw is taken
<INS root> INS_ROOT environment variable
kill kill all already running processes before starting


ENVIRONMENT
CCDNAME default for camera name (e.g. myccd)
RTAPENV default for WS local environment (e.g. myws)
CCDLENV default for SLCU environment (e.g myfiera)
INS_ROOT default root directory for instrument data


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
> fcdDcsStart.sh myccd myws myfiera
Start the FIERA DCS sw both at WS and SLCU level
for camera "myccd", WS environment "myws", SLCU environment "myfiera"

> fcdDcsStart.sh myccd myws 0
Start the FIERA DCS sw at WS level only
for camera "myccd", WS environment "myws"

> fcdDcsStart.sh myccd myws 0 $INS_ROOT kill
Kill and restart the FIERA DCS sw at WS level only
for camera "myccd", WS environment "myws"

> fcdDcsStart.sh myccd 0 myfiera
Start the FIERA DCS sw at SLCU level only
for camera "myccd", SLCU environment "myfiera"


SEE ALSO
fcdDcsStop.sh fcdDcsWarmStart.sh




- - - - - -
Last change: 11/04/01-11:46


4.3.3 fcdDcsWarmStart.sh
NAME
fcdDcsWarmStart.sh - warm startup of FIERA DCS


SYNOPSIS
fcdDcsWarmStart.sh [<camera>] [<WS env.>] [<SLCU env.>] [kill]


DESCRIPTION
This shell script performs a warm startup of FIERA DCS.
No FIERA stand-alone module is started.
To be run once at startup only!
It performs the following steps:
1 - Terminate all running processes
2 - Set SLCU sw in appropriate simulation mode
3 - Schedule processes
4 - Enable scanning of data from SLCU to WS

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<WS env.> name of workstation environment (default env. var. RTAPENV)
If value is 0, no action on WS part of FIERA sw is taken
<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
If value is 0, no action on SLCU part of FIERA sw is taken
kill kill all already running processes before starting


ENVIRONMENT
CCDNAME default for camera name (e.g. myccd)
RTAPENV default for WS local environment (e.g. myws)
CCDLENV default for SLCU environment (e.g myfiera)
INS_USER default SYSTEM
INS_HOST Host where the INS_ROOT directory is mounted. Default HOST


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
> fcdDcsWarmStart.sh myccd myws myfiera
Start the FIERA DCS sw both at WS and SLCU level
for camera "myccd", WS environment "myws", SLCU environment myfiera"

> fcdDcsWarmStart.sh myccd myws 0
Start the FIERA DCS sw at WS level only
for camera "myccd", WS environment "myws"

> fcdDcsWarmStart.sh myccd myws 0 kill
Kill and restart the FIERA DCS sw at WS level only
for camera "myccd", WS environment "myws"

> fcdDcsWarmStart.sh myccd 0 myfiera
Start the FIERA DCS sw at SLCU level only
for camera "myccd", SLCU environment "myfiera"


SEE ALSO
fcdDcsStart.sh fcdDcsStop.sh




- - - - - -
Last change: 11/04/01-11:46


4.3.4 fcdDcsStop.sh
NAME
fcdDcsStop.sh - shut-down FIERA DCS


SYNOPSIS
fcdDcsStop.sh [<camera>] [<WS env.>] [<SLCU env.>] [kill]


DESCRIPTION
This shell script performs a shut-down of FIERA DCS.
It does the following steps:
1 - Verify if the main process is running.
2 - Try to terminate FIERA processes in a 'soft' way (command EXIT)
3 - Try to terminate FIERA processes in a 'hard' way (command KILL) (opt.)
4 - Disable scanning of data from SLCU to WS

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<WS env.> name of workstation environment (default env. var. RTAPENV).
If value is 0, no action on WS part of FIERA sw is taken
<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
If value is 0, no action on SLCU part of FIERA sw is taken
kill kill all processes


ENVIRONMENT
CCDNAME default for camera name (e.g. myccd)
RTAPENV default for WS local environment (e.g. myws)
CCDLENV default for SLCU environment (e.g myfiera)


RETURN VALUES
0 if SUCCESS
1 if FAILURE


CAUTIONS
The "kill" options should be used with care. By killing processes
'blindly', the system could remain in a dangerous state. To be used
only to recover when the system gets stuck.


EXAMPLES
> fcdDcsStop.sh myccd myws myfiera
Terminate in a 'soft' way the FIERA sw both at WS and SLCU level
for camera "myccd", WS environment "myws", SLCU environment "myfiera"

> fcdDcsStop.sh myccd myws myfiera kill
Terminate in a 'hard' way the FIERA sw both at WS and SLCU level
for camera "myccd", WS environment "myws", SLCU environment "myfiera"

> fcdDcsStop.sh myccd myws 0 kill
Terminate in a 'hard' way the FIERA sw at WS level only
for camera "myccd", WS environment "myws"

> fcdDcsStop.sh myccd 0 myfiera
Terminate in a 'soft' way the FIERA sw at SLCU level only
for camera "myccd", SLCU environment "myfiera"


SEE ALSO
fcdDcsStart.sh, fcdDcsKill.sh




- - - - - -
Last change: 11/04/01-11:46


4.3.5 fcdDcsDbSave.sh
NAME
fcdDcsDbSave.sh - Save FIERA database values into backup file


SYNOPSIS
fcdDcsDbSave.sh [<camera>] [<env>] [<file>]


DESCRIPTION
This shell script reads some values from the FIERA WS database and
stores them into <file> using the utility dbBackup

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<env> environment where to read from (default env. var. RTAPENV)
<file> name of backup file
(default $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/<camera>.dbcfg)


FILES
fcdConfig.inp input file for utility dbBackup


ENVIRONMENT
CCDNAME default for camera name (e.g. myccd)
RTAPENV default environment (e.g. myws)
INS_ROOT default for instrument root directory
INS_USER default to SYSTEM if not defined


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
fcdDcsDbSave.sh myccd myws $INS_ROOT/$INS_USER/COMMON/CONFIGFILES/myccd.dbcfg


SEE ALSO
dbBackup




- - - - - -
Last change: 11/04/01-11:46


4.3.6 fcdDcsScan.sh
NAME
fcdDcsScan.sh - configure the DB values to be scanned from SLCU for

SYNOPSIS
fcdDcsScan.sh [<camera>] [<WS env.>] [<SLCU env.>] [<option>]


DESCRIPTION
This shell script configures the Scan System to retrieve DB values
for the FIERA SLCU to WS.

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<WS env.> name of workstation environment (default env. var. RTAPENV)
<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
<option> a (default) - add entries to scan list
c - clean entries from scan list
d - disable scanning from the SLCU
e - enable scanning from the SLCU


ENVIRONMENT
CCDNAME default for camera name (e.g. myccd)
RTAPENV default for WS local environment (e.g. myws)
CCDLENV default for SLCU environment (e.g. myfiera)


RETURN VALUES
0 if SUCCESS
1 if FAILURE


CAUTIONS
1 - It is assumed here that FIERA branch in the SLCU database is attached
directly to the root point (not a sub-point of something else).
2 - If this script is run twice or more, the system may not behave properly
any more. In this case better to shutdown the whole system and restart
it again.


EXAMPLES
fcdDcsScan.sh myccd myws myfiera
Add entries for camera "myccd", SLCU environment "myfiera",
WS environment "myws"
fcdDcsScan.sh myccd myws myfiera c
Clean entries for camera "myccd", SLCU environment "myfiera",
WS environment "myws"
fcdDcsScan.sh 0 myws myfiera d
Disable scanning from SLCU environment "myfiera" to
WS environment "myws"
fcdDcsScan.sh 0 myws myfiera e
Enable scanning from SLCU environment "myfiera" to
WS environment "myws"




- - - - - -
Last change: 11/04/01-11:46


4.3.7 fcdosScan.sh
NAME
fcdosScan.sh - configure the DB values to be scanned from SLCU for CCD OS


SYNOPSIS
fcdosScan.sh [<camera>] [<WS env.>] [<SLCU env.>] [<option>]


DESCRIPTION
This shell script configures the Scan System to retrieve DB values
from the FIERA SLCU to WS (stand-alone part only).

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<WS env.> name of workstation environment (default env. var. RTAPENV)
<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
<option> a (default) - add entries to scan list
c - clean entries from scan list
d - disable scanning from the SLCU
e - enable scanning from the SLCU


ENVIRONMENT
CCDNAME default for camera name (e.g. myccd)
RTAPENV default for WS local environment (e.g. myws)
CCDLENV default for SLCU environment (e.g myfiera)


RETURN VALUES
0 if SUCCESS
1 if FAILURE


CAUTIONS
1 - It is assumed here that CCD branch in the SLCU database is attached
directly to the root point (not a sub-point of something else).
2 - If this script is run twice or more, the system may not behave properly
any more. In this case better to shutdown the whole system and restart
it again.


EXAMPLES
fcdosScan.sh myccd myws myfiera
Add entries for camera "myccd", SLCU environment "myfiera",
WS environment "myws"
fcdosScan.sh myccd myws myfiera c
Clean entries for camera "myccd", SLCU environment "myfiera",
WS environment "myws"
fcdosScan.sh myccd myws myfiera e
Enable entries for camera "myccd", SLCU environment "myfiera",
WS environment "myws"


SEE ALSO
fcdDcsScan.sh




- - - - - -
Last change: 11/04/01-11:46


4.3.8 fcdDcsWcs.sh
NAME
fcdDcsWcs.sh - Set World Coordinate values in OLDB for CCD camera


SYNOPSIS
fcdDcsWcs.sh <camera> <WS env.> <xrefpix> <yrefpix>
<secpix> <rotate> <equinox> <epoch> <proj>


DESCRIPTION
This shell script writes in the WS FIERA OLDB the values of attributes
related to the display of World Coordinates with rtd.
It is meant as a utility to applications having to configure the
WCS parameters for the camera used.

<camera> camera name, also root point in DB
<WS env.> name of workstation environment
<xrefpix> X Coordinate of Reference Pixel
<yrefpix> Y Coordinate of Reference Pixel
<secpix> Number of arcseconds per pixel
<rotate> Rotation angle (clockwise positive) in degrees
<equinox> Equinox of coordinates, 1950 and 2000 supported
<epoch> Epoch of coordinates, used for FK4/FK5 conversion
<proj> Projection


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
> fcdDcsWcs.sh myccd myws 200.0 145.0 0.3 0.0 1950 0.0 PIXEL
Reference pixel [200.0;145.0]
Each pixel covers 0.3 arcseconds
Rotation angle is 0.0 degrees
Equinox of ccordinates set to 1950
Epoch of ccordinates set to 0.0
Projection set to PIXEL


SEE ALSO
rtdImageEvent.h for more information about parameters meaning and
possible values




- - - - - -
Last change: 11/04/01-11:46


4.3.9 fcdDcsSetLogMask.sh
NAME
fcdDcsSetLogMask.sh - Set FITS logging mask in OLDB for CCD camera


SYNOPSIS
fcdDcsSetLogMask.sh <camera> <WS env.> <logMask>


DESCRIPTION
This shell script writes in the WS CCD OLDB the value of the attribute
related to the FITS logging of main info.
An update of the $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/<camera>.dbcfg file
is performed. As well a snap of the WS CCD OLDB is made.
It is meant as a utility to applications having to configure the
logMask parameter for the camera used.

<camera> camera name, also root point in DB
<WS env.> name of workstation environment
<logMask> Mask for FITS logging


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
> fcdDcsSetLogMask.sh myccd myws UT1AGA
FITS Logs [UT1AGA]




- - - - - -
Last change: 11/04/01-11:46


4.3.10 fcdDcsSlcuHalt.sh
NAME
fcdDcsSlcuHalt.sh - halt FIERA SLCU


SYNOPSIS
fcdDcsSlcuHalt.sh [<SLCU env.>]


DESCRIPTION
This shell script performs a halting of FIERA SLCU.

<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
If value is 0, no action on FIERA SLCU is taken


ENVIRONMENT
CCDLENV default for SLCU environment (e.g myfiera)


RETURN VALUES
0 if SUCCESS
1 if FAILURE


EXAMPLES
> fcdDcsSlcuHalt.sh myfiera
Halt the FIERA SLCU defined by the "myfiera" environment

> fcdDcsSlcuHalt.sh
Halt the FIERA SLCU defined by the CCDLENV environment




- - - - - -
Last change: 11/04/01-11:46



4.3.11 fcdDcsSlcuReboot.sh
NAME
fcdDcsSlcuReboot.sh - Reboots FIERA DCS SLCU


SYNOPSIS
fcdDcsSlcuReboot.sh [<camera>] [<WS env.>] [<SLCU env.>] [<option>]


DESCRIPTION
This shell script reboots the FIERA SLCU, independently from what is going
on there.

<camera> camera name, also root point in DB (default env. var. CCDNAME)
<WS env.> name of workstation environment (default env. var. RTAPENV).
If value is 0, no action on WS part of FIERA sw is taken
<SLCU env.> name of SLCU environment (default env. var. CCDLENV)
If value is 0, no action on SLCU part of FIERA sw is taken
<option> s - restart also the scan system


CAUTIONS
This script should be used with care. If anything is going on in the
SLCU it will get lost !!!!


EXAMPLES
> fcdDcsSlcuReboot.sh myccd 0 myfiera
Reboot SLCU defined by the "myfiera" environment, used for
camera "myccd"

> fcdDcsSlcuReboot.sh myccd myws myfiera s
Reboot SLCU defined by the "myfiera" environment, used for
camera "myccd" and restart the scan system


SEE ALSO
fcdDcsScan.sh




- - - - - -
Last change: 11/04/01-11:46


4.4 GUI classes

The following GUI classes, built with the VLT panel editor (see [11]) for being used within bigger application panels, are included in the library libfcdGuiPublic.tcl:

1. fcdExpStatus_uifClass. It displays the status of an exposure.
2. fcdIpStatus_uifClass. It displays the status of the real-time image processing on SLCU.
3. fcdExpSetup_uifClass. It displays the main setup definitions of the running exposure.
4. fcdReadoutSetup_uifClass. It displays the readout setup definitions of the running exposure.

4.4.1 fcdExpStatus_uifClass
NAME
fcdExpStatus_uifClass - GUI class for CCD exposure status display

Application panels who intend to use this class, must register to the
library libfcdGuiPublic.tcl.
All database attributes defined within this class are relative to the
root point of the camera used. Therefore, when importing an instance of
this class in a panel, the Database Current Working Point must be set
accordingly. For example, if the camera used is called "myccd", then
the CWP has to be <alias>myccd.

Note 1: The class shows the contents of the Workstation on-line database.
The CCS Scan System must be enabled and working in order to
retrieve the correct values from the FIERA SLCU.

Note 2: The class works only with exposures under the point
exposures:exposure_1


APPLICATION AREA
This class displays only output fields.
In the order from top to button, left to right:

"Exposure status"
String showing the current exposure status (updated on change).

"Remaining time (sec)"
Remaining integration time (sec) (updated on polling).

"Loop count"
Current repetition of the defined exposure (updated on polling).


BUGS
The attributes updated with a polling mechanism have a fixed polling rate.
The change of values, although faster in the database, might be shown on
the panel with some delay (up to 2 seconds).



- - - - - -
Last change: 11/04/01-11:46


4.4.2 fcdIpStatus_uifClass
NAME
fcdIpStatus_uifClass - GUI class for CCD image processing status display

Application panels who intend to use this class, must register to the
library libfcdGuiPublic.tcl.
All database attributes defined within this class are relative to the
point images:process relative to the root point of the camera used.
Therefore, when importing an instance of this class in a panel, the
Database Current Working Point must be set accordingly.
For example, if the camera used is called "myccd", then
the CWP has to be <alias>myccd:images:process.

Note: The class shows the contents of the Workstation on-line database.
The CCS Scan System must be enabled and working in order to
retrieve the correct values from the CCD SLCU.


APPLICATION AREA
This class displays only output fields.
In the order from top to button, left to right:

"Min"
Minimum pixel value over the image (updated on polling).

"Min"
Maximum pixel value over the image (updated on polling).

"RMS"
RMS value over the image (updated on polling).

"Intensity"
Intensity of the pixel closest to the centroid position computed
on SLCU. If set to 0, it indicates that no object has been detected.
(updated on polling).


BUGS
The attributes updated with a polling mechanism have a fixed polling rate.
The change of values, although faster in the database, might be shown on
the panel with some delay (up to 2 seconds).



- - - - - -
Last change: 11/04/01-11:46


4.4.3 fcdExpSetup_uifClass
NAME
fcdExpSetup_uifClass - GUI class for CCD exposure setup display

Application panels who intend to use this class, must register to the
library libfcdGuiPublic.tcl.
All database attributes defined within this class are relative to the
root point of the camera used.
Therefore, when importing an instance of this class in a panel, the
Database Current Working Point must be set accordingly.
For example, if the camera used is called "myccd", then
the CWP has to be <alias>myccd.

Note: The class shows the contents of the Workstation on-line database.
The CCS Scan System must be enabled and working in order to
retrieve the correct values from the FIERA SLCU.


APPLICATION AREA
This class displays only output fields.
In the order from top to button, left to right:

"Time(sec)"
Exposure time in seconds as defined by the user

"Repetitions"
Number of times the same exposure has to be repeated. A value of 0
means that the exposure has to be repeated forever until a STOP
command is issued

"File"
File where the last image has been saved.




- - - - - -
Last change: 11/04/01-11:46


4.4.4 fcdReadoutSetup_uifClass
NAME
fcdReadoutSetup_uifClass - GUI class for CCD readout setup display

Application panels who intend to use this class, must register to the
library libfcdGuiPublic.tcl.
All database attributes defined within this class are relative to the
root point of the camera used.
Therefore, when importing an instance of this class in a panel, the
Database Current Working Point must be set accordingly.
For example, if the camera used is called "myccd", then
the CWP has to be <alias>myccd.

Note: The class shows the contents of the Workstation on-line database.
The CCS Scan System must be enabled and working in order to
retrieve the correct values from the FIERA SLCU.


APPLICATION AREA
This class displays only output fields.
In the order from top to button, left to right:

"Speed"
Readout speed as defined by the user

"Binning"
"X"
Horizontal binning factor as defined by the user
"Y"
Vertical binning factor as defined by the user
"Window"
"#"
Window index followed by field indicating if the window is enabled
(YES) or not (NO)
"DimX"
Horizontal window size
"DimY"
Vertical window size
"FirstX"
Horizontal coordinate of window lower left corner
"FirstY"
Vertical coordinate of window lower left corner





- - - - - -
Last change: 11/04/01-11:46


4.5 Include files

All definitions needed by applications using the CCD software are contained in the file fcd.h.

It includes the files fcdDbPublic.h, which contains definitions of public database points/attributes, and fcdErrors.h, which contains the CCD error codes.

These files only are considered public and must be used by external applications.

Other include files are installed as well, since they are needed by more than one CCD software module; nevertheless they are considered as private files to the CCD software: external applications are not allowed to use information contained in them, and therefore they are not documented in this section.

The public include files fcd.h, fcdDbPublic.h and fcdErrors.h can be found in $VLTROOT/include/ (or $INTROOT/include, if INTROOT is used).


4.6 Database

This section contains examples (to be used as templates) of:

1. DATABASE.db file
2. USER.db file

4.6.1 Example for DATABASE.db file

//*****************************************************************************
//* E.S.O. - VLT project
//*
//* "@(#) $Id: DATABASE.db,v 1.7 2001/04/03 13:26:09 vltsccm Exp $"
//*
//* who when what
//* -------- -------- -----------------------------------------------
//* ccumani 11/11/95 Created
//*
//************************************************************************
//*
//*----------------------------------------------------------------------
//

//************************************************************************
//*
//* Template of DATABASE.db file for the FIERA database on the SPARC SLCU
//* and the INS Workstation
//*
//* This file contains CCS points that need to be customized to match
//* the actual configuration.
//*
//* The comments are guiding you to what shall/can be changed.
//*----------------------------------------------------------------------


//****************************************************************
// CCS DEFINITIONS
//****************************************************************

// Loads classes definition from standard file
#include "CCS.db"

//
// Loads points for CCS,
//
// REMEMBER: to edit the provided template to match the
// actual configuration
//
#include "USER.db"


//****************************************************************
// APPLICATION DEFINITIONS
//****************************************************************

// Replace "<CCDNAME>" with the camera name
#define CCDNAME <CCDNAME>
#define CCDROOT :Appl_data:<CCDNAME>
#include "fcd.db"

// If you want a second CCD:
// 1) Replace "<CCDNAME2>" with the camera name
// 2) Uncomment next lines
//#undef CCDNAME
//#undef CCDROOT
//#define CCDNAME <CCDNAME2>
//#define CCDROOT :Appl_data:<CCDNAME2>
//#include "fcd.db"


//
// ___oOo___






4.6.2 Example for USER.db file

//**************************************************************************
//* E.S.O. - VLT project
//*
//* "@(#) $Id: USER.db,v 1.7 2001/04/03 13:26:09 vltsccm Exp $"
//*
//* who when what
//* -------- -------- -----------------------------------------------
//* ccumani 11/11/95 Created
//* ccumani 20/03/00 "wmyccd" replaced by <WSENV> in SCAN SYSTEM points
//*
//*
//************************************************************************
//*
//* Template of USER.db file for the FIERA database on the SPARC SLCU
//* and the INS Workstation
//*
//* This file contains CCS points that need to be customized to match
//* the actual configuration.
//*
//* The comments are guiding you to what shall/can be changed.
//*----------------------------------------------------------------------

// Loads classes definition from standard file
#include "CCS.db"

//
//**************************************************************************
// SCAN SYSTEM points
//**************************************************************************
//

//
// - On the Workstation replace hereafter "<WSENV>" by the name of
// of the SLCU environment the WS shall scan from
// - On the SPARC SCLU replace hereafter "<WSENV>" by the name of
// the WS environment the SLCU shall report to
//
POINT "<VLT scan dev>" "ccs_config:scan config:LAN:<WSENV>"
BEGIN
ALIAS "<WSENV>"
END

//
//**************************************************************************
// SAMPLING PLOTTING points
//**************************************************************************
//
// If you need more plots, just duplicate this point, giving:
// - new point name
// - new alias
//

POINT PLOT "ccs_config:plot config:samplePlot"
BEGIN
ALIAS "samplePlot"
END

//
// ___oOo___


4.7 Setup files

This section contains an example of a complete FIERA CCD DCS file.

4.7.1 Example for complete FIERA CCD DCS setup file

#************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: fcdSetupComplete.det,v 2.55 2001/04/02 08:05:49 vltsccm Exp $"
#
# who when what
# -------- -------- ----------------------------------------------
# abalestr 09/07/97 created (ported from CCD software)
# rdonalds 16/06/98 Added new keywords for centroiding
# rdonalds 19/08/98 Added IPLLX, LLY ..
# ccumani 07/09/98 description for DET.WINi.RMS corrected
# ccumani 08/09/98 SUP keywords substituted with PAF
# ccumani 09/09/98 - DET.WIN1.NDIT, DET.WIN1.ASUIT1,
# DET.WIN<i>.BACKGND, DET.WIN<i>.THRMIN,
# DET.READ.SHIFT1, DET.READ.SHIFTYP added
# - keyword order reorganised, comments added
#

#
# PAF Header
# ----------
PAF.HDR.START; # Start of PAF Header
PAF.TYPE "Detector Setup"; # Type of PAF
PAF.ID " "; # ID for PAF
PAF.NAME " "; # Name of PAF
PAF.DESC " "; # Short description of PAF
PAF.CRTE.NAME " "; # Name of creator
PAF.CRTE.DAYTIM " "; # Civil Time for creation
PAF.LCHG.NAME " "; # Name of person/appl. changing
PAF.LCHG.DAYTIM " "; # Timestamp of last change
PAF.CHCK.NAME " "; # Name of appl. checking
PAF.HDR.END; # End of PAF Header


#
# Exposure definitions
# --------------------
DET.EXP.TYPE "Normal "; # Type of exposure as known to the CCD sw
DET.EXP.NREP 1; # number of repeated exposures
DET.EXP.TIMEREP 0.00; # Interval between two repeated exposures
DET.FRAM.TYPE "Normal "; # Type of frame
DET.WIN1.UIT1 1.000; # user defined subintegration time

# if "Multiple" exposure :
DET.WIN1.NDIT 3; # # of subintegrations
DET.WIN1.UIT2 2.000; # user defined subintegration time
DET.WIN1.UIT3 1.000; # user defined subintegration time
DET.WIN1.ASUIT1 "F"; # All UITi as UIT1 else as defined in UITi
DET.READ.SHIFT1 10; # Lines shifted between integration
DET.READ.SHIFTYP "idem"; # Line shift type

# readout mode and binning :
DET.READ.CLKIND 1; # Index of clock pattern used
DET.WIN1.BINX 1; # Binning factor along X
DET.WIN1.BINY 1; # Binning factor along Y

# image transmission and storage :
DET.FRAM.FITSMTD 2; # How image data have to be saved on disk
DET.FRAM.FITSUNC "myImage.fits"; # Name of disk file for uncompressed data
DET.DISPLAY 0; # real-time image display frame ID
DET.FRAM.SAMPLE 1; # Image sampling on workstation


#
# Window 1
# --------

# definition :
DET.WIN1.ST "F"; # If T, window enabled
DET.WIN1.STRX 200; # Lower left pixel in X
DET.WIN1.NX 20; # # of pixels along X
DET.WIN1.STRY 300; # Lower left pixel in Y
DET.WIN1.NY 20; # # of pixels along Y

# image analysis :
DET.WIN1.MINMAX "F"; # image extrema search performed
DET.WIN1.RMS 0; # image RMS calculation performed
DET.WIN1.CENTROID "none"; # type of centroiding calculation
DET.WIN1.BACKGND 0; # sky background
DET.WIN1.THRMIN 0; # lower threshold
DET.WIN1.IPFUNC "none"; # function for image analysis
DET.WIN1.IPLLX 0; # X offset from LL for image processing
DET.WIN1.IPLLY 0; # Y offset from LL for image processing
DET.WIN1.IPURX 0; # X offset from UR for image processing
DET.WIN1.IPURY 0; # Y offset from UR for image processing
DET.WIN1.REFX 210.00; # x position of reference star for centroiding
DET.WIN1.REFY 310.00; # y position of reference star for centroiding

#
# Window 2
# --------

# definition :
DET.WIN2.ST "F"; # If T, window enabled
DET.WIN2.STRX 1; # Lower left pixel in X
DET.WIN2.NX 20; # # of pixels along X
DET.WIN2.STRY 1; # Lower left pixel in Y
DET.WIN2.NY 20; # # of pixels along Y

# image analysis :
DET.WIN2.MINMAX "F"; # image extrema search performed
DET.WIN2.RMS 0; # image RMS calculation performed
DET.WIN2.CENTROID "none"; # type of centroiding calculation
DET.WIN2.BACKGND 0; # sky background
DET.WIN2.THRMIN 0; # lower threshold
DET.WIN2.IPFUNC "none"; # function for image analysis
DET.WIN2.IPLLX 0; # X offset from LL for image processing
DET.WIN2.IPLLY 0; # Y offset from LL for image processing
DET.WIN2.IPURX 0; # X offset from UR for image processing
DET.WIN2.IPURY 0; # Y offset from UR for image processing
DET.WIN2.REFX 10.00; # x position of reference star for centroiding
DET.WIN2.REFY 10.00; # y position of reference star for centroiding

# --- oOo ---


4.8 Image files

This section contains examples of:

1. FITS standard keywords written by the FIERA CCD DCS in the FITS header,
2. FITS hierarchical keywords written by the FIERA CCD DCS in a separate file,
3. FITS standard and hierarchical keywords written by the FIERA CCD DCS in the FITS header, when the "image extension per port" format (see 2.14.3.1) is chosen,
4. FITS hierarchical keywords written by the FIERA CCD DCS in a separate file, when the "image extension per port" (see 2.14.3.1) format is chosen.

4.8.1 Example of FITS standard keywords

In the following example, a mosaic of 2 chips is read via 2 outputs (one for each chip):

SIMPLE = T / Standard FITS format (NOST-100.0)

BITPIX = 16 / # of bits storing pix values

NAXIS = 2 / # of axes in frame

NAXIS1 = 1428 / # pixels/axis

NAXIS2 = 1365 / # pixels/axis

ORIGIN = `ESO ` / European Southern Observatory

DATE = `1998-03-25T12:48:06.935' / UT date when this file was written

CRVAL1 = 1.0 / value of X ref pixel

CRPIX1 = 1.0 / X Ref. pixel of center of rotation

CDELT1 = 3.0 / Binning factor

CTYPE1 = `PIXEL ` / Pixel coordinate system

CRVAL2 = 1.0 / value of X ref pixel

CRPIX2 = 1.0 / X Ref. pixel of center of rotation

CDELT2 = 3.0 / Binning factor

CTYPE2 = `PIXEL ` / Pixel coordinate system

BSCALE = 1.0 / pixel=FITS*BSCALE+BZERO

BZERO = 32768.0 / pixel=FITS*BSCALE+BZERO

MJD-OBS = 50897.53325434 / MJD start (1998-03-25T12:47:53.175)

DATE-OBS= `1998-03-25T13:47:53.175' / Date of observation

EXPTIME = 21.8394 / Total integration time

EXTEND = F / Extension may be present

4.8.2 Example of FITS hierarchical keywords

HIERARCH ESO DET ID = `CCD FIERA - Rev 2.10' / Detector system Id

HIERARCH ESO DET NAME = `ccdsusi - ccdsusi' / Name of detector system

HIERARCH ESO DET DATE = `1998-01-28' / Installation date

HIERARCH ESO DET DID = `ESO-VLT-DIC.CCDDCS,ESO-VLT-DIC.FCDDCS' / Ddictio

HIERARCH ESO DET BITS = 16 / Bits per pixel readout

HIERARCH ESO DET SOFW MODE = `Normal ` / CCD sw operational mode

HIERARCH ESO DET CHIPS = 2 / # of chips in detector array

HIERARCH ESO DET CHIP1 ID = `ccd45 ` / Detector chip identification

HIERARCH ESO DET CHIP1 NAME = `EEV44-80' / Detector chip name

HIERARCH ESO DET CHIP1 DATE = `1998-01-28' / Date of installation [YYYY-MM-DD]

HIERARCH ESO DET CHIP1 X = 1 / X location in array

HIERARCH ESO DET CHIP1 Y = 1 / Y location in array

HIERARCH ESO DET CHIP1 NX = 2048 / # of pixels along X

HIERARCH ESO DET CHIP1 NY = 4096 / # of pixels along Y

HIERARCH ESO DET CHIP1 PSZX = 15.0 / Size of pixel in X

HIERARCH ESO DET CHIP1 PSZY = 15.0 / Size of pixel in Y

HIERARCH ESO DET CHIP2 ID = `ccd46 ` / Detector chip identification

HIERARCH ESO DET CHIP2 NAME = `EEV44-80' / Detector chip name

HIERARCH ESO DET CHIP2 DATE = `1998-01-28' / Date of installation [YYYY-MM-DD]

HIERARCH ESO DET CHIP2 X = 2 / X location in array

HIERARCH ESO DET CHIP2 Y = 1 / Y location in array

HIERARCH ESO DET CHIP2 NX = 2048 / # of pixels along X

HIERARCH ESO DET CHIP2 NY = 4096 / # of pixels along Y

HIERARCH ESO DET CHIP2 PSZX = 15.0 / Size of pixel in X

HIERARCH ESO DET CHIP2 PSZY = 15.0 / Size of pixel in Y

HIERARCH ESO DET EXP ID = 21 / Unique exposure ID number

HIERARCH ESO DET EXP TYPE = `Normal ` / Exposure type

HIERARCH ESO DET EXP DUMDIT = 0 / # of dummy readouts

HIERARCH ESO DET EXP RDTTIME = 6.815 / image readout time

HIERARCH ESO DET EXP XFERTIM = 29.675 / image transfer time

HIERARCH ESO DET READ MODE = `normal ` / Readout method

HIERARCH ESO DET READ SPEED = `normal ` / Readout speed

HIERARCH ESO DET READ CLOCK = `readout L' / Readout clock pattern used

HIERARCH ESO DET OUTPUTS = 2 / # of outputs

HIERARCH ESO DET OUTREF = 0 / reference output

HIERARCH ESO DET OUT1 ID = `L ` / Output ID as from manufacturer

HIERARCH ESO DET OUT1 NAME = `L ` / Description of output

HIERARCH ESO DET OUT1 CHIP = 1 / index of chip it belongs to

HIERARCH ESO DET OUT1 X = 1 / X location of output

HIERARCH ESO DET OUT1 Y = 1 / Y location of output

HIERARCH ESO DET OUT1 NX = 2048 / valid pixels along X

HIERARCH ESO DET OUT1 NY = 4096 / valid pixels along Y

HIERARCH ESO DET OUT1 PRSCX = 50 / Prescan region in X

HIERARCH ESO DET OUT1 OVSCX = 46 / Overscan region in X

HIERARCH ESO DET OUT1 CONAD = 2.24 / Conversion from electrons to ADUs

HIERARCH ESO DET OUT1 GAIN = 0.45 / Gain for output

HIERARCH ESO DET OUT3 ID = `L ` / Output ID as from manufacturer

HIERARCH ESO DET OUT3 NAME = `L ` / Description of output

HIERARCH ESO DET OUT3 CHIP = 2 / index of chip it belongs to

HIERARCH ESO DET OUT3 X = 2049 / X location of output

HIERARCH ESO DET OUT3 Y = 1 / Y location of output

HIERARCH ESO DET OUT3 NX = 2048 / valid pixels along X

HIERARCH ESO DET OUT3 NY = 4096 / valid pixels along Y

HIERARCH ESO DET OUT3 PRSCX = 50 / Prescan region in X

HIERARCH ESO DET OUT3 OVSCX = 46 / Overscan region in X

HIERARCH ESO DET OUT3 CONAD = 2.26 / Conversion from electrons to ADUs

HIERARCH ESO DET OUT3 GAIN = 0.44 / Gain for output

HIERARCH ESO DET FRAM ID = 1 / Image sequencial number

HIERARCH ESO DET FRAM TYPE = `Normal ` / Type of frame

HIERARCH ESO DET WINDOWS = 1 / # of windows readout

HIERARCH ESO DET WIN1 STRX = 1 / Lower left pixel in X

HIERARCH ESO DET WIN1 STRY = 1 / Lower left pixel in Y

HIERARCH ESO DET WIN1 NX = 1428 / # of pixels along X

HIERARCH ESO DET WIN1 NY = 1365 / # of pixels along Y

HIERARCH ESO DET WIN1 BINX = 3 / Binning factor along X

HIERARCH ESO DET WIN1 BINY = 3 / Binning factor along Y

HIERARCH ESO DET WIN1 NDIT = 1 / # of subintegrations

HIERARCH ESO DET WIN1 UIT1 = 30.000 / user defined subintegration time

HIERARCH ESO DET WIN1 DIT1 = 21.8394 / actual subintegration time

HIERARCH ESO DET WIN1 DKTM = 36.3018 / Dark current time

HIERARCH ESO DET SHUT TYPE = `Slit ` / type of shutter

HIERARCH ESO DET SHUT ID = `ccdsusi shutter' / Shutter unique identifier

HIERARCH ESO DET SHUT TMOPEN = 0.000 / Time taken to open shutter

HIERARCH ESO DET SHUT TMCLOS = 0.000 / Time taken to close shutter

HIERARCH ESO DET TELE INT = 1.0 / Interval between two successive te

HIERARCH ESO DET TELE NO = 2 / # of sources active

HIERARCH ESO DET TLM0 NAME = `CCD Temp' / Description of telemetry param.

HIERARCH ESO DET TLM0 ID = `CCD Temp' / ID of telemetry sensor

HIERARCH ESO DET TLM0 START = 273.10 / Telemetry value at read start

HIERARCH ESO DET TLM0 END = 273.20 / Telemetry value at read completion

HIERARCH ESO DET TLM1 NAME = `Elec Temp' / Description of telemetry param.

HIERARCH ESO DET TLM1 ID = `Elec Temp' / ID of telemetry sensor HIERARCH ESO DET TLM1 START = 300.41 / Telemetry value at read start

HIERARCH ESO DET TLM1 END = 300.52 / Telemetry value at read completion

4.8.3 Example of FITS standard keywords (Image Extension per Port)

In the following example, a mosaic of 2 chips is read via 2 outputs (one for each chip):

SIMPLE = T / Standard FITS format (NOST-100.0)
BITPIX = 16 / # of bits storing pix values
NAXIS = 0 / # of axes in frame
ORIGIN = 'ESO ' / European Southern Observatory
DATE = '1998-06-24T17:01:20.042' / UT date when this file was written
MJD-OBS = 50988.62516799 / MJD start (1998-06-24T15:00:14.515)
DATE-OBS= '1998-06-24T17:00:14.514' / Date of observation
EXPTIME = 0.0443 / Total integration time
EXTEND = T / Extension may be present



END


XTENSION= 'IMAGE ' / Extension first keyword (see SIMPLE)
BITPIX = 16 / # of bits storing pix values
NAXIS = 2 / # of axes in frame
NAXIS1 = 2144 / # pixels/axis
NAXIS2 = 4096 / # pixels/axis
PCOUNT = 0 / Number of parameters per group
GCOUNT = 1 / Number of groups
EXTNAME = 'WIN1.CHIP1.OUT1' / Extension name
ORIGIN = 'ESO ' / European Southern Observatory
DATE = '1998-06-24T17:01:20.042' / UT date when this file was written
CRVAL1 = 1.0 / value of ref pixel
CRPIX1 = 51.0 / Ref. pixel of center of rotation
CDELT1 = 1.0 / Binning factor
CTYPE1 = 'PIXEL ' / Pixel coordinate system
CRVAL2 = 1.0 / value of ref pixel
CRPIX2 = 1.0 / Ref. pixel of center of rotation
CDELT2 = 1.0 / Binning factor
CTYPE2 = 'PIXEL ' / Pixel coordinate system
BSCALE = 1.0 / pixel=FITS*BSCALE+BZERO
BZERO = 32768.0 / pixel=FITS*BSCALE+BZERO
MJD-OBS = 50988.62516799 / MJD start (1998-06-24T15:00:14.515)
DATE-OBS= '1998-06-24T17:00:14.514' / Date of observation
EXPTIME = 0.0443 / Total integration time
HIERARCH ESO DET CHIP INDEX = 1 / Chip index
HIERARCH ESO DET CHIP ID = 'ccd45 ' / Detector chip identification
HIERARCH ESO DET CHIP NAME = 'EEV44-80' / Detector chip name
HIERARCH ESO DET CHIP DATE = '1998-01-28' / Date of installation [YYYY-MM-DD]
HIERARCH ESO DET CHIP X = 1 / X location in array
HIERARCH ESO DET CHIP Y = 1 / Y location in array
HIERARCH ESO DET CHIP NX = 2048 / # of pixels along X
HIERARCH ESO DET CHIP NY = 4096 / # of pixels along Y
HIERARCH ESO DET CHIP PSZX = 15.0 / Size of pixel in X
HIERARCH ESO DET CHIP PSZY = 15.0 / Size of pixel in Y
HIERARCH ESO DET CHIP XGAP = 96.000000 / Gap between chips along x
HIERARCH ESO DET CHIP YGAP = 0.000000 / Gap between chips along y
HIERARCH ESO DET OUT INDEX = 1 / Output index
HIERARCH ESO DET OUT ID = 'L ' / Output ID as from manufacturer
HIERARCH ESO DET OUT NAME = 'L ' / Description of output
HIERARCH ESO DET OUT CHIP = 1 / Chip to which the output belongs
HIERARCH ESO DET OUT X = 1 / X location of output
HIERARCH ESO DET OUT Y = 1 / Y location of output
HIERARCH ESO DET OUT NX = 2048 / valid pixels along X
HIERARCH ESO DET OUT NY = 4096 / valid pixels along Y
HIERARCH ESO DET OUT PRSCX = 50 / Prescan region in X
HIERARCH ESO DET OUT OVSCX = 46 / Overscan region in X
HIERARCH ESO DET OUT PRSCY = 0 / Prescan region in Y
HIERARCH ESO DET OUT OVSCY = 0 / Overscan region in Y
HIERARCH ESO DET OUT CONAD = 2.24 / Conversion from ADUs to electrons
HIERARCH ESO DET OUT GAIN = 0.45 / Conversion from electrons to ADU

END


[image data]


XTENSION= 'IMAGE ' / Extension first keyword (see SIMPLE)
BITPIX = 16 / # of bits storing pix values
NAXIS = 2 / # of axes in frame
NAXIS1 = 2144 / # pixels/axis
NAXIS2 = 4096 / # pixels/axis
PCOUNT = 0 / Number of parameters per group
GCOUNT = 1 / Number of groups
EXTNAME = 'WIN1.CHIP2.OUT1' / Extension name
ORIGIN = 'ESO ' / European Southern Observatory
DATE = '1998-06-24T17:01:20.042' / UT date when this file was written
CRVAL1 = 1.0 / value of ref pixel
CRPIX1 = -2093.0 / Ref. pixel of center of rotation
CDELT1 = 1.0 / Binning factor
CTYPE1 = 'PIXEL ' / Pixel coordinate system
CRVAL2 = 1.0 / value of ref pixel
CRPIX2 = 1.0 / Ref. pixel of center of rotation
CDELT2 = 1.0 / Binning factor
CTYPE2 = 'PIXEL ' / Pixel coordinate system
BSCALE = 1.0 / pixel=FITS*BSCALE+BZERO
BZERO = 32768.0 / pixel=FITS*BSCALE+BZERO
MJD-OBS = 50988.62516799 / MJD start (1998-06-24T15:00:14.515)
DATE-OBS= '1998-06-24T17:00:14.514' / Date of observation
EXPTIME = 0.0443 / Total integration time
HIERARCH ESO DET CHIP INDEX = 2 / Chip index
HIERARCH ESO DET CHIP ID = 'ccd46 ' / Detector chip identification
HIERARCH ESO DET CHIP NAME = 'EEV44-80' / Detector chip name
HIERARCH ESO DET CHIP DATE = '1998-01-28' / Date of installation [YYYY-MM-DD]
HIERARCH ESO DET CHIP X = 2 / X location in array
HIERARCH ESO DET CHIP Y = 1 / Y location in array
HIERARCH ESO DET CHIP NX = 2048 / # of pixels along X
HIERARCH ESO DET CHIP NY = 4096 / # of pixels along Y
HIERARCH ESO DET CHIP PSZX = 15.0 / Size of pixel in X
HIERARCH ESO DET CHIP PSZY = 15.0 / Size of pixel in Y
HIERARCH ESO DET CHIP XGAP = 0.000000 / Gap between chips along x
HIERARCH ESO DET CHIP YGAP = 0.000000 / Gap between chips along y
HIERARCH ESO DET OUT INDEX = 1 / Output index
HIERARCH ESO DET OUT ID = 'L ' / Output ID as from manufacturer
HIERARCH ESO DET OUT NAME = 'L ' / Description of output
HIERARCH ESO DET OUT CHIP = 2 / Chip to which the output belongs
HIERARCH ESO DET OUT X = 2049 / X location of output
HIERARCH ESO DET OUT Y = 1 / Y location of output
HIERARCH ESO DET OUT NX = 2048 / valid pixels along X
HIERARCH ESO DET OUT NY = 4096 / valid pixels along Y
HIERARCH ESO DET OUT PRSCX = 50 / Prescan region in X
HIERARCH ESO DET OUT OVSCX = 46 / Overscan region in X
HIERARCH ESO DET OUT PRSCY = 0 / Prescan region in Y
HIERARCH ESO DET OUT OVSCY = 0 / Overscan region in Y
HIERARCH ESO DET OUT CONAD = 2.26 / Conversion from ADUs to electrons
HIERARCH ESO DET OUT GAIN = 0.44 / Conversion from electrons to ADU

END


[image data]


4.8.4 Example of FITS hierarchical keywords (Image Extension per Port)

HIERARCH ESO DET ID = 'CCD FIERA - Rev 2.22 ' / Detector system Id
HIERARCH ESO DET NAME = 'ccdtst1 - ccdsusi' / Name of detector system
HIERARCH ESO DET DATE = '1998-01-28' / Installation date
HIERARCH ESO DET DID = 'ESO-VLT-DIC.CCDDCS,ESO-VLT-DIC.FCDDCS' / Ddictio
HIERARCH ESO DET BITS = 16 / Bits per pixel readout
HIERARCH ESO DET CHIPS = 2 / # of chips in detector array
HIERARCH ESO DET OUTPUTS = 4 / # of outputs
HIERARCH ESO DET OUTREF = 0 / reference output
HIERARCH ESO DET WINDOWS = 1 / # of windows readout
HIERARCH ESO DET SOFW MODE = 'Embedded sw simulated' / CCD sw operational mode
HIERARCH ESO DET EXP ID = 31 / Unique exposure ID number
HIERARCH ESO DET EXP TYPE = 'Normal ' / Exposure type
HIERARCH ESO DET EXP RDTTIME = 2.235 / image readout time
HIERARCH ESO DET EXP XFERTIM = 44.040 / image transfer time
HIERARCH ESO DET WIN1 ST = T / If T, window enabled
HIERARCH ESO DET WIN1 STRX = 1 / Lower left pixel in X
HIERARCH ESO DET WIN1 STRY = 1 / Lower left pixel in Y
HIERARCH ESO DET WIN1 NX = 4288 / # of pixels along X
HIERARCH ESO DET WIN1 NY = 4096 / # of pixels along Y
HIERARCH ESO DET WIN1 BINX = 1 / Binning factor along X
HIERARCH ESO DET WIN1 BINY = 1 / Binning factor along Y
HIERARCH ESO DET WIN1 NDIT = 1 / # of subintegrations
HIERARCH ESO DET WIN1 UIT1 = 0.000 / user defined subintegration time
HIERARCH ESO DET WIN1 DIT1 = 0.0443 / actual subintegration time
HIERARCH ESO DET WIN1 DKTM = 0.0443 / Dark current time
HIERARCH ESO DET READ MODE = 'normal ' / Readout method
HIERARCH ESO DET READ SPEED = 'normal ' / Readout speed
HIERARCH ESO DET READ CLOCK = 'readout L' / Readout clock pattern used
HIERARCH ESO DET FRAM ID = 1 / Image sequencial number
HIERARCH ESO DET FRAM TYPE = 'Normal ' / Type of frame


4.9 Log files

This section contains examples of Configuration and operational logs in FITS format from a scientific CCD camera.

4.9.1 Example of FITS log from a Scientific CCD


15:14:52>-START DET SOFW / CCD control sw started [MSKSU]

15:14:52> DET SOFW ID = CCD Rev 2.10 / CCD control program name-version [MSKSU]

15:14:52> DET SOFW MODE = Normal / CCD sw operational mode [MSKSU]

15:14:52> DET STATE = LOADED / CCD sw state [MSKSU]

15:14:54>-CHANGE DET STATE / CCD sw state change [MSKSU]

15:15:30> DET SHUT TYPE = Slit / type of shutter [MSKSU]

15:15:30> DET SHUT ID = ccdsusi shutter / Shutter unique identifier [MSKSU]

15:15:12> DET STATE = STANDBY / CCD sw state [MSKSU]

15:15:12>-CHANGE DET STATE / CCD sw state change [MSKSU]

15:15:15>/World Coordinates: Enabled [MSKSU]

15:15:15> DET STATE = ONLINE / CCD sw state [MSKSU]

15:15:52>-START DET EXP / Start exposure [MSKSU]

15:15:52> DET EXP ID = 11 / Unique exposure ID number [MSKSU]

15:15:52>-START DET CHIP WIPE / CCD start wipe action [MSKSU]

15:15:55> DET CHIP WIPE STATUS = DONE / CCD wipe completed [MSKSU]

15:15:55>-OPEN DET SHUT / CCD shutter open [MSKSU]

15:16:03>-PAUSE DET EXP / Pause exposure [MSKSU]

15:16:03>-CLOSE DET SHUT / CCD shutter closed [MSKSU]

15:16:08>-RESUME DET EXP / Continue exposure [MSKSU]

15:16:08>-OPEN DET SHUT / CCD shutter open [MSKSU]

15:16:18>-STOP DET EXP / Stop integration / loop [MSKSU]

15:16:18>-CLOSE DET SHUT / CCD shutter closed [MSKSU]

15:16:18>-START DET CHIP READ / start readout of CCD chip [MSKSU]

15:15:52>-START DET TRANS / CCD data transfer started [MSKSU]

15:16:25> DET CHIP READ STATUS = DONE / CCD chip readout completed [MSKSU]

15:15:59> DET TRANS STATUS = DONE / CCD data transfer completed [MSKSU]

15:16:56>-START DET EXP / Start exposure [MSKSU]

15:16:56> DET EXP ID = 21 / Unique exposure ID number [MSKSU]

15:16:56>-START DET CHIP WIPE / CCD start wipe action [MSKSU]

15:16:59> DET CHIP WIPE STATUS = DONE / CCD wipe completed [MSKSU]

15:16:59>-OPEN DET SHUT / CCD shutter open [MSKSU]

15:17:09>-CLOSE DET SHUT / CCD shutter closed [MSKSU]

15:17:11>-START DET CHIP READ / start readout of CCD chip [MSKSU]

15:16:45>-START DET TRANS / CCD data transfer started [MSKSU]

15:17:17> DET CHIP READ STATUS = DONE / CCD chip readout completed [MSKSU]

15:16:51> DET TRANS STATUS = DONE / CCD data transfer completed [MSKSU]

15:30:49>-CHANGE DET STATE / CCD sw state change [MSKSU]

15:30:50> DET STATE = OFF / CCD sw state [MSKSU]

4.10 Error messages files

The error definition file fcd_ERRORS can be found in $VLTROOT/ERRORS/ (or $INTROOT/ERRORS, if INTROOT is used).



Quadralay Corporation
http://www.webworks.com
Voice: (512) 719-3399
Fax: (512) 719-3606
sales@webworks.com
TOC PREV NEXT INDEX