base_flash $SSW/smm/gen/idl/widgets/base_flash.pro
[Previous] [Next]
 base_flash procedure makes a widget base flash a specified number
 of times, with a specified delay between flashes.  Does the flashing
 by making alternating between making the base sensitive and insensitive
 AKT 5/93
 CALLS:


BASELINES $SSW/smm/hxrbs/idl/baselines.pro
[Previous] [Next]

 NAME: 
       BASELINES

 PURPOSE:
       Used in pileup procedures.

 CATEGORY:
       HXRBS

 CALLING SEQUENCE:
	baselines,tsteps,seed,spectrum, blines,prob,startlive,pbase,slive

 CALLS: ***
	PULSETRAIN4
 INPUTS:
       none explicit, only through commons;

 OPTIONAL INPUTS:
	none

 OUTPUTS:
       none explicit, only through commons;

 OPTIONAL OUTPUTS:
	none

 KEYWORDS:
	none
 CALLED BY:
	DOBASELINE
 COMMON BLOCKS:
	none

 SIDE EFFECTS:
	none

 RESTRICTIONS:
	none

 PROCEDURE:
	none

 MODIFICATION HISTORY:
	ras, 1987
	Version 2, ras, June 1996


BCS $SSW/smm/xrp/idl/bcs/bcs.pro
[Previous] [Next]
 NAME:
             BCS
 PURPOSE:
             to provide GUI interface to BCS software 
 CATEGORY: 
             widgets 
 CALLING SEQUENCE:
             BCS
 CALLS: ***
	ATIME [1], ATIME [2], BCS_EVENT, BCS_HELP, BREAK_FILE [1], BREAK_FILE [2]
	BREAK_FILE [3], CHKLOG [1], CHKLOG [2], CLEANPLOT [1], CLEANPLOT [2]
	CLEANPLOT [3], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DERIV, FIT_SPEC
	GT_BSC_CHAN [1], GT_BSC_CHAN [2], LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], MKLOG
	PLOTSPEC, SET_UTLABEL, TWIDGET, WIDG_TYPE, WOBJECT, WR_ASC, XDISPLAYFILE [1]
	XDISPLAYFILE [2], XMANAGER, XMENU [1], XMENU [2], XREGISTERED, anytim [1]
	anytim [2], anytim [3], anytim [4], anytim [5], bda_wave [1], bda_wave [2]
	break_file [4], concat_dir [4], plotltc [1], plotltc [2], rdbda_smm, set_hard
 CALLED BY:
	SDAC
 RESTRICTIONS: 
             needs X-windows 
 MODIFICATION HISTORY:
             written Feb'92 by DMZ (ARC) 


bcspro [1] $SSW/smm/xrp/idl/bcs/bcspro.pro
[Previous] [Next]
 NAME:
	bcspro
 PURPOSE:
	spawn fortran BCSPRO program to compute Te & EM from BCS spectra
 CALLING SEQUENCE:
	bcspro
 INPUTS:
	prompts for BDA file, channels, etc
 OUTPUTS:
       BRR, CAL, and SPC files
 PROCEDURE:
       spawning
 RESTRICTIONS:
       VMS only
 MODIFICATION HISTORY:
       Written DMZ (ARC) June'93


bda_alpha $SSW/smm/xrp/idl/bcs/bda_alpha.pro
[Previous] [Next]
 Purpose:	Return BCS detector relative efficiency.

 Calling 
 Sequence:	DRE = Alpha (n, ichn,nbin)
 			where n = Bin Number (0:nbin-1)
			      ichn = Channel Number

 Method:	The efficiency is assumed to be 1 for the area of the detector
		which is at least 3 bins away from the detector notch. The
		efficiency for the two bins closest to the notch is set to
		0.01. For the next two bins on either side of the notch two
		lookup tables are used; ALPH1 for the next nearest bins and
		ALPH2 for the bins next to them. The position of notch is 
		offset be 3 because...

 
 Converted from fortran to IDL by Zarro (Feb'94)
 CALLED BY
	bda_sensit


bda_bcchfm $SSW/smm/xrp/idl/bcs/bda_bcchfm.pro
[Previous] [Next]
 Purpose:	
 This subroutine returns a pointer to the bcs data array which
 indicates the start of data corresponding to the requested
 channel and also returns the binlist corresponding to that
 channel. 


 Calling Sequence:
 CALL BCCHFM(LUNFMT,LUNBIN,IXREC,CHN,BINLST,STCNT,NUMCNT,IERR)
 Where LUNFMT (I2;S;I/P) = Lun for reading format lists file (BCSFMTLST.IDL)
       LUNBIN (I2;S;I/P) = Lun for reading bin lists file (BCSBINLST.IDL)
       IXREC  (I2;V;I/P) = Index record read from BCS index file 
       CHN    (I2;S;I/P) = BCS channel number
       BINLST ( B;V;O/P) = Bin List array read from BCSBINLST.IDL
       STCNT  (I2;S;O/P) = Byte number at which the current BCS block begins.	
       NUMCNT (I2;S;O/P) = Size of BCS block in bytes.
       IERR   (I2;S;I/O) = Error code 

 Method:
 The procedure calls GETFMT and GETBIN routines to read in format and bin lists
 if the index record indicates a change.

 Converted from fortran to IDL by Zarro (Jan'94)
 CALLS:
 CALLED BY
	rdbda_smm


bda_bcdabl $SSW/smm/xrp/idl/bcs/bda_bcdabl.pro
[Previous] [Next]
 subroutine bcdabl
 -----------------



 purpose:
 to read a complete bcs data block.


 call sequence:

 call bcdabl(lunda,ixrec,dabuf,ierr)

 lunda	(i2;s;i/p)	lun for reading bcs data file
 ixre; (i2;v;i/p)	index record read from bcs index file 
 dabuf	( b;v;o/p)	buffer containing bcs data
 ierr	(i2;s;o/p)	error code; (not used)

 method:
 this subroutine reads into a byte array dabuf the bcs block
 corresponding to the index record ixrec. lunda (integer*2) is the data
 file logical unit number and ierr (integer*4) is an error code. ierr
 is always returned as zero; other values of ierr and the corresponding
 errors are not yet defined. the size of dabuf is determined in the
 calling program. this subroutine requires dabuf to be at least 512
 bytes long and the bcs blocks require a size upto 1730 bytes. (maximum
 size of mode initialisation block with original unequal boundry bin
 list format.) 

 Converted from fortran to IDL by Zarro (Jan'94)
 CALLED BY
	rdbda_smm


bda_bixrcs $SSW/smm/xrp/idl/bcs/bda_bixrcs.pro
[Previous] [Next]
 purpose:
 to return the first index record of a specified type at or after
	the given time.

 calling sequence:

 call bixrcs (gday, gtim, id, chk, recno, ierr)

 integer*2	gday	! given day
 integer*4	gtim	! given time (ms of day)
 integer*2	id	! given bcs block id
 logical*1	chk	!.true. to reject blocks with a bad checksum
 integer*2	recno	! record number of required index record
 integer*4	ierr	! error code

 if chk is true only index records with good checksums are returned. 

 method:
 the index section of bda file is searched sequentially until a record
 with time greater than or equal to given time is found. the routine 
 assumes that the file is open on unit lunda. the data is returned in the
 common block bxrs01.

 error codes:		description		
    0		successful completion 
    1		no record of specified data type at or after
 		specified time
    2		error reading bda file record

 Converted from fortran to IDL by Zarro (Jan'94)
 CALLS:
 CALLED BY
	rdbda_smm


bda_degrp $SSW/smm/xrp/idl/bcs/bda_degrp.pro
[Previous] [Next]
       Purpose: apply degrouping and sensitivity correction to BCS spectra

       Written: 15-Mar-94, D. Zarro (ARC)
 CALLS:
 CALLED BY
	rdbda_smm


bda_expand $SSW/smm/xrp/idl/bcs/bda_expand.pro
[Previous] [Next]
 SUBROUTINE EXPAND
 __________ ______

Purpose:
	Subroutine to expand 'num' elements of a byte array
	'bcnt' into a real array 'rcnt'. 

Call:
	CALL EXPAND(IADD,RCNT,BCNT,NUM,ERRORS)
	INTEGER*2	IADD			!Flag to indicate if counts to be accumulated
	BYTE 		BCNT(1)			!Compressed counts
	REAL*4		RCNT(1)			!Expanded counts
	INTEGER*2 	NUM			!Number of counts (size of arrays RCNT and BCNT)
	INTEGER*4 	ERRORS			!Number of illegal counts

Method:
	The compressed value is used as an index to a lookup table
	containing the expanded counts.

	If 'IADD' .LE. 0 the expanded values are simply placed 
	in the array 'rcnt' but if 'iadd' .gt. 0 the expanded values are
	added to the values already in 'rcnt'.

	The number of errors (illegal values of 'bcnt') per call is
	returned in the integer*4 value 'errors'.

	Illegal values of 'bcnt' are expanded to  -0.001

	The common block EXPTAB is shared with the function FXPND.

 24 Jan 1994, Zarro, converted to IDL
 CALLED BY
	rdbda_smm


bda_getbin $SSW/smm/xrp/idl/bcs/bda_getbin.pro
[Previous] [Next]

 purpose:
	to retrieve a bin list or bin list header from the bin list 
	library.

 calling sequence:
	call getbin (lun,typ,irec,binlst,code)
	lun    = logical unit number of file 'bcsbinlst.idl'
	typ    = type code = last 2 bits of full 16-bit id
	irec   = record number where bin list starts
	binlst = a byte array to contain the bin list
	code   = 1 if only the first part of the bin list is to be read
		 header only if code=1, oterwise entire list.

 Converted from fortran to IDL by Zarro (Jan'94)
 CALLED BY
	bda_bcchfm


bda_getfmt $SSW/smm/xrp/idl/bcs/bda_getfmt.pro
[Previous] [Next]
 purpose:
	subroutine to retrieve a format list from the database.

 calling sequence:
	call getfmt (lun,iformt,inflst,ierr)
	lun    = logical unit number of file 'bcsfmtlst.idl'
	iformt = format id number
	ierr   = error code; 0 if format list found
	inflst = a 20 word array to contain the format list

 method:
	each of the basic 128 format lists are stored with pointers to the 
	next revision and the eighth next revision. the format id is used
	used as a pointer to a basic list. if a revision of the basic list
	required the revision pointers are used to step through the lists
 	until the required one is found.
	the format list returned by this subroutine is in internal format
	ie it is an 20 word array where each word is the record number of
	a binlist in the file 'bcsbinlst.idl'.

 commons:
	common /fmtcom/irec,rvpnt1,rvpn08

 Converted from fortran to IDL by Zarro (Jan'94)
 CALLS:
 CALLED BY
	bda_bcchfm


bda_nxtbdaixr $SSW/smm/xrp/idl/bcs/bda_nxtbdaixr.pro
[Previous] [Next]
 purpose:
	to return the successive index records of a specified type.
	

 calling sequence:

	status = nxtbdaixr (id, chk, recno, ierr)

	integer*2	id	; given bcs block id
	logical*1	chk	;.true. to reject blocks with a bad checksum
	integer*2	recno	; record number of required index record
	integer*4	ierr	; error code


	if chk is true only index records with good checksums are returned. 
 
 method:
	it is assumed that at least one index record has already been read 
 	from the bda index section, usually by calling the procedure bixrcs.
	this ensures that i) the structure ixr contains valid data, 
	ii) pointer to logical index record is defined and iii) record number
	indicating the starting position for searching next record is valid.
 	if the new record matches the criteria (data type and quality) the 
	process is terminated and the record is returned in the common block 
	bxrs01.                

	error codes:	-{n}: error reading record {n}. the rms error is returned
			      as the function result.
			   1: no record of specified data type was found at 
			      or after the specified time.


 Converted from fortran to IDL by Zarro (Jan'94)
 CALLS:
 CALLED BY
	rdbda_smm


bda_sensit $SSW/smm/xrp/idl/bcs/bda_sensit.pro
[Previous] [Next]
       Purpose: return BCS sensitivity and degrp arrays for 
                binlst and ichn

       Written: 1-Mar-94, D. Zarro (ARC)
 CALLS:
 CALLED BY
	bda_degrp


bda_wave [1] $SSW/smm/xrp/idl/bcs/bda_wave.pro
[Previous] [Next]
       Purpose: return BCS wavelength array for chan
       Written: 1-Mar-94, D. Zarro (ARC)
 CALLED BY
	BCS, GT_BSC_WAVE [1], GT_BSC_WAVE [2]


BOUST $SSW/smm/xrp/idl/fcs/boust.pro
[Previous] [Next]
 name:  BOUST

 purpose:  convert a time-continuous 2-D array to boustrophendonic
           especially for background data after INTERP2

 category:  lo-level, no user interaction

 calling sequence:  BOUST, a

 input parameters:
 name         type         description                              returned by
 a            xxxARR(m,n)
 
 optional inputs:  NONE

 output parameters:  
 name         type         description
 a            xxxARR(n,m)

 optional outputs:  NONE

 called by:  BKG_SUB

 calls to:  

 CALLS: ***
	REVERSE
 CALLED BY:
	GETFIS_1BLK
 common blocks:  NONE

 side effects:  NONE

 restrictions:  NONE

 procedure:  

 created:  04 OCT 90 by J D Hawley, Applied Physics Department,
                        Lockheed Missiles and Space Company, Inc.

 modified:  


bust $SSW/smm/xrp/idl/fcs/bust.pro
[Previous] [Next]
 NAME:
          bust
 PURPOSE:
          rebin image contained within structure
 CATEGORY:
          utility
 CALLING SEQUENCE:
         rimg=bust(img,f1,f2)
 INPUTS:
          img=input structure
          f1,f2 = factors by which to rebin dimensions
 OUTPUTS:
          rimg = rebinned image
 CALLS: ***
	RUST, binup
 CALLED BY:
	PLOTMAP
 PROCEDURE:
          uses BINUP
         
 MODIFICATION HISTORY:
          written July 1991 (DMZ, ARC)