SUBJECT(hrc_lev2)                                                   CONTEXT(pipes)


SYNOPSIS

	HRC Level 2 pipeline to combine a stack of HRC Level 1 event files to one single 
	file.

DESCRIPTION


	HRC level 2 pipeline combines a stack of HRC Level 1 event files from the same 
	observation to one single file, create images, detect the sources and write to 
	the summary pages. 

	The following tools and scripts are run within the `hrc_lev2.ped' pipeline. See 
	the individual documentation for more details on each. 

	o) build_stk_filters - add gti filters to the HRC L1 event files.

	o) combine_events_stack - calls dmmerge to combine a stack of HRC L1 event files 
	from the same observation to a L2 event file.

	o) collect_target_pointing - calls dmmakepar. Write the L2 event file header to a 
	parameter file, which will provide the target ra and dec for dmcoords, and DETNAM 
	for the check_detector step.

	o) pixlib_setup_calib - set the correct pixlib parameters.

	o) dmcoords - find the central x and y pixels.

	o) check_detector - based on DETNAM, filter on status accordingly.

	o) I_filter_status - calls dmcopy to filter on status for HRC_I.

	o) S_filter_status - calls dmcopy to filter on status for HRC_S.

	o) events_2_center_image - convert the L2 event file into an image that contains 
	the center part of the data.

	o) events_2_full_image - calls dmcopy to convert the L2 event file into a full 
	field image.

	o) celldetect - detect sources from the HRC L2 event file.

	o) dmmakepar - make a par file from the events extenstion of HRC L2 event file.

	o) dmaddpar1 - calls dmreadpar to add parameters to the primary header of HRC L2 
	source fits file.

	o) fix_hdr_img1 - calls dmhedit to change the CONTENT keyword of the center image 
	to HIRESIMG.

	o) fix_hdr_img2 - dmhedit to change the CONTENT keyword of the full field image 
	to LORESIMG.

	o) update_revision - calls dmhedit change the value of revision.

	o) summary_page - create a summary of the observation using standard data 
	products. The output file will be in html or postscript format.

	o) remove - remove any temporay files that we don't need.



PARAMETERS

name			type	ftype	def	min	max	units	reqd	stacks	autoname
================================================================================================
clobber			boolean		no							
verbose			integer		0	0	5					
lookupTab		string									
principalTmp		string									
primaryTmp		string									
thresh			real		3.0							
findpeaks		boolean		yes							
fixedcell		integer		0							
eband			real		1.4967							
eenergy			real		0.8							
psftable		string									

DETAILED PARAMETER DESCRIPTIONS


clobber
	type=boolean
	def=no

	Clobber any existing output?


	Should the output be overwritten if it exists? 


verbose
	type=integer
	def=0
	min=0
	max=5

	display information about the processing. 0 produces no output and 5 produces the 
	most.


lookupTab
	type=string

	see dmmerge


principalTmp
	type=string

	template of the principal header for dmmakepar


primaryTmp
	type=string

	template of the primary header for dmreadpar


thresh
	type=real
	def=3.0

	see celldetect


findpeaks
	type=boolean
	def=yes

	see celldetect


fixedcell
	type=integer
	def=0

	see celldetect


eband
	type=real
	def=1.4967

	see celldetect


eenergy
	type=real
	def=0.8

	see celldetect


psftable
	type=string

	see celldetect


INPUT FILES


	The following are the lists of inputs files and stacks of files needed to run the 
	pipeline. 

	o) hrc L1 events --> hrc[root]_evt1.lis (list of Level 1 HRC event fits files)

	o) hrc L1 gti --> hrc[root]_std_flt1.lis (list of HRC Level 1 standard gti filter 
	files)

	root=[a letter][OBI_ID]N[3 digit processing version]

	eg. hrcf01246N001_evt1.lis ; hrcf01246N001_std_flt1.lis




OUTPUT PRODUCTS


	The following are the archived output products produced by the pipeline. 

	Primary Output Products

	o) hrc L2 events --------------> hrc[root]_evt2.fits



	Secondary Output Products

	o) whole hrc L2 image ---------> hrc[root]_full_img2.fits

	o) center hrc L2 image --------> hrc[root]_cntr_img2.fits

	o) source list ----------------> hrc[root]_src2.fits

	o) summary_pages-----> hrc[root]_full_img2.jpg, hrc[root]_cntr_img2.jpg, 
	hrc[root]_src_img2.jpg, hrc[root]_1_sum2.html, hrc[root]_2_sum2.html, 
	hrc[root]_3_sum2.html



	The pipeline log file is also included in the secondary products. It includes not 
	only the actual execution of the pipe, but all the retrevial and archive steps. 


PIPELINE ARGUMENTS


	The following arguments are needed to instanciate the pipeline to be run for a 
	particular obsid. 

	o) revision : Revision number

	o) obiroot : Root name of observation parameter file



	These should all be specified as "-a [parameter]=[value]" arguments to 
	pbuilder.pl or flt_run_pipe.pl 


VERSION

	DS6.0.0


LAST MODIFIED

	4 May 2001