cal_db_pedestals_create.c File Reference

Creates the include file used to build the loadable shareable image for the pedestals. More...

#include <stdio.h>
#include <stdlib.h>
#include <cal_import.h>
#include <cal_import_pedestals.h>
#include <calib_db_create.h>

Classes
struct	_Ctl
	The CAL include file creation control structure. More...
Typedefs
typedef struct _Ctl	Ctl
	Typedef for struct _Ctl.
Functions
static void	reportUsage (void)
	Brief explanation of the test creation usage.
static void	full_prepare (unsigned int *export, const float pedestals[16][8][12][4][2])
	Prepares the imported data for export.
static void	idealized_prepare (unsigned int *export, const float pedestals[4][2])
	Prepares the imported data for export.
static int	writeFile (FILE *hfile, const char *hname, const char *package, const char *constituent, const char *version, CALIB_DB_STYLE_K style, const char *origin_name, const char *style_name, unsigned int key, unsigned int tag, const unsigned int *export)
	Files and writes the output include file.
static int	fillCtl (Ctl *ctl, int argc, char *const argv[])
	Examines the command line parameters and fills the include file creation control structure.
static void	fillPedestals (unsigned short int *pedestals, const unsigned int *exports)
	Fills one layers worth of pedestals.
static int	writeLayer (FILE *hfile, int lyr, const unsigned short int v[24])
	Write one layers worth of constants.
int	CalDbPedestalsCreate (int argc, char *const argv[], const CalImportPedestals *import)
	Driver program to create CAL calibration include file.

---

Detailed Description

Creates the include file used to build the loadable shareable image for the pedestals.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: cal_db_pedestals_create.c,v 1.5 2011/03/25 02:40:52 apw Exp $

This program accepts a cal_pedestals.h file and converts it to a representation that is used to transform ADC values to Mev. This portion handles only the pedestal part of the linear transformation. The gains are done similarly, but by a different program.

The mechanism is fairly clunky, belonging to that ilk of programs whose mission is to write another program. In this case, the pedestal data is written out as data to a C data structure, called the schema. The resulting file is then compiled and built into a shareable image.

In addition to holding the data values, this schema also holds pointers to routines that are used to access the data. This tactic allows the interface to be stable, but effectively hides the internal representation of the data. Because the accessor routine's job is act as a go-between between the caller and the internal data, it must

1. Present a well-defined and stable interface to the user
2. Be privy to the detailed layout of the data

It is this last point that drives the design to include the implementation of these routines at the same time the data is defined. That keeps the two in lock step.

---

Typedef Documentation

Ctl

Typedef for struct _Ctl.

Contains all the parameters controlling the creation and content of the test include file.

---

Function Documentation

int CalDbPedestalsCreate	(	int	argc,
		char *const	argv[],
		const CalImportPedestals *	import
	)

Driver program to create CAL calibration include file.

Returns:

Status, if 0, then successfully created the output file

Parameters:

	argc	The count of input arguments
	argv	The vector of input arguments
	import	The imported database

References CALIB_DB_STYLE_K_FULL, CALIB_DB_STYLE_K_IDEALIZED, fillCtl(), full_prepare(), _Ctl::hname, idealized_prepare(), reportUsage(), and writeFile().

static int fillCtl	(	Ctl *	ctl,
		int	argc,
		char *const	argv[]
	)			[static]

Examines the command line parameters and fills the include file creation control structure.

Parameters:

	ctl	The parameter control block.
	argc	The number of command line parameters.
	argv	The array of pointers to the command line parameters.

Return values:

	0,Everything	is okay.
	-1,Incorrect	command usage. Usually this means that the input file name was absent.

References _Ctl::hname, and reportUsage().

Referenced by CalDbPedestalsCreate().

static void fillPedestals	(	unsigned short int *	pedestals,
		const unsigned int *	exports
	)			[static]

Fills one layers worth of pedestals.

Parameters:

	pedestals	The output gain array
	exports	The export data

Referenced by writeFile().

static void full_prepare	(	unsigned int *	export,
		const float	pedestals[16][8][12][4][2]
	)			[static]

Prepares the imported data for export.

Parameters:

	export	Filled with the data to be exported
	pedestals	The imported pedestal data

Referenced by CalDbPedestalsCreate().

static void idealized_prepare	(	unsigned int *	export,
		const float	pedestals[4][2]
	)			[static]

Prepares the imported data for export.

Parameters:

	export	Filled with the data to be exported
	pedestals	The imported pedestal data

Referenced by CalDbPedestalsCreate().

static int writeFile	(	FILE *	hfile,
		const char *	hname,
		const char *	package,
		const char *	constituent,
		const char *	version,
		CALIB_DB_STYLE_K	style,
		const char *	origin_name,
		const char *	style_name,
		unsigned int	key,
		unsigned int	tag,
		const unsigned int *	export
	)			[static]

Files and writes the output include file.

Returns:

Status

Parameters:

	hfile	The include file handle
	hname	The name of the output file
	package	The package name
	constituent	The constituent name
	version	The schema version number
	tag	The file's online tag (CMX version for example)
	style	The style (CALIB_DB_STYLE_K_FULL, CALIB_DB_STYLE_K_IDEALIZED)
	origin_name	The name of the originating data source ("GLEAM", "LAT", etc)
	style_name	The style name ("FULL", "IDEALIZED")
	key	The database's identifying key
	export	The constants to export

References calib_db_info_write(), calib_db_preamble_write(), CALIB_DB_STYLE_K_FULL, fillPedestals(), and writeLayer().

Referenced by CalDbPedestalsCreate().

static int writeLayer	(	FILE *	hfile,
		int	lyr,
		const unsigned short int	v[24]
	)			[static]

Write one layers worth of constants.

Parameters:

	hfile	The include file handle
	lyr	The layer number being written
	v	The 24 constants (12 columns * 2 logends) to write

Referenced by writeFile().