IAP2STC $SSW/soho/gen/idl/plan/science/iap2stc.pro
[Previous] [Next]
 Project     : SOHO-CDS

 Name        : IAP2STC

 Purpose     : convert IAP file (or array) to structure

 Category    : planning

 Explanation :

 Syntax      : stc=iap2stc(iap)

 CALLED BY:
	CHECK_KAP
 Examples    :

 Inputs      : IAP = IAP filename (or array read from IAP)

 Opt. Inputs : None

 Outputs     : STC = structured contents of IAP file

 Opt. Outputs: None

 Keywords    : ERR = error string

 CALLS: ***
	CONCAT_STRUCT, DATATYPE [1], DATATYPE [2], DATATYPE [3], DELVARX [1], DELVARX [2]
	DELVARX [3], DELVARX [4], EXIST, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3]
	RD_ASCII [1], RD_ASCII [2], TRIM, delvarx [5]
 Common      : None

 Restrictions: None

 Side effects: None

 History     : Written 9 January 1997, D. Zarro, ARC/GSFC

 Contact     : dzarro@solar.stanford.edu


IDL5TO4 $SSW/soho/cds/idl/util/misc/idl5to4.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IDL5TO4

 Purpose     :	Convert IDL/v5 array[] syntax to IDL/v4 array() syntax.

 Category    :	Utility

 Explanation :	In IDL version 5, square brackets were introduced as an
		alternate way of referencing an array, to avoid confusion
		between arrays and functions.  In prior versions of IDL, the
		syntax FRED(3) could be interpreted as either the third element
		of the array FRED, or as a call to the function FRED.  This
		syntax is still supported in IDL/v5, but the new syntax FRED[3]
		can be used to show that it is the third element of the array
		FRED which is desired, and not a function call.

		One of the problems that the new syntax resolves is that of
		routines where FRED(3) was intended to be used as an array
		subscripting, and was developed in an environment where there
		was no FRED function which could cause confusion.  If this
		routine was then moved to an environment where there was a FRED
		function, then the routine would no longer work correctly.
		Using FRED[3] solves this problem.

		Unfortunately, the syntax FRED[3] is not supported in earlier
		versions of IDL.  However, it may be that many routines would
		actually work in the earlier IDLs if the FRED[3] syntax was
		changed to FRED(3).  The routine IDL5TO4 makes this conversion.
		The modified routine should then work in earlier versions of
		IDL, assuming that there are no other version-specific aspects
		to the code.

 Syntax      :	IDL5TO4, FILENAME  [, OUTDIR ]

 Examples    :	IDL5TO4, '*.pro'		;Converts all procedure files
						;in current directory

		IDL5TO4, '*.pro', 'idlv4'	;Converted files written to
						;idlv4 subdirectory.

 Inputs      :	FILENAME = The name of the file(s) to process.  May be an array
			   of filenames, and may also contain wildcard
			   characters.

 Opt. Inputs :	OUTDIR = The name of a directory to write the converted files
			 to.  The directory must aleady exist--the routine will
			 not try to create it.  If not passed, then the files
			 will be replaced with the converted version at their
			 present location.

 Outputs     :	None.

 Opt. Outputs:	None.

 Keywords    :	ECHO   = If set, the a message line is printed for every file
			 processed.

		MOD_ONLY = If set, then only those files which require
			 changes will be processed.  Use this when not passing
			 the OUTDIR parameter, and you don't want the timestamp
			 of unaffected files changed.

		PATH   = If set, then contains a list of directories to process
			 in turn.  A plus sign before any directory will
			 translate into the entire directory tree.  For
			 example, the following command will process all .pro
			 files in the /cs/idl directory tree.

				IDL5TO4, '*.pro', PATH='+/cs/idl', /MOD_ONLY

		ERRMSG = If defined and passed, then any error messages will be
			 returned to the user in this parameter rather than
			 depending on the MESSAGE routine in IDL.  If no errors
			 are encountered, then a null string is returned.  In
			 order to use this feature, ERRMSG must be defined
			 first, e.g.

				ERRMSG = ''
				IDL5TO4, ERRMSG=ERRMSG, ...
				IF ERRMSG NE '' THEN ...

 Calls       : ***
	BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
	CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], FILE_EXIST [2]
	FIND_ALL_DIR [1], FIND_ALL_DIR [2], FIND_ALL_DIR [3], FIND_FILE, FIND_FILES
	OS_FAMILY, break_file [4], concat_dir [4], file_exist [1], file_exist [3]
 Common      :	None.

 Restrictions:	Although most situations should be accounted for, there may
		still be situations which are not adequately addressed by this
		routine.  One possible failure scenario is when a structure
		contains a tag name which exactly matches an IDL operator,
		e.g. "AND", "OR", "MOD", "EQ", etc.

		This routine may not work correctly in Windows or MacOS, if it
		needs to overwrite a file which already exists.  However, it
		should work okay if the output files are directed to an empty
		subdirectory.

 Side effects:	None.

 Prev. Hist. :	Partially based on IDLV5_TO_V4 by Wayne Landsman

 History     :	Version 1, 22-Jul-1998, William Thompson, GSFC
		Version 2, 04-Aug-1998, WIlliam Thompson, GSFC
			Fixed bug involving keywords.
			Added keywords PATH, MOD_ONLY

 Contact     :	WTHOMPSON


ieee2vax [2] $SSW/soho/mdi/idl_old/gen/ys_util/ieee2vax.pro
[Previous] [Next]
 NAME:
    ieee2vax
 PURPOSE:
    To convert Unix IDL floating/double to VAX IDL data types.
 CALLING SEQUENCE:
    ieee2vax, variable
 PARAMETERS:
    variable - The data variable to be converted.  This may be a scalar
	 or an array.
 CALLED BY:
	sun2vax [1], sun2vax [2], word_conv [1], word_conv [2], yoh_ieee2vax [1]
	yoh_ieee2vax [2]
 RESTRICTIONS:
	Only tested for data from IEEE standard Unix machines (e.g. SUN0
 MODIFICATION HISTORY:
	Version 1	By John Hoegy		13-Jun-88
	04-May-90 - WTT:  Created CONV_UNIX_VAX from VAX2SUN, reversing floating
			  point procedure.
       09-Sep-91 - TRM:  Caniballized CONV_UNIX_VAX
	19-May-93 - MDM:  Replace call to SWAP with a call to BYTEORDER


IEEE_TO_HOST [3] $SSW/soho/mdi/idl_old/gen/fits/ieee_to_host.pro
[Previous] [Next]
 NAME:
	IEEE_TO_HOST
 PURPOSE:
	To translate an IDL variable in IEEE-754 representation (as used, for
	example, in FITS data ), into the host machine architecture.

 CALLING SEQUENCE:
	IEEE_TO_HOST, data, [ IDLTYPE = , ]

 INPUT-OUTPUT PARAMETERS:
	data - any IDL variable, scalar or vector.   It will be modified by
		IEEE_TO_HOST to convert from IEEE to host representation.  Byte 
		and string variables are returned by IEEE_TO_HOST unchanged

 OPTIONAL KEYWORD INPUTS:
	IDLTYPE - scalar integer (1-7) specifying the IDL datatype according
		to the code given by the SIZE function.     This keyword
		is usually when DATA is a byte array to be interpreted as
		another datatype (e.g. FLOAT).

 CALLS: ***
	CONV_UNIX_VAX, SINCE_VERSION [1], SINCE_VERSION [2]
 CALLED BY:
	DBEXT_IND [1], DBEXT_IND [2], DBEXT_IND [3], DBFIND_SORT [1], DBFIND_SORT [2]
	DBFIND_SORT [3], DBINDEX [1], DBINDEX [2], DBINDEX [3], DBOPEN [1], DBOPEN [2]
	DBOPEN [3], DBWRT [1], DBWRT [2], DBWRT [3], DB_ENT2HOST [1], DB_ENT2HOST [2]
	DB_ENT2HOST [3], FITSFILE__DEFINE [2], FXBREAD [1], FXBREAD [2], FXBREAD [3]
	FXBREADM, FXREAD [1], FXREAD [2], GOES_3HOUR, GRS_EXTRACT, HESSI Packet Read [2]
	HSI_LOAD_STRUCT, HSI_PACKET2DETECTOREVENT, HSI_RD_RASPMT, HXRBS_ESC, MRDFITS [1]
	MRDFITS [2], PICK_LINE, READFITS [1], READFITS [2], READFITS [3], READFITSL
	READ_FULL_ATT, READ_MONTH_CAT, READ_RESULTS2, SUM_IMAGE_HEAD, bin_read
	hsi_ras_rdeph [1], hsi_ras_rdeph [2], hsi_rd_subcoll_response_table
	load_struct
 EXAMPLE:
	A 2880 byte array (named FITARR) from a FITS record is to be 
	interpreted as floating and converted to the host representaton:

	IDL> IEEE_TO_HOST, bytarr, IDLTYPE = 4     

 METHOD:
	The BYTEORDER procedure is called with the appropiate keyword

 RESTRICTION:
	Will run *much* faster for floating or double precision if the IDL 
	version is since 2.2.2 when the /XDRTOF keyword  became available to 
	BYTEORDER.   However, IEEE_TO_HOST should still work in earlier 
	versions of IDL.   Note that V3.0.0 has a bug in the /XDRTOD keyword 
	on DecStations so IEEE_TO_HOST has a workaround.

 MODIFICATION HISTORY:
	Written, W. Landsman   Hughes/STX   May, 1992
	Fixed error Case statement for float and double   September 1992
	Workaround to /XDRTOD problem on DecStations January 1993 


IEEE_TO_HOST [4] $SSW/soho/mdi/idl_old/gen/ssw_lib/ieee_to_host.pro
[Previous] [Next]
 Project     : SOHO - CDS

 Name        : 
	IEEE_TO_HOST
 Purpose     : 
	Translate variables from IEEE to host format.
 Explanation : 
	Translates an IDL variable into the host architecture from the
	IEEE-754 standard (e.g. as used in FITS files).

	BYTEORDER is used to convert to the host format from network format for
	integer arrays or XDR format for floating point arrays.  These are
	equivalent to IEEE format.

 Use         : 
	IEEE_TO_HOST, DATA
 Inputs      : 
	DATA	 = Any IDL variable, scalar or vector.  DATA will be modified
		   by IEEE_TO_HOST to convert it from IEEE format.  Byte and
		   string variables are returned by IEEE_TO_HOST unchanged.
 Opt. Inputs : 
	None.
 Outputs     : 
	The output value of DATA is the variable converted to the format of the
	host architecture.
 Opt. Outputs: 
	None.
 Keywords    : 
	IDLTYPE - scalar integer (1-7) specifying the IDL datatype according
		to the code given by the SIZE function.     This keyword
		is usually when DATA is a byte array to be interpreted as
		another datatype (e.g. FLOAT).
 Calls       : ***
	CONV_UNIX_VAX, SINCE_VERSION [1], SINCE_VERSION [2]
 CALLED BY:
	DBEXT_IND [1], DBEXT_IND [2], DBEXT_IND [3], DBFIND_SORT [1], DBFIND_SORT [2]
	DBFIND_SORT [3], DBINDEX [1], DBINDEX [2], DBINDEX [3], DBOPEN [1], DBOPEN [2]
	DBOPEN [3], DBWRT [1], DBWRT [2], DBWRT [3], DB_ENT2HOST [1], DB_ENT2HOST [2]
	DB_ENT2HOST [3], FITSFILE__DEFINE [2], FXBREAD [1], FXBREAD [2], FXBREAD [3]
	FXBREADM, FXREAD [1], FXREAD [2], GOES_3HOUR, GRS_EXTRACT, HESSI Packet Read [2]
	HSI_LOAD_STRUCT, HSI_PACKET2DETECTOREVENT, HSI_RD_RASPMT, HXRBS_ESC, MRDFITS [1]
	MRDFITS [2], PICK_LINE, READFITS [1], READFITS [2], READFITS [3], READFITSL
	READ_FULL_ATT, READ_MONTH_CAT, READ_RESULTS2, SUM_IMAGE_HEAD, bin_read
	hsi_ras_rdeph [1], hsi_ras_rdeph [2], hsi_rd_subcoll_response_table
	load_struct
 Common      : 
	None.
 Restrictions: 
	Assumes the IDL version is since 2.2.2 when the /XDRTOF keyword 
	became available to BYTEORDER.    There were two bad implementations
	in BYTEORDER for double precision: (1) in IDL V3.* for DecStations
	(!VERSION.ARCH = 'mipsel') and (2) on Dec Alpha OSF machines.
	IEEE_TO_HOST works around these cases by swapping bytes directly
 Side effects: 
	None.
 Category    : 
	Utilities, Operating_system
 Prev. Hist. : 
	Written, W. Landsman   Hughes/STX   May, 1992
	Fixed error Case statement for float and double   September 1992
	Workaround to /XDRTOD problem on DecStations January 1993 
	Assume since Version 2.2, correct double precision problems in 
	Alpha/OSF, implement Ultrix corrections from Tom McGlynn November 1994
 Written     : 
	Wayne Landsman, GSFC/UIT, May 1992.
 Modified    : 
	Version 4, William Thompson, GSFC, 27 February 1995
		Using version from IDL Astronomy User's Library for better
		compatibility.  See previous history above.  IDLTYPE keyword
		reinstated.
 Version     : 
	Version 4, 27 February 1995


IIDY $SSW/soho/sumer/idl/contrib/germerott/sumer_head/iidy.pro
[Previous] [Next]
 PROJECT:
       SOHO - SUMER

 NAME:
       IIDY()

 PURPOSE: 
       Return inter instrument Sun Coordinate Y

 CATEGORY:
       
 
 EXPLANATION:
       
 SYNTAX: 
       Result = iidy()

 EXAMPLES:
       
 INPUTS:
       header - BYTARR(92) Image Header

 OPTIONAL INPUTS: 
       None.

 OUTPUTS:
       None.

 OPTIONAL OUTPUTS:
       None.

 KEYWORDS: 
       None.

 COMMON:
       None.

 RESTRICTIONS: 
       None.

 SIDE EFFECTS:
       None.

 HISTORY:
       Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written

 CONTACT:
       Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)


IIDZ $SSW/soho/sumer/idl/contrib/germerott/sumer_head/iidz.pro
[Previous] [Next]
 PROJECT:
       SOHO - SUMER

 NAME:
       IIDZ()

 PURPOSE: 
       Return inter instrument Sun Coordinate Z

 CATEGORY:
       
 
 EXPLANATION:
       
 SYNTAX: 
       Result = iidz()

 EXAMPLES:
       
 INPUTS:
       header - BYTARR(92) Image Header

 OPTIONAL INPUTS: 
       None.

 OUTPUTS:
       None.

 OPTIONAL OUTPUTS:
       None.

 KEYWORDS: 
       None.

 COMMON:
       None.

 RESTRICTIONS: 
       None.

 SIDE EFFECTS:
       None.

 HISTORY:
       Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written

 CONTACT:
       Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)


IMA_LIST $SSW/soho/lasco/idl/las-c2/calib5.pro
[Previous] [Next]
 NAME: IMA_LIST.pro
 PURPOSE: list the catalog of images (corresp to a template) 
 CATEGORY: Preprocessing low level routine   
 CALLING SEQUENCE: DARK_LIST, template, ima_db, nfiles 
 INPUTS: template                         Template to define the list of images
 OPTIONAL INPUT PARAMETERS:               None
 KEYWORD PARAMETERS:                      None
 OUTPUTS:ima_db                           image catalog
         nfiles                           Number of images in catalog
 OPTIONAL OUTPUT PARAMETERS:              None
 COMMON BLOCKS:                           None
 SIDE EFFECTS: opens a catalog of darks
 RESTRICTIONS:
 PROCEDURE:
 MODIFICATION HISTORY:   defined by ALL 6/24/93

 SCCS variables for IDL use

 @(#)ima_list.pro  1.0 25/6/93 :LAS


IMAGE_COMPRESS $SSW/soho/sumer/idl/atest/image_compress.pro
[Previous] [Next]

   NAME : IMAGE_COMPRESS
           
   PURPOSE :
          Compress  an image into a byte image
   CALLING SEQUENCE :
           result = IMAGE_COMPRESS(image, direction, par, $
                minbyte=minbyte, maxbyte=maxbyte, $
                bytscl=bytscl, quasilog=quasilogm sqrt=sqrt
   INPUTS :
           IMAGE          input image
                          
           DIRECTION      if equal to 1, compression
                          if equal to -1, decompression
           PAR            compression parameters
                          (in the case of decompression)
   OUTPUTS:
           PAR            (in the case of compression)
   KEYWORDS :
           MINBYTE     The minimum value for
                       the compressed byte image (default=0)
           MAXBYTE     The maximum value for
                       the compressed byte image (default=255)        
           BYTSCl    if set, byte scaling method is used.
                       par(0) = maximum value of uncompressed image
                       par(1) = minimum value of uncompressed image
           QUASILOG    if set, quasi log compression is used.
                       par(0) = maximum value of uncompressed image
                       par(1) = minimum value of uncompressed image
    
   MODIFICATION HISTORY
          March 1997,  Jongchul Chae                    
 CALLED BY
	SUMER_DISPLAY_SPECTRUM, SUMER_GIF_SPECTRUM, SUMER_TOOL_PD_EVENT


IMAGE_PLOT $SSW/soho/lasco/idl/data_anal/image_plot.pro
[Previous] [Next]
Name:
       IMAGE_PLOT

Purpose:
    generates standard plots for image analysis

Usage:
       IMAGE_PLOT,A,Hdr

Inputs:
       A   = image
       Hdr = FITS header


image_scale $SSW/soho/sumer/idl/atest/image_scale.pro
[Previous] [Next]
   NAME :  image_scale
   PURPOSE :
          Display image with a color scale

   CALLING SEQUENCE:
          image_scale,  image,  pos_dev, $
                        minvalue=min, maxvalue=max,  $
                        maxbyte=maxbyte, $
                        no_scale =no_scale, $
                        scale_pos=scale_pos, $
                        stitle=stitle, scale=scale, $
                        color=color 
   ARGUMENT
          image :   a two-dimensional  array to be displayed (INPUT)
          pos_dev : 
 CALLS:


imcalc $SSW/soho/lasco/idl/display/imcalc.pro
[Previous] [Next]
 Project     : SOHO - LASCO

 Name        : 

 Purpose     : 

 Category    : 

 Explanation : 

 Syntax      : 

 CALLED BY:
	WCALCL
 Examples    : 

 Inputs      : None

 Opt. Inputs : None

 Outputs     : None

 Opt. Outputs: None

 Keywords    : None

 CALLS: ***
	CHANDLE, SXADDPAR [1], SXADDPAR [2], SXADDPAR [3], tvscl_image
 Common      : 

 Restrictions:                                  

 Side effects: Not known

 History     : Version 1, 02-Sep-1995, B Podlipnik. Written

 Contact     : BP, borut@lasco1.mpae.gwdg.de


IMG2DNPERSEC $SSW/soho/lasco/idl/util/img2dnpersec.pro
[Previous] [Next]
 NAME:
	IMG2DNPERSEC

 PURPOSE:
	Convert an image in raw counts (DN) to DN/sec

 CATEGORY:
	DATA_ANAL

 CALLING SEQUENCE:
	Result = IMG2DNPERSEC(Img,Header)

 INPUTS:
	Img = Input Image array.
	Header = Image header

 OUTPUTS:
	The function returns an image converted to DN/second.  The type will be 
	double precision.

 PROCEDURE:
	The corrected exposure time is determined. Bias is subtracted. 
	If image is binned, the correct factor is applied. Then divide by exposre time.
		output = (binning correction(input - bias))/exposure
	Note that EXP_CORR will return the old exposure time and the current offset 
	bias, if the correction factor is not found.

	Calls: ***
	DATATYPE [1], DATATYPE [2], DATATYPE [3], EXP_CORR, LASCO_FITSHDR2STRUCT
	REDUCE_STD_SIZE
 MODIFICATION HISTORY:
	Written, RA Howard, NRL, 25 November 1997
	Modified:
		20 Feb 98	RAH	Added exposure factor correction
	21 Nov 01, NBR - Add binning correction with REDUCE_STD_SIZE

       @(#)img2dnpersec.pro	1.3 11/30/01     LASCO IDL LIBRARY


IMG_ADD $SSW/soho/lasco/idl/data_anal/img_add.pro
[Previous] [Next]
 NAME: 
                       IMG_ADD 
 
 PURPOSE: 
                       This function routine performs a weighted sum 
                       of two images, in which the weights are the 
                       same.  This would be used as a check of the 
                       procedure, since it is easier to just add  
                       the two arrays together. 
 
 CATEGORY: 
                       ANALYSIS 
 
 CALLING SEQUENCE: 
                       Result = IMG_ADD (Img1,Img2) 
 
 INPUTS: 
                       Img1:   Array containing image #1 
                       Img2:   Array containing image #2  
 
 OPTIONAL INPUTS: 
        
 KEYWORD PARAMETERS: 
 
 OUTPUTS: 
                       Result: The sum of the two input images if 
                                       the operation is successful or -1 
                                       if it is not. 
 
 OPTIONAL OUTPUTS: 
 
 CALLS: ***
	IMG_WT_SUM
 COMMON BLOCKS: 
                       None 
 
 SIDE EFFECTS: 
                       None 
 
 RESTRICTIONS: 
                       The size of both arrays must be the same or  
                       the routine will exit and set result to be  
                       -1. 
 
 PROCEDURE: 
                       The two weighting functions are set to unity. 
                       Then the routine, IMG_WT_SUM, is called. 
 
 EXAMPLE: 
 
 MODIFICATION HISTORY: 
       Written by:     RA Howard, NRL, 27 November 1995 
 
	@(#)img_add.pro	1.1 10/04/96 LASCO IDL LIBRARY


IMG_COMP_DIST $SSW/soho/lasco/idl/data_anal/img_comp_dist.pro
[Previous] [Next]
 NAME: 
                       IMG_COMP_DIST 
 
 PURPOSE: 
                       This function routine creates a composite  
                       image from two images based on two radial  
                       distances.   For radii less than R1, the  
                       values from image #1 are used.  For radii  
                       greater than R2, the values from image  #2  
                       are used.  For radii between R1 and R2, the  
                       values fade linearly from image #1 to #2. 
 
 CATEGORY: 
                       ANALYSIS 
 
 CALLING SEQUENCE: 
                       Result = IMG_COMP_DIST (Img1,Img2,Sun,R1,R2) 
 
 INPUTS: 
                       Img1:   Array containing image #1 
                       Img2:   Array containing image #2 
                       Sun:            A four element array containing the  
                                       solar coordinates: 
                                       Column of the center of the sun 
                                       Row of the center of the sun 
                                       Roll angle to solar north 
                                       Plate scale in arc secs per pixel 
                       R1:             Radius specifying the outer  
                                       boundary of only Img1  
                       R2:             Radius specifying the inner 
                                       boundary of only Img2 
 
 OPTIONAL INPUTS: 
                       None 
        
 KEYWORD PARAMETERS: 
                       None 
 
 OUTPUTS: 
                       Result: The composite of the two input  
                                       images if the operation is  
                                       successful or -1 if it is not. 
 
 OPTIONAL OUTPUTS: 
                       None 
 
 CALLS: ***
	IMG_WT_SUM, SUNDIST
 CALLED BY:
	COMBINE_IMG
 COMMON BLOCKS: 
                       None 
 
 SIDE EFFECTS: 
                       None 
 
 RESTRICTIONS: 
                       The plate scale and sun center must be the 
                       same for the two images prior to entering the  
                       routine. 
                       The size of both arrays must be the same or  
                       the routine will exit and set result to be  
                       -1. 
 
 PROCEDURE: 
                       The procedure, SUNDIST, is called to compute  
                       the distance matrix from sun center. 
                       The two weighting functions are computed. 
                       Then the routine, IMG_WT_SUM, is called. 
 
 EXAMPLE: 
 
 MODIFICATION HISTORY: 
       Written by:     RA Howard, NRL, 27 November 1995 
 
	@(#)img_comp_dist.pro	1.1 10/04/96 LASCO IDL LIBRARY


IMG_COMP_INT $SSW/soho/lasco/idl/data_anal/img_comp_int.pro
[Previous] [Next]
 NAME: 
                       IMG_COMP_INT 
 
 PURPOSE: 
                       This function routine creates a composite  
                       image from two images, based on intensity  
                       values.  For intensities less than Int1, 
                       the values from image #1 are used.  For  
                       intensities greater than Int2, the values  
                       from image #2 are used.  For intensities  
                       between Int1 and Int2, the values from both 
                       images are added together. 
 
 CATEGORY: 
                       ANALYSIS 
 
 CALLING SEQUENCE: 
                       Result = IMG_COMP_INT (Img1,Img2,Int1,Int2) 
 
 INPUTS: 
                       Img1:   Array containing image #1 
                       Img2:   Array containing image #2 
                       Int1:   Intensity specifying the upper  
                                       limit for using only Img1  
                       Int2:   Intensity specifying the lower 
                                       limit for using only Img2 
 
 OPTIONAL INPUTS: 
                       None 
        
 KEYWORD PARAMETERS: 
                       None 
 
 OUTPUTS: 
                       Result: The composite of the two input  
                                       images if the operation is  
                                       successful or -1 if it is not. 
 
 OPTIONAL OUTPUTS: 
                       None 
 
 CALLS: ***
	IMG_WT_SUM
 COMMON BLOCKS: 
                       None 
 
 SIDE EFFECTS: 
                       None 
 
 RESTRICTIONS: 
                       The plate scale and sun center must be the 
                       same for the two images prior to entering the  
                       routine. 
                       The size of both arrays must be the same or  
                       the routine will exit and set result to be  
                       -1. 
 
 PROCEDURE: 
                       The two weighting functions are computed 
                       to form the composite image based on the 
                       intensity values of the two images. 
                       Range           Value 
                       0-Int1          3*Img1+1*Img1 
                       Int1-Int2               3*Img1+3*Img2 
                       Int2-Max                1*Img1+3*Img2 
                       Then the routine, IMG_WT_SUM, is called. 
 
 EXAMPLE: 
 
 MODIFICATION HISTORY: 
       Written by:     RA Howard, NRL, 27 November 1995 
 
	@(#)img_comp_int.pro	1.1 10/04/96 LASCO IDL LIBRARY


IMG_DIF_MIN $SSW/soho/lasco/idl/util/img_dif_min.pro
[Previous] [Next]
 NAME:
	IMG_DIF_MIN

 PURPOSE:
	This function returns the non-zero minimum of the two images. 

 CATEGORY:
	UTILITY

 CALLING SEQUENCE:
	Result = IMG_DIF_MIN (Imga,Imgb)

 INPUTS:
	Imga:	First image
	Imgb:	Second image

 OPTIONAL INPUTS:
	None

 KEYWORD PARAMETERS:
	None

 OUTPUTS:
	None.

 CALLED BY:
	MK_DAILY_MIN
 SIDE EFFECTS:
	None

 RESTRICTIONS:
	Images must be the same size and non-negative.

 PROCEDURE:
	The images are checked to be the same size.  Zero values are
	checked for.

 EXAMPLE:
	To create the minimum image between image A and B:

		c = IMG_DIF_MIN(a,b)

 MODIFICATION HISTORY:
 	Written by:	R.A. Howard, NRL, 6/8/00
			RAH, 10/25/2005, Removed the comment about
				side effects, which wasn't true


 @(#)img_dif_min.pro	1.2 10/25/05 :LASCO IDL LIBRARY


IMG_SUM_2X2 $SSW/soho/lasco/idl/data_anal/img_sum_2x2.pro
[Previous] [Next]
 NAME:
	IMG_SUM_2X2

 PURPOSE:
	This function does a rebinning into an array that is 1/2 the size of
	the original image in each axis, by summing 2x2 pixels.  This increases
	signal to noise.  

 CATEGORY:
	LASCO ANALYSIS

 CALLING SEQUENCE:
	Result = IMG_SUM_2X2 ( Img )

 INPUTS:
	Img:	Input image, can be any type other than string

 OPTIONAL INPUTS:
	None
	
 OUTPUTS:
	This function returns an image which is the result of the 2x2 pixel summing.

 CALLED BY:
	GET_PT
 RESTRICTIONS:
	Forces the input array to have an even number of rows and columns.

 PROCEDURE:
	Generates the indices of the 2x2 pixels and forms the summing explicitly from
	these indices.

 MODIFICATION HISTORY:
 	Written by:	RA Howard, 12 March 1996.

	@(#)img_sum_2x2.pro	1.1 10/04/96 LASCO IDL LIBRARY


img_summary [2] $SSW/soho/mdi/idl_old/gen/util/img_summary.pro
[Previous] [Next]
NAME:
	img_summary
PURPOSE:
	To display summary information of an image.  Display the image
	along with histograms and line plots, plus other text info
SAMPLE CALLING SEQUENCE:
	img_summary, img
	img_summary, img, 'Main Title Example', ['comment1', 'comment2']
	img_summary, img, margin=2, brightest=8, dimmest=8
	img_summary, img, tit, comments, hc=hc, qstop=qstop, $
		scl_min=scl_min, scl_max=scl_max, log_scale=log_scale, $
		brightest=brightest, dimmest=dimmest, $
		margin=margin, progver=progver2

INPUT:
	img	- The image to be summarized
OPTIONAL INPUT:
	tit	- The title to be displayed
	comments- A string array of comments to display
 CALLS: ***
	ARR2STR [1], Arr2Str [2], CONGRID [1], CONGRID [2], CONGRID [3]
	IMG_SUMMARY_PIXLST, SETPS, STDEV, deriv_arr [1], deriv_arr [2], font_size [1]
	font_size [2], mk_refbar [1], mk_refbar [2], pprint [1], pprint [2], tv2 [1]
	tv2 [2], xyouts2 [1], xyouts2 [2]
 CALLED BY:
	dpc_img_summary, img_sumtr2, mdipict, xdisp_fits, xdisp_trace [1], xdisp_trace [2]
	xdisp_trace2, xdisp_trace3
OPTIONAL KEYWORD INPUT:
	hc	- If set, make a hardcopy (do not display to the screen)
	scl_min	- The minimum to use for stretching
	scl_max	- The maximum to use for stretching
	log_scale- If set, display the second form of the image in log
		  scaling (rather than +/- 1 sigma)
	qstop	- If set, stop for debugging
	brightest - If defined, print out information on the brightest
		  pixel locations and their values.  The number of
		  values displayed is the value which is passed in.
	margin	- If defined, print the min/max/avg/dev for the image
		  less "margin" pixels on the left/right/top/bottom
		  (ie: margin=1 says ignore first/last columns/lines)
	progver	- The outside program name and version
HISTORY:
	Written 5-Apr-94 by M.Morrison
V1.1	 5-Apr-94 (MDM) - Changed options/format slightly
			- Modified histogram to stretch if max-min < 2
V1.2	 6-Apr-94 (MDM) - Added "brightest" option
V1.3	 7-Apr-94 (MDM) - Allowed "title" to be an array
V1.4	19-Apr-94 (MDM) - Added MARGIN keyword option
			- Added printing information on number of pixels
			  included in the expanded scale
			- Added (0,0) label for the images
			- Added PROGVER keyword option
			- Added plotting histogram of +/-1 sigma when
			  the +/- 2 sigma is pretty much the same as
			  the full range
V1.41	20-Apr-94 (MDM) - Small format change
V1.5	22-Apr-94 (MDM) - Corrected error in the second image scaling
			  (+/- 1 sigma).  Variable name conflict
V1.51	22-Apr-94 (MDM) - Corrected calculation of average of all
			  rows and columns when using margin (it was
			  doing it for the whole image before)
			- Modified to use "midev" instead of "idev"
			  for +/- 1 sigma scaling of image when
			  margin is used.
			- Scale the expanded histogram using "midev"
V1.52	25-Apr-94 (MDM) - Modified to call FONT_SIZE when going to an
			  X-window
V1.53	29-Apr-94 (MDM) - Modified to only call FONT_SIZE if not PS
V1.54	14-Jun-94 (MDM) - Corrected error for case when MARGIN is not used
V1.60	22-Feb-96 (MDM) - Added DIMMEST option
			- Added sample calling sequence to header
			- Corrected error where MARGIN range was using Full 
			  image min (reported incorrect range)
V1.61	 6-Mar-96 (MDM) - Corrected to display the image properly when it
			  is not square
V1.62	11-Jul-96 (MDM) - Added Z output option
V1.63	24-Oct-96 (MDM) - Modified use TV2, /INIT for all output types
			  (rather than the case statement)
V1.64	 6-Nov-96 (MDM) - Moved "save_device" and "save_color" to
			  outside the conditional for "hc"
			- Added "/int" to set_plot,'ps'
			- Added top=!d.n_colors-1 to bytscl
			- Modified to only call "pprint" if /hc is set
V1.65	 6-Nov-96 (MDM)	- Modified to use "setps"
V1.70	 6-Dec-96 (MDM) - Modified plotting of lines and columns to
			  not exclude the "margin" pixels, rather to 
			  just set the plot range to be the portion
			  excluding the margin.


IMG_WT_SUM $SSW/soho/lasco/idl/data_anal/img_wt_sum.pro
[Previous] [Next]
 NAME: 
                       IMG_WT_SUM 
 
 PURPOSE: 
                       This function routine performs a weighted sum 
                       of two images. 
 
 CATEGORY: 
                       ANALYSIS 
 
 CALLING SEQUENCE: 
                       Result = IMG_WT_SUM (Img1,Wt1,Img2,Wt2) 
 
 INPUTS: 
                       Img1:   Array containing image #1 
                       Wt1:            Array containing the weights for 
                                       image #1 
                       Img2:   Array containing image #2  
                       Wt2:            Array containing the weights for 
                                       image #2 
 
 OPTIONAL INPUTS: 
        
 KEYWORD PARAMETERS: 
 
 OUTPUTS: 
                       Result: The sum of the two input images if 
                                       the operation is successful or -1 
                                       if it is not. 
 
 OPTIONAL OUTPUTS: 
 
 CALLED BY:
	IMG_ADD, IMG_COMP_DIST, IMG_COMP_INT
 COMMON BLOCKS: 
                       None 
 
 SIDE EFFECTS: 
                       None 
 
 RESTRICTIONS: 
                       The size of all of the arrays must be the 
                       same or the routine will exit and set result 
                       to be -1. 
 
 PROCEDURE: 
                       The size of the arrays is verified to be the  
                       same. 
                       The weights are set to zero where the image  
                       values are zero. 
                       The normalizing factor is computed and set to  
                       1 where the factor is 0. 
                       Then the routine forms the weighted sum. 
  
 EXAMPLE: 
 
 MODIFICATION HISTORY: 
       Written by:     RA Howard, NRL, 27 November 1995 
 
	@(#)img_wt_sum.pro	1.1 10/04/96 LASCO IDL LIBRARY


IMGCNT $SSW/soho/sumer/idl/contrib/germerott/sumer_head/imgcnt.pro
[Previous] [Next]
 PROJECT:
       SOHO - SUMER

 NAME:
       IMGCNT()

 PURPOSE: 
       Return Image Counter

 CATEGORY:
       
 
 EXPLANATION:
       
 SYNTAX: 
       Result = imgcnt()

 EXAMPLES:
       
 INPUTS:
       header - BYTARR(92) Image Header

 OPTIONAL INPUTS: 
       None.

 OUTPUTS:
       None.

 OPTIONAL OUTPUTS:
       None.

 KEYWORDS: 
       None.

 COMMON:
       None.

 RESTRICTIONS: 
       None.

 SIDE EFFECTS:
       None.

 HISTORY:
       Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written

 CONTACT:
       Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)


IMGFORM $SSW/soho/sumer/idl/contrib/germerott/sumer_head/imgform.pro
[Previous] [Next]
 PROJECT:
       SOHO - SUMER

 NAME:
       IMGFORM()

 PURPOSE: 
       Return Image Format

 CATEGORY:
       
 
 EXPLANATION:
       
 SYNTAX: 
       Result = imgform()

 CALLED BY:
	COLLECT_IMAGES
 EXAMPLES:
       
 INPUTS:
       header - BYTARR(92) Image Header

 OPTIONAL INPUTS: 
       None.

 OUTPUTS:
       None.

 OPTIONAL OUTPUTS:
       None.

 KEYWORDS: 
       None.

 COMMON:
       None.

 RESTRICTIONS: 
       None.

 SIDE EFFECTS:
       None.

 HISTORY:
       Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written

 CONTACT:
       Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)


IMGTOT $SSW/soho/sumer/idl/contrib/germerott/sumer_head/imgtot.pro
[Previous] [Next]
 PROJECT:
       SOHO - SUMER

 NAME:
       IMGTOT()

 PURPOSE: 
       Return Total Counts in Image

 CATEGORY:
       RAW processing
 
 EXPLANATION:
       
 SYNTAX: 
       Result = imgtot()

 EXAMPLES:
       
 INPUTS:
       header - BYTARR(92) Image Header

 OPTIONAL INPUTS: 
       None.

 OUTPUTS:
       None.

 OPTIONAL OUTPUTS:
       None.

 KEYWORDS: 
       None.

 COMMON:
       None.

 RESTRICTIONS: 
       None.

 SIDE EFFECTS:
       None.

 HISTORY:
       Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written

 CONTACT:
       Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)


IMP_DATAWIN $SSW/soho/cds/idl/util/ops/database/imp_datawin.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_DATAWIN()

 Purpose     :	Reads data window definition from database export file

 Explanation :	Reads a data extraction window definition from a database
		export file.  Called from IMPORT_STUDY.

 Use         :	Result = IMP_DATAWIN( UNIT, DEF )

		IF NOT IMP_DATAWIN( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The data extraction window list definition.  This is a
		       structure of a form suitable for use with the routine
		       ADD_DATAWIN.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_DATAWIN( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       : ***
	FXBTDIM [1], FXBTDIM [2]
 CALLED BY:
	IMPORT_PLAN, IMPORT_STUDY
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 23 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995
		Version 2, William Thompson, GSFC, 20 June 1995
			Added tag WIN_FLAG.

 Version     :	Version 2, 20 June 1995


IMP_DETAIL $SSW/soho/cds/idl/util/ops/database/imp_detail.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_DETAIL()

 Purpose     :	Reads a detailed science plan from an export file.

 Explanation :	Reads a detailed science plan from a database export file.
		Called from IMPORT_PLAN.

 Use         :	Result = IMP_DETAIL( UNIT, DEF )

		IF NOT IMP_DETAIL( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The detail definition.  This is a structure of a form
		       suitable for use with the routine ADD_DETAIL.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_DETAIL( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       : ***
	TRIM
 CALLED BY:
	IMPORT_PLAN
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 10-Apr-1997

 Modified    :	Version 1, William Thompson, GSFC, 10-Apr-1997

 Version     :	Version 1, 10-Apr-1997


IMP_F_RASTER $SSW/soho/cds/idl/util/ops/database/imp_f_raster.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_F_RASTER()

 Purpose     :	Reads fundamental raster def. from database export file

 Explanation :	Reads a fundamental raster definition from a database export
		file.  Called from IMPORT_STUDY.

 Use         :	Result = IMP_F_RASTER( UNIT, DEF )

		IF NOT IMP_F_RASTER( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The raster definition.  This is a structure of a form
		       suitable for use with the routine ADD_F_RASTER.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_F_RASTER( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       :	None.
 CALLED BY:
	IMPORT_PLAN, IMPORT_STUDY
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 23 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995

 Version     :	Version 1, 23 May 1995


IMP_F_STUDY $SSW/soho/cds/idl/util/ops/database/imp_f_study.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_F_STUDY()

 Purpose     :	Reads fundamental study def. from database export file

 Explanation :	Reads a fundamental study definition from a database export
		file.  Called from IMPORT_STUDY.

 Use         :	Result = IMP_F_STUDY( UNIT, DEF )

		IF NOT IMP_F_STUDY( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The study definition.  This is a structure of a form
		       suitable for use with the routine ADD_F_STUDY.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_F_STUDY( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       :	None.
 CALLED BY:
	IMPORT_PLAN, IMPORT_STUDY
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 23 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995

 Version     :	Version 1, 23 May 1995


IMP_LINELIST $SSW/soho/cds/idl/util/ops/database/imp_linelist.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_LINELIST()

 Purpose     :	Reads a linelist definition from a database export file

 Explanation :	Reads a linelist definition from a database export file.
		Called from IMPORT_STUDY.

 Use         :	Result = IMP_LINELIST( UNIT, DEF )

		IF NOT IMP_LINELIST( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The linelist definition.  This is a structure of a form
		       suitable for use with the routine ADD_LINELIST.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_LINELIST( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       :	None.
 CALLED BY:
	IMPORT_PLAN, IMPORT_STUDY
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 23 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995

 Version     :	Version 1, 23 May 1995


IMP_SCI_PLAN $SSW/soho/cds/idl/util/ops/database/imp_sci_plan.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_SCI_PLAN()

 Purpose     :	Reads a SCI_PLAN definition from an export file.

 Explanation :	Reads a science plan definition from a database export file.
		Called from IMPORT_PLAN.

 Use         :	Result = IMP_SCI_PLAN( UNIT, DEF )

		IF NOT IMP_SCI_PLAN( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The linelist definition.  This is a structure of a form
		       suitable for use with the routine ADD_PLAN.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_SCI_PLAN( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       :	None.
 CALLED BY:
	IMPORT_PLAN
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 10 April 1997

 Modified    :	Version 1, William Thompson, GSFC, 10 April 1997

 Version     :	Version 1, 10 April 1997


IMP_V_RASTER $SSW/soho/cds/idl/util/ops/database/imp_v_raster.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_V_RASTER()

 Purpose     :	Reads raster variation def. from database export file

 Explanation :	Reads a raster variation definition from a database export
		file.  Called from IMPORT_STUDY.

 Use         :	Result = IMP_V_RASTER( UNIT, DEF )

		IF NOT IMP_V_RASTER( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The raster definition.  This is a structure of a form
		       suitable for use with the routine ADD_V_RASTER.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_V_RASTER( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       :	None.
 CALLED BY:
	IMPORT_PLAN, IMPORT_STUDY
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 23 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995
		Version 2, William Thompson, GSFC, 27 October 1995
			Added item IEF_ID.

 Version     :	Version 2, 27 October 1995


IMP_V_STUDY $SSW/soho/cds/idl/util/ops/database/imp_v_study.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMP_V_STUDY()

 Purpose     :	Reads study variation def. from database export file

 Explanation :	Reads a study variation definition from a database export file.
		Called from IMPORT_STUDY.

 Use         :	Result = IMP_V_STUDY( UNIT, DEF )

		IF NOT IMP_V_STUDY( UNIT, DEF ) THEN ...

 Inputs      :	UNIT = The logical unit number of the opened input file.

 Opt. Inputs :	None.

 Outputs     :	DEF  = The study definition.  This is a structure of a form
		       suitable for use with the routine ADD_V_STUDY.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	  = If defined and passed, then any error messages will
			    be returned to the user in this parameter rather
			    than depending on the MESSAGE routine in IDL.  If
			    no errors are encountered, then a null string is
			    returned.  In order to use this feature, ERRMSG
			    must be defined first, e.g.

				ERRMSG = ''
				Result = IMP_V_STUDY( ERRMSG=ERRMSG, ... )
				IF ERRMSG NE '' THEN ...

 Calls       :	None.
 CALLED BY:
	IMPORT_PLAN, IMPORT_STUDY
 Common      :	None.

 Restrictions:	None.

 Side effects:	None.

 Category    :	Planning, Databases.

 Prev. Hist. :	None.

 Written     :	William Thompson, GSFC, 23 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995

 Version     :	Version 1, 23 May 1995


IMPORT_PLAN $SSW/soho/cds/idl/util/ops/database/import_plan.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMPORT_PLAN

 Purpose     :	Imports a science plan file written by EXPORT_PLAN.

 Explanation :	This procedure reads a text file written by EXPORT_PLAN, and
		imports it into the currently selected database.  The text file
		will contain a complete plan definition, including study
		definitions.  This allows plan definitions to be moved between
		different sites, or from a user's personal database to the
		official CDS database.

		Note that the various ID numbers may change as the studies are
		moved from one database to another.  This procedure keeps track
		of all that information, and replaces the old study numbers
		with the new study numbers

 Use         :	IMPORT_PLAN, FILENAME

 Inputs      :	FILENAME = The name of the file to read.  The default extension
			   is ".plan"

 Opt. Inputs :	None.

 Outputs     :	None.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	 = If defined and passed, then any error messages will
			   be returned to the user in this parameter rather
			   than depending on the MESSAGE routine in IDL.  If no
			   errors are encountered, then a null string is
			   returned.  In order to use this feature, ERRMSG must
			   be defined first, e.g.

				ERRMSG = ''
				IMPORT_PLAN, ERRMSG=ERRMSG, ...
				IF ERRMSG NE '' THEN ...

 Calls       : ***
	ADD_DATAWIN, ADD_DETAIL, ADD_F_RASTER, ADD_F_STUDY, ADD_LINELIST, ADD_PLAN
	ADD_T_STUDY, ADD_V_RASTER, ADD_V_STUDY, DEL_DETAIL, DEL_PLAN, FIND_WITH_DEF [1]
	FIND_WITH_DEF [2], FIND_WITH_DEF [3], GET_STUDY, IMP_DATAWIN, IMP_DETAIL
	IMP_F_RASTER, IMP_F_STUDY, IMP_LINELIST, IMP_SCI_PLAN, IMP_V_RASTER, IMP_V_STUDY
	LIST_DETAIL, LIST_PLAN, PRIV_ZDBASE, TRIM
 CALLED BY:
	MK_CDS_PLAN
 Common      :	None.

 Restrictions:	One must have write privilege in the currently selected
		database.

		!PRIV must be 2 or greater to use this routine.

 Side effects:	There are certain assumptions which are made in order for this
		software to be able to work correctly:

		1.  It is assumed that the GSET database is exactly the same on
		    both the export and import sides.  There's no checking of
		    the validity of the GSET_ID number.

		2.  There's no checking of the durations of the various
		    studies.  In particular, any implied assumptions about
		    whether or not GSETs need to be loaded are carried over
		    without checking.

		3.  It is assumed that any engineering studies (STUDY_ID=0) are
		    defined identically on both the export and import sides.

		4.  Campaign numbers are assumed to have exactly the same
		    meaning on both the export and import sides.

		This routine does not check to see if the definitions are
		viable.

		Generally speaking, the various ID numbers and variation
		indices describing the studies will be completely different in
		the new database.

 Category    :	Planning, Databases.

 Prev. Hist. :	None

 Written     :	William Thompson, GSFC, 17-Apr-1997

 Modified    :	Version 1, William Thompson, GSFC, 17-Apr-1997
             :	Version 2, Zarro, GSFC, 22-Apr-1997 -- fixed ERRMSG
		Version 3, 27-May-1997, William Thompson, GSFC
			Fixed bug when more than one variation of a study in
			the plan.
		Version 4, 17-May-1999, William Thompson, GSFC
			Fixed bug where STUDY_ID changes.

 Version     :	Version 4, 17-May-1999


IMPORT_STUDY $SSW/soho/cds/idl/util/ops/database/import_study.pro
[Previous] [Next]
 Project     :	SOHO - CDS

 Name        :	IMPORT_STUDY

 Purpose     :	Imports a study definition file written by EXPORT_STUDY.

 Explanation :	This procedure reads a text file written by EXPORT_STUDY, and
		imports it into the currently selected database.  The text file
		will contain a complete study definition, including linelists
		and data window lists.  This allows study definitions to be
		moved between different sites, or from a user's personal
		database to the official CDS database.

		Note that the various ID numbers may change as the study is
		moved from one database to another.  This procedure keeps track
		of all that information, and replaces the old study numbers
		with the new study numbers

 Use         :	IMPORT_STUDY, FILENAME, STUDY

 Inputs      :	FILENAME = The name of the file to read.  The default extension
			   is ".def"

 Opt. Inputs :	None.

 Outputs     :	STUDY    = The study definition as returned by GET_STUDY once
			   it has been imported into the new database.  If
			   unable to import the study, then a simpler structure
			   is returned, with the single tag STUDY_ID set to -1.

 Opt. Outputs:	None.

 Keywords    :	ERRMSG	 = If defined and passed, then any error messages will
			   be returned to the user in this parameter rather
			   than depending on the MESSAGE routine in IDL.  If no
			   errors are encountered, then a null string is
			   returned.  In order to use this feature, ERRMSG must
			   be defined first, e.g.

				ERRMSG = ''
				IMPORT_STUDY, ERRMSG=ERRMSG, ...
				IF ERRMSG NE '' THEN ...

 Calls       : ***
	ADD_DATAWIN, ADD_F_RASTER, ADD_F_STUDY, ADD_LINELIST, ADD_T_STUDY, ADD_V_RASTER
	ADD_V_STUDY, FIND_WITH_DEF [1], FIND_WITH_DEF [2], FIND_WITH_DEF [3], GET_STUDY
	IMP_DATAWIN, IMP_F_RASTER, IMP_F_STUDY, IMP_LINELIST, IMP_V_RASTER, IMP_V_STUDY
	PRIV_ZDBASE, TRIM
 CALLED BY:
	XSTUDY
 Common      :	None.

 Restrictions:	One must have write privilege in the currently selected
		database.

		!PRIV must be 2 or greater to use this routine.

 Side effects:	This routine does not check to see if the definitions are
		viable.

		Generally speaking, the various ID numbers and variation
		indices describing the study will be completely different in
		the new database.

 Category    :	Planning, Databases.

 Prev. Hist. :	None

 Written     :	William Thompson, GSFC, 17 May 1995

 Modified    :	Version 1, William Thompson, GSFC, 23 May 1995
		Version 2, William Thompson, GSFC, 15 January 1996
			Modify RV_DESC to reflect new ID numbers

 Version     :	Version 2, 15 January 1996


IN_WINDOW $SSW/soho/cds/idl/sci/plan/tech/in_window.pro
[Previous] [Next]
 Project     : SOHO - CDS     
                   
 Name        : IN_WINDOW()
               
 Purpose     : Decide which line_window cursor is in, if any.
               
 Explanation : In the technical planning display, decide whether the current
               cursor position falls within the bounds of any of the currently
               defined line windows.
               
 Use         : IDL> hit = in_window(line_structure, cur_x, cur_y)
    
 Inputs      : line_structure  - the data structure containing details of the
                                 currently defined line windows list.  The 
                                 structure is defined in tp_def_struct.

               cur_x           - the current x-value of the cursor position.
               cur_y           - the current y-value of the cursor position.
               
 Opt. Inputs : None
               
 Outputs     : The function return value is the number of the identified 
               line-window.  A value of -1 is returned if the cursor position
               is not within a window.
               
 Opt. Outputs: None
               
 Keywords    : None

 Calls       : None
 Restrictions: Returns only the first line-window found, tough on overlapping
               windows.
               
 Side effects: None
               
 Category    : Technical planning
               
 Prev. Hist. :

 Written     : C D Pike, RAL, 14-May-93
               
 Modified    : 

 Version     : Version 1, 14-May-1993


INCREASEDAY $SSW/soho/lasco/idl/util/increaseday.pro
[Previous] [Next]
 NAME:
	INCREASEDAY

 PURPOSE:
	This procedure finds the date following the input date.

 CATEGORY:
	LASCO UTILITY

 CALLING SEQUENCE:
	INCREASEDAY, Day, Month, Year

 INPUTS:
	Day, Month, Year:	The day, month and year as integers

 OUTPUTS:
	The Day, Month and Year are all modified.

 CALLS: ***
	KDATE, KDAY
 EXAMPLE:

		day =28 & month=2 & year=1980
		INCREASEDAY,day,month, year
			will return day=29, month=2, year=1980
		But with year=1979, the routine
			will return day=1, month=3, year=1980

 MODIFICATION HISTORY:
 	Written by:	Nathan Rich, NRL
	10/25/2005	RAH:  added template and changed method

	@(#)increaseday.pro	1.3 10/26/05 LASCO IDL LIBRARY


INDD [2] $SSW/soho/mdi/idl_old/gen/ys_util/indd.pro
[Previous] [Next]
 NAME:		INDD
 PURPOSE:	Return index of array A(i) for which
		A(i-1) < B <= A(i) 
 CATEGORY:
 CALLING SEQUENCE: indx = indd(A, B) 
 INPUTS:	A = an array whose value is monotonically increasing
		B = threshold value
 OUTPUTS: 	Function result = indx of array A(i) to satisfy the
 		conditon  A(i-1) < B <= A(i)
 CALLED BY:
	ACGAUNT [1], ACGAUNT [2]
 COMMON BLOCKS: none
 SIDE EFFECTS:  none
 RESTRICTIONS:  none
 PROCEDURE:	straightforward


INIT_DB_STRUCT $SSW/soho/lasco/idl/database/init_db_struct.pro
[Previous] [Next]
 Project     : SOHO - LASCO/EIT
                   
 Name        : INIT_DB_STRUCT
               
 Purpose     : To initialize DB table structures from include files.
               
 Explanation : This routine initializes DB table structures from all include
		files and creates a master structure containing them all.
               
 Use         : IDL> INIT_DB_STRUCT
    
 Inputs      : None.
               
 Outputs     : None.
               
 Calls       : GETHELP
 CALLED BY:
	GET_DB_STRUCT
 Common      : COMMON DB_STRUCT_COMMON, all_db_struct
               
 Restrictions: None.
               
 Side effects: None.
               
 Category    : Database Administration
               
 Prev. Hist. : None.

 Written     : Scott Paswaters, NRL, November 1995.
               
 Modified    : 13 Jun 1996 SEP Moved include files to ./include subdirectory

 Version     : 1.01


INLINE_TEXT $SSW/soho/cds/idl/util/misc/inline_text.pro
[Previous] [Next]
 Project     : SOHO - CDS     
                   
 Name        : INLINE_TEXT()
               
 Purpose     : Return inline text immediately following call line
               
 Explanation : Returns verbatim text immediately following the line calling
               INLINE_TEXT, up to and including the line that contains the
               end MARKER.

               Uses GET_CALLDETAILS to find out the file name and the line
               number of the calling line.

               The default MARKER is ';-' (the standard "end of
               documentation" marker in the library routines).

 Use         : TEXT = INLINE_TEXT( [MARKER] )
 
 Inputs      : None required

 Opt. Inputs : MARKER : The text appearing at the *beginning* of the last
                        line of inline text.

 Outputs     : Returns the inline text, or message about failure to read.
               
 Opt. Outputs: None.
               
 Keywords    : None.

 Calls       : ***
	GET_CALLDETAILS, INLINE_TEXT_HELP
 Common      : None.
               
 Restrictions: Needs to find the program source file!
               
 Side effects: None.
               
 Category    : General.
               
 Prev. Hist. : None.

 Written     : S.V.H.Haugan, UiO, 31 July 1998
               
 Modified    : Not yet.

 Version     : 1, 31 July 1998


input [2] $SSW/soho/mdi/idl_old/gen/ys_util/input.pro
[Previous] [Next]
NAME:
	input
PURPOSE:
	Prompt the user for input and allow a default
	answer.  If the user simply types <CR>, then
	the default answer is used.  The procedure can
	also check that the answer falls within a range
	of values
INPUT:
	str	- A string containing the question/prompt
		  This value can be a string array, but that
		  is only to type several lines for the question.
		  There is only one answer.
OUTPUT:
	ans	- The answer
OPTIONAL INPUT:
	default_in - The default answer
	min_range - The smallest acceptable answer
	max_range - The largest accesptable answer

 CALLS: ***
	type_conv [1], type_conv [2]
 CALLED BY:
	ACOPY [1], CANCEL_PRELIM, DPE_GUESS, FILT4_SIM, HXTPIXON, HXT_QLOOK
	MDI_SUMMARY_SUB1, NET_DIR_DIFF, PLOT_BSC [1], PLOT_BSC [2], PREP_HXTDAT, RdTap [1]
	RdTap [2], RdTap [3], SIMPLE_TV2, STEPPER [3], STEPPER [4], SXT_CADENCES, ars2_plan
	compare_resp, dbase2disk, delete_week [1], delete_week [2], doc_library2 [1]
	doc_library2 [2], dsn_check [1], dsn_check [2], dsn_input, fort2hxi [1]
	fort2hxi [2], gbo_obs_coord, get_dn_rate [1], get_dn_rate [2], get_fname
	get_hxt_pos, getm1ans, go_lasdisk golaserdisk, go_lasdisk2 golaserdisk, go_nvs4
	go_nvs5, go_rdtap [1], go_rdtap [2], go_teem [1], go_teem [2], go_teem_nn, go_teem_t
	hard_center, hardcopy [1], hardcopy [2], hist_count, hist_summary, hxt_multimg
	hxt_sources, make_32 [2], mdilaser, mk_cd [1], mk_cd [2], mk_movie [1], mk_movie [2]
	mk_nvs_movie, mk_op_file, mk_orbit_sum, mk_ptv_movie, mk_vcr, modvolume_inf [1]
	modvolume_inf [2], nvsstat, op_get_special, op_times, plot_new_respon, prep_gendat
	prep_week [1], prep_week [2], set_printer [1], set_printer [2], set_printer [5]
	set_sci160k_dir, sxt_defroi, sxt_obs_coord [1], sxt_obs_coord [2], term_score2
	tim2dset [1], tim2dset [2], tim2tfss, timeline, valid_pass4 [1], valid_pass4 [2]
	video_menu, wmenu_sel [1], wmenu_sel [2], wmenu_sel_set [1], wmenu_sel_set [2]
	xcheckip, yo_height
	NOTE:
	   If output type is string, and there are 4 parameters, 
	   then the output is converted to uppercase
HISTORY:
	Written 1988 by M.Morrison


input_time [2] $SSW/soho/mdi/idl_old/gen/ys_util/input_time.pro
[Previous] [Next]
NAME:
	input_time   
PURPOSE:
	To allow a user to interactively enter a start and end time.
OUTPUT:
	time1	- The first time/date in the 7-element time convension
		  (hh,mm,ss,msec,dd,mm,yy)
				OR
		  in the structure format with .TIME and .DAY
		  (this second format is used with the /struct option)
	time2	- The end time/date in the 7-element time convension
                               OR
                 in the structure format with .TIME and .DAY
                 (this second format is used with the /struct option)
OPTIONAL INPUT:
	one	- If present, only request one time
	print	- If present, print the times selected (for
		  verification)
	check	- If present, request that the user "ok" the input
	sample	- If present, print the sample time strings
	struct	- If present, have the output be a structure type
		  variable.
 CALLS: ***
	Ex2Int [1], Ex2Int [2], MAKE_STR [1], MAKE_STR [2], fmt_tim [1], fmt_tim [2]
	int2secarr [1], int2secarr [2], timstr2ex [1], timstr2ex [2], yesnox [1]
	yesnox [2]
HISTORY:
	Written 11-Dec-91 by M.Morrison


INQ_GEN [2] $SSW/soho/mdi/idl_old/gen/ys_util/inq_gen.pro
[Previous] [Next]
 NAME:
 	INQ_GEN

 PURPOSE:
	Provide summary of SXT generic file	

 CALLING SEQUENCE:
	INQ_GEN, filename [,file_lun]

 INPUTS:
	FILENAME - string containing generic file name
	LUN      - logical unit, terminal if not present	

 COMMON BLOCKS;
	NONE

 RESTRICTIONS - prliminary - just does a RD_GEN and idl help of 
	data structures, final version should not have to read data

 CALLS: ***
	PRINT_TEXT [1], PRINT_TEXT [2], RD_GEN [1], RD_GEN [2]
 MODIFICATION HISTORY:
	Version 0 - SLF, 3/5/91


insert [2] $SSW/soho/mdi/idl_old/gen/ys_util/insert.pro
[Previous] [Next]
NAME:
	insert
PURPOSE:
	To insert a smaller array into a larger array
	IDL Ver 2 does not have it (Ver 1 did)
INPUT/OUTPUT:
	array_out - Array into which the smaller array
		    should be inserted
INPUT:
	array_in  - Array to be inserted
	ist1	  - Indicie in the large array where
		    "array_in" is to be inserted.
	ist2	  -
	ist3	  -
 CALLED BY:
	Get Names, Init Selection, Init_Data, Initialize Selection [1], Insert Plot
	Insert in the Selection, Load Plot, Load Selection, Remove from the Selection
	Search Plot, Select All, Selection, Store_Plot, bcs_emiss   was bcs_counts
HISTORY:
	Written Aug-91 by M.Morrison


instf $SSW/soho/lasco/idl/data_anal/fpc1_insf.pro
[Previous] [Next]
 NAME:  
	instf

 PURPOSE:
	Return the C1 instrument function Voigt parameters.

 CATEGORY:
	image reduction routines

 CALLING SEQUENCE:
	fpc1_insf,w,fl,fg

 INPUTS:
	w -	wavelength in Angstroms at which the instrument function
		parameters are desired.

 OPTIONAL INPUTS:

	NONE

 KEYWORD PARAMETERS:

	NONE

 OUTPUTS:

	Returns two arrays - fl and fg. The instrument function is
	a Voigt profile which is a convolution of a Gaussian and
	a Lorentzian profile. fg is the full width at half maximum
	of the Gaussian profile G(w):

		G(w) = exp(-w^2/(2*s^2))/(s*sqrt(2*!pi) 

	where s is the variance and fg = 2*s*sqrt(2*alog(2))

	fl is the full width at half maximum of the Lorentzian
	profile L(w):

		L(w) = (fl/(2*!pi))/(w^2+(fl/2)^2)

	The values of both fl and fg are returned in Angstroms

 OPTIONAL OUTPUTS
	NONE
	
 CALLS: ***
	FPC1_INSF
 COMMON BLOCKS:
	NONE

 SIDE EFFECTS:
	NONE

 RESTRICTIONS:
	NONE 

 PROCEDURE:

 MODIFICATION HISTORY:
	1997 Oct 20 Written by Paul Reiser 


Int2Ex [2] $SSW/soho/mdi/idl_old/gen/ys_util/int2ex.pro
[Previous] [Next]
  Name:
	Int2Ex
  Purpose:
	Convert days since 1979 and milliseconds of day into 
	conventional date and time.
  Calling Sequence:
	Int2Ex, msod, ds79, time
  Inputs:
	msod= 4-byte integer: milliseconds of the day
	ds79= 2-byte integer: number of days since 1-Jan-1979
  Output:
	time= 7 element integer array containing, in order,
		hr min sec msec day mon yr
	error - set on error in arguments
 CALLS: ***
	DAYCNV [1], DAYCNV [2], DAYCNV [3]
 CALLED BY:
	ADDTIME [1], ADDTIME [2], ALIGN_AR, ANAL_STIMS, AdjUsrTim, BCS_24HR_PLOT [1]
	BCS_24HR_PLOT [3], BCS_BROWSE24, BCS_CONT [1], BCS_CONT [2], BCS_CREATE_CAT
	BCS_MULTI [1], BCS_MULTI [2], DATAGET3_GRS, DATAGET3_HXS, FIND_CAL [1]
	FIND_CAL [2], GET_SDA, Idx2List, LIST_BDA, MANY_DAYS, OUT_GRSPHL1, OUT_GRSPHL2
	OUT_HXSPH, PLOT_GRSPCH, PLOT_GRSPCL, PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HXSPC
	PLOT_HXSPH, SELECT_24HR, SET_XHR, SPLINE_LC, WBS_DB, YOHKOH_EVENTS, anytim [1]
	anytim [2], anytim [3], anytim [4], anytim [5], anytim2ex [1], anytim2ex [2]
	bcs_bpcfs, chk_flares [1], chk_flares [2], contacts [1], contacts [2], dd792ex
	ex2week [1], ex2week [2], fidmap, file_summary, filetimes [1], filetimes [2]
	get_sirius [1], get_sirius [2], grs_plot, gt_day [1], gt_day [2], gt_time [1]
	gt_time [2], gtab_file, mk_fem [1], mk_fem [2], mk_fem_aoslos [1]
	mk_fem_aoslos [2], mk_fem_file [1], mk_fem_file [2], mk_orbit [1], mk_orbit [2]
	mk_week_file [1], mk_week_file [2], pr_evn [2], pr_fem, pr_gbe, pr_gev, pr_nel
	rd_week_file [1], rd_week_file [2], rd_week_file [3], rd_week_file [4]
	rdbda_smm, tim2dset [1], tim2dset [2], tim2file [1], tim2file [2], time_add1s
	time_addxa, weekid [2], ydb_exist [2], yolist
  Side Effects:
	Results are always in the form of a 2-dimensional array,
	even if input is scalar.
  Restrictions:
	None
  History:
	version 1.0, was adopted from Int2Ex.FOR (SMM software), 
	written by GAL, 15-Feb-1991 
       16-nov-92, Modified, JRL:  Made loop variable I*4 for the case of
				   a large input variable.
	31-oct-93, ras, eliminated loop for yr,month,day by using jdcnv
	16-nov-93, ras, added error keyword


int2sec [2] $SSW/soho/mdi/idl_old/gen/utplot/int2sec.pro
[Previous] [Next]
Name:
	int2sec
Purpose:
	To convert the "standard" internal
	representation array into a time series
	vector in seconds.
Input:
	time_arr - A structure array with the
		fields .TIME and .DAY
			(OR)
		A 2xN array with the MSOD variable first, and the DS79
		variable second (see example).  It
		is assumed that they are the same length
			(OR)
		A 7xN array which hold the 7-element external 
		representation of time.
Output:
	returns a single array with the number 
	of seconds past the reference value 1 assumed to be for 01-jan-1979.
 CALLS: ***
	Ex2Int [1], Ex2Int [2], gt_day [1], gt_day [2], gt_time [1], gt_time [2]
 CALLED BY:
	anytim [1], anytim [2], anytim [3], anytim [4], anytim [5]
Examples:
	d = int2secarr( roadmap )
	d = int2secarr( [msod,ds79] )

History:
	Modified from int2secarr to treat 1-Jan-79 as epoch reference time
	RAS, 93-6-7


int2secarr [2] $SSW/soho/mdi/idl_old/gen/ys_util/int2secarr.pro
[Previous] [Next]
Name:
	int2secarr
Purpose:
	To convert any time format into a time series vector in seconds.
Input:
	time_arr - A structure array with the
		fields .TIME and .DAY
			(OR)
		A 2xN array with the MSOD variable first, and the DS79
		variable second (see example).  It
		is assumed that they are the same length
			(OR)
		A 7xN array which hold the 7-element external 
		representation of time.
	time_ref - OPTIONAL, the reference time from
		which to calculate the number of
		seconds that have passed.  If it is
		missing, time_arr(0) is used
		(the first value in the array)
		It is a structure with .TIME and .DAY
			(OR)
		A two element array with the first element
		being the MSOD, and the second being DS79
			(OR)
               A 7xN array which hold the 7-element external
               representation of time.
Output:
	returns a single array with the number 
	of seconds past the reference value.
 CALLS: ***
	anytim2ints [1], anytim2ints [2]
 CALLED BY:
	ALIGN1BIGGRAM, ALIGN_AR, AR_SPECTRUM, BCS_24HR_PLOT [1], BCS_24HR_PLOT [3]
	BUILD_SSX, CHECK_SFC_PNT, DISPLOI_MON5K, DO_TEEM, DSN_DMP_FINDER, ECL_FRAC, EUTPLOT
	FIND_FAST_DATA, Fix_bsd_header v12, GET_POINTS, GET_SSX_SLICE, GET_SUBARR2
	GET_TRACUBE, GO_FIND_LIM2, GO_FIND_LIMB, HXA2HXAXY [1], HXA2HXAXY [2], HXTIMG2INTS
	HXT_AUTOIMG, HXT_LCURVE, IRUHXA2SXT, IRUHXASCAN2SXT [1], IRUHXASCAN2SXT [2]
	IRUHXA_FIT [1], IRUHXA_FIT [2], IRU_FILT, LAY1GKM, MDI_SUMMARY_SUB1, MK_SSX
	NET_DIR_DIFF, OUTPLOT [1], OUTPLOT [2], OUTPLOT [3], PLOT_BSC [1], PLOT_BSC [2]
	PP_MWLT2SXT, PROM_ON_DISK, QUICKSTRAY [2], QUICK_DPE, RD_AR, SXT_OBSRPT, SXT_QLOOK
	StEnIdx, TIM2UPOS, TRACE_CUBE_POINTING, TRACE_MDI_ALIGN, TR_FLAT_SUB, TV_SSX
	TV_SYNOP, UPDATE_SXT_CO_INDEX, UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4]
	UTPLOT [5], ada2str, adjust_times, ads_into_att, ads_into_pnt, align_hxi, ars2_plan
	atr2hxa_dbase, auto_toban, bcs_clock_fix, box_lc_plot, build_timarr [1]
	build_timarr [2], cam_run_sum, check_sci5k_trunc, chk_flares [1], chk_flares [2]
	choose_interval, choose_sfc, cnvt [2], contact_num [1], contact_num [2]
	contacts [1], contacts [2], daily_forecast [2], dedupe_sort, disp_sci160k [1]
	disp_sci160k [2], disp_sci5k, divyup, do_ads, do_tr_reformat, dps_fname2time
	dps_proc_lev0_hk, early_mid_late, event_movie [1], event_movie [2], evt_grid
	fem_grid [1], fem_grid [2], file_info2 [1], file_info2 [2], fit_bsc_plot, gbo_pfi
	get1gbo, get1hk_info [1], get1hk_info [2], get_ar, get_att, get_dc_image [2]
	get_dc_image [3], get_dc_rate, get_dc_warm, get_del_pnt, get_hxt_pos
	get_ksc_holiday, get_leak_image [1], get_leak_image [2], get_leak_image [3]
	get_newsoon, get_orb_epoch, get_roll, get_sdm_val, get_seq_tab, get_suncenter2
	get_sunset, go_get_sirius, go_nvs4, go_teem_plots, goes3sec_copy, goes_plot [1]
	goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5], goes_teem, goes_widget
	goesem_eqn [1], goest_eqn [1], grs_plot, gt_iru, hk_time_sort, hxi_interp
	hxt_chsums, hxt_impulsivness, image2movie, input_time [1], input_time [2]
	interpol_yoh, iperr_sea, jitter_gif_xyimg, killold [1], killold [2]
	lc_array1 formerly actonpro, lcbsd, lcur_plot [1], lcur_plot [2], leak_sub [1]
	leak_sub [2], leak_sub [3], list_nrt_times, mdi_imagetool, mk_desat, mk_evn [1]
	mk_evn [2], mk_fem [1], mk_fem [2], mk_gif_mag_index, mk_gsn_obs, mk_gsn_obs_s1
	mk_hst_summary, mk_imgsum_html, mk_mdi_iap, mk_mo_log, mk_obs_str, mk_orbit [1]
	mk_orbit [2], mk_pnt, mk_sdc [2], mk_sdc [3], mk_sdc [4], mk_sfc [1], mk_sfc [2]
	mk_sfd [1], mk_sfd [2], mk_sfd [3], mk_sfd [4], mk_sff_pair [1], mk_sff_pair [2]
	mk_sfw, mk_sl [1], mk_sl [2], mk_sot, mk_soup_hcat, mk_ssc [1], mk_ssc [2]
	mk_timarr [1], mk_timarr [2], mk_trace_i1, mk_week1_file, mon_health [1]
	mon_health [2], monthly_summary, mplot_nar, mwlt_select, mwlt_tape2jpeg
	nearest_fid [1], nearest_fid [2], new_disp_sci5k [1], new_disp_sci5k [2]
	new_mon_health [1], new_mon_health [2], op_get_event [1], op_get_event [2]
	op_term_score, oplot_nts, pl_monitor_center, plot_ar_pfi, plot_door_open, plot_evn
	plot_fem, plot_fft, plot_img_cadence, plot_lcur [1], plot_lcur [2], plot_nar [1]
	plot_nar [2], plot_ssl, plot_sxl [1], plot_sxl [2], plot_trav [1], plot_trav [2]
	plot_trav [3], plotbft [1], plotbft [2], plott_bda_dp, plott_hi_sum, plott_low_sum
	plott_med1_sum, plott_med2_sum, ploty [1], ploty [2], pr_evn [2], pr_pnt_hist
	pr_sxtobs, pr_trav_summ, rd_dpc_table, rd_fdss, rd_hist_dbase [1]
	rd_hist_dbase [2], rd_hk [1], rd_hk [2], rd_old_obs, rd_pnt_hist
	rd_raw_station_plan, rd_selsisi, rd_srspas, rd_ssl, rd_station_plan
	rd_therm_rs232, rd_week_file [1], rd_week_file [2], rd_week_file [3]
	rd_week_file [4], redo_disploi, redo_mon_sci5k, ref_day_plot, reslot, rot_pix2
	run_dsnfil, save_event [1], save_event [2], search_obs, sel_dc_image [1]
	sel_dc_image [2], sel_dc_image [3], sel_timrange [1], sel_timrange [2]
	selsis_week, seq_frame_info, seq_run_sum [1], seq_run_sum [2], show_contacts
	show_hxafid, show_obs2, show_obs3, show_obs4, sleazy_rot, sol_rot [2], soon_cadence
	soon_catstat, soon_table, sort_index [1], sort_index [2], soup_obs2
	ssw_check_contrib, ssw_track_fov, sxl_select, sxt2mpeg, sxt_cmd_pnt, sxt_fsp
	sxt_interp [1], sxt_interp [2], sxt_mwave, sxt_prep [1], sxt_prep [2]
	sxt_prep [3], sxt_tfl, sxt_tflx, sxt_thfsp, sxt_uvf_info [1], sxt_uvf_info [3]
	sxthxt_fsp, sxtpnt_sum, sxtth_hxt, telem_sum, term_times, termlite, tim2dset [1]
	tim2dset [2], tim2match [1], tim2match [2], tim2match [3], tim2orbit [1]
	tim2orbit [2], tim2pass, tim2tfss, tim_bin, time_interp, time_smooth, timeavg [1]
	timeavg [2], timegrid, timeline, topsdb [1], topsdb [2], tprofiles
	tr_mech_summary_img month, track_h2a [1], track_h2a [2], track_h2a [3]
	ut_time [1], ut_time [2], v_orbital, web_seq, weekid [2], wrt1orbit [1]
	wrt1orbit [2], wrt_fits_bin_exten [2], wrt_sci160k_img, xfem_grid, xread_hist
	xset_chain [1], xset_chain [2], xso_search, ydb_exist [2], yoyo_man2
Examples:
	d = int2secarr( roadmap )
	d = int2secarr( roadmap, roadmap(100) )
	d = int2secarr( [msod,ds79] )

History:
	written 12-Oct-91 by M.Morrison
	13-Nov-91 MDM - Changed to be able to work with nested structures
			(called GT_TIME and GT_DAY)
	16-Nov-91 MDM - Changed to also accept 7-element format (in
			addition to 2-element and structure
	 5-Mar-92 MDM - Changed to also accept a string convention of
			time for the reference time.
	20-Jul-93 MDM - Removed much code and replaced with calls to ANYTIM2INTS
		      - Allowed two vectors of arrays to be passed
        3-Jan-95 MDM - Changed to use DOUBLE instead of FLOAT
                       because when using a reference time of
                       1-Jan-79, the resolution/accuracy for dates
                       in 1994 is less than 20 seconds!!


int_fwhm [1] $SSW/soho/cds/idl/sci/data_anal/ql/line_fit/int_fwhm.pro
[Previous] [Next]
 Project     : SOHO - CDS     
                   
 Name        : int_fwhm
               
 Purpose     : Calculate the total line intensity from the maximum
		intensity in the line and the FWHM
               
 Explanation : 
               
 Use         : IDL> int_fwhm, x, y, totint
    
 Inputs      : x and y arrays for spectral line
               
 Opt. Inputs : 
               
 Outputs     : total intensity of line
               
 Opt. Outputs: 
               
 Keywords    : None

 Calls       : ***
	interp
 CALLED BY:
	tot_int
 Common      : None
               
 Restrictions: None
               
 Side effects: None
               
 Category    : ?
               
 Prev. Hist. :

 Written     : Nils Brynildsen, ITA, UiO, 9-Sept.-1993
               
 Modified    : Version 1 Nils Brynildsen, ITA, 9-Sept-1993

 Version     : Version 1 9-Sept.-1993


int_fwhm [2] $SSW/soho/cds/idl/sci/data_anal/ql/line_fit/int_fwhm_2.pro
[Previous] [Next]
 Project     : SOHO - CDS     
                   
 Name        : int_fwhm
               
 Purpose     : Calculate total intensity from peak intensity and the FWHM
               
 Explanation : 
               
 Use         : IDL> int_fwhm, x, y, totint, fwhm, shift
    
 Inputs      : x and y arrays for spectral line
               
 Opt. Inputs : 
               
 Outputs     : total intensity of line
               
 Opt. Outputs: 
               
 Keywords    : None

 Calls       : ***
	INT_FWHM_2, interp
 CALLED BY:
	tot_int
 Common      : None
               
 Restrictions: None
               
 Side effects: None
               
 Category    : ?
               
 Prev. Hist. :

 Written     : Nils Brynildsen, ITA, UiO, 9-Sept.-1993
               
 Modified    : Version 1 Nils Brynildsen, ITA, 27-Oct.-1993
		Out: fwhm and line shift

 Version     : Version 1 9-Sept.-1993


int_sum $SSW/soho/cds/idl/sci/data_anal/ql/line_fit/int_sum.pro
[Previous] [Next]
 Project     : SOHO - CDS     
                   
 Name        : int_sum
               
 Purpose     : Calculate a spectral lines total intensity by
		adding up the pixel values across the line
               
 Explanation : 
               
 Use         : IDL> int_sum, x, y, disp, xs, itot
    
 Inputs      : x and y array, background, dispersion, 
		start wavelength
               
 Opt. Inputs : 
               
 Outputs     : total intensity for the line
               
 Opt. Outputs: 
               
 Keywords    : None

 Calls       : None
 CALLED BY:
	tot_int
 Common      : None
               
 Restrictions: None
               
 Side effects: None
               
 Category    : 
               
 Prev. Hist. : None

 Written     : Nils Brynildsen, ITA, UiO, 9-Sept.-1993
               
 Modified    : Version 2 Nils Brynildsen, ITA, 13-Sept-1993

 Version     : Version 2 13-Sept.-1993


INTEG [1] $SSW/soho/mdi/idl_old/gen/ys_util/integ.pro
[Previous] [Next]
 NAME:
       INTEG
 PURPOSE:
       Trapezoidal integration of the area under a curve
 CALLING SEQUENCE:
       Result=INTEG(y)
       Result=INTEG(x,y)
       Result=INTEG(x,y,imin,imax)
 INPUTS:
       x = array containing independent variable.  If omitted, then
           x is assumed to contain the index of the y variable.
           x=indgen(n_elements(y)).
       y = array containing dependent variable y=f(x)
       imin = index of x array at which to begin the integration.  If
              omitted, then integration starts at x(0).
       imax = index of x value at which to end the integration.  If 
              omitted then the integration ends at x(npts).
 OUTPUTS:
       result = area under the curve y=f(x) between x(imin) and x(imax).
 PROCEDURE:
       The area is determined of indivdual trapezoids defined by x(i),
       x(i+1), y(i) and y(i+1).
 MODIFICATION HISTORY:
       Written, W.B. Landsman, STI Corp. May 1986
       Modified so X is not altered in a one parameter call Jan 1990


INTER_FUZZY $SSW/soho/lasco/idl/reduce/fuzzy/inter_fuzzy.pro
[Previous] [Next]
 NAME:
	INTER_FUZZY

 PURPOSE:
	Compute the intersection of 2 fuzzy numbers

 CALLED BY:
	FUZZY_BLOCK
 PROCEDURE:
	Compute the intersection of 2 fuzzy numbers (this for each element in
	the case of fuzzy number arrays)

 CALLING SEQUENCE:
	cfuzzy = inter_fuzzy (afuzzy, bfuzzy)

 INPUTS:
	afuzzy, bfuzzy		2 fuzzy numbers (or fuzzy number arrays)

 OUTPUTS:
	a fuzzy number (structure {low, high}) or array of fuzzy numbers


interp $SSW/soho/cds/idl/sci/data_anal/ql/line_fit/interp.pro
[Previous] [Next]
 Project     : SOHO - CDS     
                   
 Name        : interp
               
 Purpose     : Simple linear interpolation
               
 Explanation : 
               
 Use         : IDL> interp,x1,y1,x2,y2,xh,yh
    
 Inputs      : two points [x,y] and y-value where interpolated
               value is wanted 
               
 Opt. Inputs : 
               
 Outputs     : interpolated values in x and y
               
 Opt. Outputs: 
               
 Keywords    : None

 Calls       : None
 CALLED BY:
	int_fwhm [1], int_fwhm [2]
 Common      : None
               
 Restrictions: None
               
 Side effects: None
               
 Category    : ?
               
 Prev. Hist. : None

 Written     : Nils Brynildsen, ITA, UiO, 9-Sept.-1993
               
 Modified    : Version 1.1 Nils Brynildsen, ITA, 27-June-1995

               Added y1 = y2 test.

 Version     : Version 1.1 27-June-1995


interp1d [2] $SSW/soho/mdi/idl_old/gen/ys_util/interp1d.pro
[Previous] [Next]
 NAME:
   interp1d
 PURPOSE:
   Perform fast linear 1d interpolation 

   Uses the IDL INTERPOLATE procedure, which requires an equally spaced grid.
   If X0 is not equally spaced, will generate an equally spaced grid first and
   then use INTERPOLATE to do the interpolation.

 CALLING SEQUENCE:
   result = interp1d(x0,y0,x1)
   result = interp1d(x0,y0,x1,dx,missing=missing)
   result = interp1d(x0,y0,x1,missing=missing)
   result = interp1d(x0,y0,x1,/interp)		; Use spline interpolation to 
						; generate equally spaced grid
 INPUTS:
   X0	= The absicissae values for Y0.
   Y0  = The function to interpolate
   x1	= The abscissae values for the result.
 OPTIONAL INPUTS:
   dx  = The step size in X for equally spaced data.  If given,
	  will eliminate a check to see that X0 is equally spaced.
	  This is the fastest way to call this routine.
 OPTIONAL INPUT KEYWORDS:
   missing = Value to points which have X1 gt max(X0) or X1 lt min(X0)
   interp  = If set will call spline to construct linear grid if dx is
             not specified.
 OPTIONAL OUTPUT KEYWORDS:
   dx  = If dx is not specified, dx = abs(total(X0-X0(1:*))) / (n_elements(X0)-1)
   new_Y = New values interpolated at dx spacing
 Returned:
   result = a vector N_elements(X1) long 

 CALLED BY:
	sxt_flux [1], sxt_flux [2], sxt_flux [3], width_1d
 PROCEDURE:
   This routine interpolates faster than interpol because it makes use of
   the fact that the data interpolated by the IDL INTERPOLATE function
   must be evenly spaced.

   If dx is specified as the fourth paramter, directly interpolate.
   If dx is not specified, compute std = std(x0(1:*)-x0, dx).  If
         (std/dx) is lt 1.e-5, interpolate the result.
   If dx is not specified and (std/dx) is greater than 1.e-5 then:
      1. Construct a new grid starting at x0(0) and going in dx step sizes.
      2. Call dspline to construct a linear grid
      3. Then interpolate.
 CALLS: ***
	DOC_LIBRARY, DSPLINE, STDEV
 RESTRICTIONS:
   No extrapolation is performed.  If extrapolation is desired, use the
   IDL user library INTERPOL routine.
 HISTORY:
   31-aug-94, J. R. Lemen LPARL, Written.


interp2d [2] $SSW/soho/mdi/idl_old/gen/ys_util/interp2d.pro
[Previous] [Next]
 NAME:
   interp2d
 PURPOSE:
   Perform bilinear 2d interpolation using the IDL intrinsic 
   interpolate procedure
 CALLING SEQUENCE:
   result = interp2d(A,x0,y0,x1,y1)
   result = interp2d(A,x0,y0,x1,y1,/grid)
   result = interp2d(A,x0,y0,x1,y1,/regular,/cubic)
   result = interp2d(A,x0,y0,x1,y1,missing=missing)
 INPUTS:
   A	= 2d array to interpolate
   x0	= Values that correspond to A(0,0), A(1,0), ...
   y0  = Values that correspond to A(0,0), A(0,1), ...
   x1	= New X values at which A should be interpolated
   y1  = New Y values at which A should be interpolated
 OPTIONAL INPUTS:
   nxny = [nx,ny] Vector of length 2 which specifies the size of
         the regular linearized grid produced with trigrid.  The
         default is nxny = [51,51].  If the size of A is much larger
	  than 51 by 51, greater accuracy may be obtained by having
         nxny = [n_elements(A(*,0),n_elements(A(0,*))]
 OPTIONAL INPUT KEYWORDS:
   grid= If set, return an n_elements(X1) by n_elements(y1) grid
   missing = Value to points which have X1 gt max(X0) or X1 lt min(X0)
		and the same for Y1.
   quintic = If set, use smooth interpolation in call to trigrid
   regular = If set, do not call trigrid -- x0 and y0 must be linear.
   cubic   = If set, use cubic convolution
 Returned:
   result = a vector N_elements(X1) long 
      or, if /grid is set
   result = an array that is N_elements(X1) by N_elements(Y1)

 CALLED BY:
	DROT_MAP, DROT_RASTER, GRID_MAP, HSI_XY2ANNSEC [1], HSI_XY2ANNSEC [2], INTER_MAP
	ITOOL_DIFF_ROT, ROT_MAP, collexc [1], collexc [2], eit_temp, hsi_sim_random_2d
	temp_random_fn_a
 PROCEDURE:
   First call the IDL intrinsic routines TRIANGULATE & TRIGRID to make
	sure that X0 and Y0 are linear (if /regular is not set).
   Then call the IDL intrinsic INTERPOLATE to do bilinear interpolation.
 RESTRICTIONS:
   X0 and Y0 must be linear functions.
   A must be a 2-d array
 HISTORY:
    9-mar-94, J. R. Lemen LPARL, Written.
   20-Jan-95, JRL, Added the REGULAR & CUBIC keywords


interp_arr [2] $SSW/soho/mdi/idl_old/gen/ys_util/interp_arr.pro
[Previous] [Next]
 NAME:
   interp_arr
 PURPOSE:   
	Linearly interpolate the two input arrays to the requested time.

 CALLING SEQUENCE:
   New_arr = interp_arr(img1 ,img2, Time1, Time2, Time3)
   New_arr = interp_arr(img1 ,img2, Time1, Time2, Time3, unc_img1, unc_img2, unc_arr)

 INPUTS:
   img1,img2	= Two images that will be linearly interpolated
   Time1, Time2= The times corresponding to img1, img2 in any standard
		  Yohkoh standard time format.
   Time3	= The time to which the returned image should be interpolated

 OPTIONAL INPUTS:
   unc_img1, unc_img2 = uncertainties in img1 and img2, both must be
   		  passed in if the uncertainty is to be calculated

 OPTIONAL OUTPUT:
   unc_arr = the array of uncertainties in the final image

 CALLS: ***
	ADDTIME [1], ADDTIME [2], anytim2ex [1], anytim2ex [2]
 CALLED BY:
	hxi_interp, interp_img, sxt_interp [1], sxt_interp [2]
 MODIFICATION HISTORY:
  9-oct-92, Written, G. A. Linford (and J.R. Lemen)
  29-sep-95, jmm, Added uncertainty calculation


INTTOB32 $SSW/soho/lasco/idl/reduce/mb2str/inttob32.pro
[Previous] [Next]
 PROJET
     SOHO-LASCO

 NAME:
  INTTOB32

 PURPOSE:
  Convert a integer to a base 32 number

 CATEGORY:
  Mathematics

 CALLING SEQUENCE:
   
 DESCRIPTION:

 INPUTS:

 INPUT KEYWORD:

 OUTPUTS:

 CALLED BY:
	MB2STRMAP
 PROCEDURE:
  
 CALLED ROUTINES:

 HISTORY:
	V1 A.Thernisien 10/07/2001
 CVSLOG:
  $Log: inttob32.pro,v $
  Revision 1.2  2002/07/11 07:24:12  arnaud
  Insertion of the Log in each header



ip_que_dmpver $SSW/soho/mdi/idl/ops/ip_que_dmpver.pro
[Previous] [Next]
NAME:
	ip_que_dmpver
PURPOSE:
	To verify an IP queue dump
SAMPLE CALLING SEQUENCE:
	ip_que_dmpver, '12-JUN-95  18:24:32', mem=mem
	ip_que_dmpver, '12-Jun-95  18:24:32', 'dlimg.src', dir='/mdisw/cfl/eof/src'
INPUT:
	date_time - The approximate date and time of the dump is needed
		    to know what portion of the SCI5K data file to read.
		    The default is to check a 2 hour window centered on
		    the requested time.
	src_infil - The file to check for in the memory dump
 CALLS: ***
	ARR2STR [1], Arr2Str [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
	FILE_EXIST [2], FMT_TIMER [1], FMT_TIMER [2], STR2ARR [1], STR2ARR [2], UNIQ [1]
	UNIQ [2], UNIQ [3], anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2]
	concat_dir [4], data_type [1], data_type [2], deriv_arr [1], deriv_arr [2]
	ex2fid [1], ex2fid [2], file_exist [1], file_exist [3], fmt_tim [1], fmt_tim [2]
	gt_time [1], gt_time [2], rd_hk [1], rd_hk [2], rd_tfile [1], rd_tfile [2]
	str_replace [1], str_replace [2], where_pattern [1], where_pattern [2]
OPTIONAL KEYWORD INPUT:
	window	- The number of hours to check on either side of the input time
		  (the default is 1 hour)
	dir	- The directory to look for the .src file (defaults to
		  /mdisw/cfl/eof/src)
OPTIONAL KEYWORD OUTPUT:
	mem	- The memory dump in a byte array
	sci_pkt	- The sci5k packets with IP buffer dump data in it
	out	- All sci5k packets over the time span
	src	- The binary IP queue load (as decoded from the .src file)
	map	- A 8192 word map of the IP queue memory space
	recs	- The SCI5K packets read from the file
RESTRICTIONS:
	If the time period spans midnight GMT, it will be a problem
HISTORY:
	Written 18-Sep-95 by M.Morrison (taking interactive work of Jun-95)
	31-Oct-95 (MDM) - Added RECS keyword output
	 3-Nov-95 (MDM) - Added informational statements
	 8-Nov-95 (MDM) - Added /QSTOP
	12-Nov-96 (MDM) - Modified the word delimiting the load command


ipcom $SSW/soho/mdi/idl/egse/ipcom.pro
[Previous] [Next]
NAME:
	ipcom
PURPOSE:
	TO evaluate the IP commision LFFT test
SAMPLE CALLING SEQUENCE:
	ipcom, '/md66/log/sci160k/940417_033526
INPUT:
	seq_filnam - The sequence or telemetry file name
 CALLS: ***
	SXPAR [1], SXPAR [2], SXPAR [3], gt_day [1], gt_day [2], plottime [1], plottime [2]
	pprint [1], pprint [2], read_mdi
OPTIONAL KEYWORD INPUT:
	hc	- If set, produce a hardcopy (don't display to the screen)
HISTORY:
	Written 18-Apr-94 by M.Morrison
	17-Jul-95 (MDM) - Removed "rdtfr2" compilation
V2.0	24-Aug-95 (MDM) - Modified to use different set of images for
			  the DMA add and subract check
			  OLD: [6,7,8,9]	NEW: [8,9,10,11]


iperr_sea $SSW/soho/mdi/idl/ops/iperr_sea.pro
[Previous] [Next]
NAME:
	iperr_sea
PURPOSE:
	To search through the HK data and find when the IP error count
	incremented and to log it.
SAMPLE CALLING SEQUENCE:
	iperr_sea, '23-mar', '24-mar', out, /qstrip
	iperr_sea, 
 CALLS: ***
	REP_TAG_VALUE, UNIQ [1], UNIQ [2], UNIQ [3], anytim2ints [1], anytim2ints [2]
	data_type [1], data_type [2], fmt_tim [1], fmt_tim [2], get_hk_info [1]
	get_hk_info [2], gt_day [1], gt_day [2], int2secarr [1], int2secarr [2], prstr [1]
	prstr [2], tim2dset [1], tim2dset [2], ut_time [1], ut_time [2]
 CALLED BY:
	MDI_SUMMARY, mon_health [1], mon_health [2]
HISTORY:
	Written 1995 by M.Morrison
V2.0	 2-Apr-96 (MDM) - Cleaned up and put on-line
V2.1	11-Jun-96 (MDM) - modified to read a day of data at a time
V2.2	18-Jun-96 (MDM) - Added qdebug option
			- Corrected the number of days
			- Added title label
V3.0	24-Jun-97 (MDM) - Expanded for TRACE use
V3.1	13-Aug-97 (MDM) - Further expansion for TRACE use (sequence
			  error searching
			- Adjusted so that if no sttim/entim then
			  it does the last 24 hours
V3.2	13-Aug-97 (MDM) - Fix to sequence option


ipolarfra $SSW/soho/lasco/idl/las-c2/align1.pro
[Previous] [Next]
 NAME:                        ipolarfra.pro
 PURPOSE:                     make the inverse of polar transformation 
                              for OE developped fringe or for OI blocked 
                              developped fringe
 CATEGORY:                    Processing high level
 CALLING SEQUENCE:            ipolarfra,ima_in,Xc,Yc,R,delta_R,ima_out
 INPUTS:                      ima_in                          reference's image
 OPTIONAL INPUT PARAMETERS:   Xc,Yc                           fringe's center
                              R                               internal radius
                              delta_R                         width of fringe
 KEYWORD PARAMETERS:          None
 OUTPUTS:                     ima_out                         result frame
 OPTIONAL OUTPUT PARAMETERS:  None
 CALLS: ***
	ALIGN1, visu_cal
 COMMON BLOCKS:               None
 SIDE EFFECTS:                None
 RESTRICTIONS:                Applications limited to 512*512 frames
 PROCEDURE:
 MODIFICATION HISTORY:    defined by M.B 02/17/94 : LAS

 SCCS variables for IDL use

 @(#)ipolarfra.pro  1.0 02/17/94 : LAS


is_alive [2] $SSW/soho/mdi/idl_old/gen/ys_util/is_alive.pro
[Previous] [Next]
   Name: is_alive

   Purpose: check health of remote host

   Input Parameters:
      node - node name or number 

   Calling Sequence:
      status=is_alive(node [,/vms])

   Calling Examples:
      if is_alive('nodename') then...
      if is_alive('123.45.6.78') then ...
      if is_alive('name::') then ...		; colons to designate DECNET

 CALLS: ***
	ARR2STR [1], Arr2Str [2], FILE_EXIST [2], STR2ARR [1], STR2ARR [2], file_exist [1]
	file_exist [3], is_member [1], is_member [2], tbeep [1], tbeep [2], tbeep [3]
 CALLED BY:
	CHECK_FTP, FTP__DEFINE, SMART_FTP, ftp_copy [1], ftp_copy [2], is_bestnode [1]
	is_bestnode [2], mo_prep, ydb_install [1], ydb_install [2]
   History:
       5-May-94 (SLF) written
      10-May-94 (SLF) added history documentation
      28-feb-95 (SLF) add /usr/sbin/ping / OSF case
       2-Aug-95 (MDM) - added additional method for seeing if the node is
			 responding (so this would work on SGI)
		       - added /QSTOP


is_bestnode [2] $SSW/soho/mdi/idl_old/gen/ys_util/is_bestnode.pro
[Previous] [Next]
   Name: is_bestnode

   Purpose: quick and dirty search for 'best' node in nodelist
            (best nodes are 'alive' and lowest CPU/Memory load or process count)

   Input Parameters:
      nodelist - string array of nodenames to check

   Keyword Parameters:
      nprocess    - if set, use non-root process count [default]
      cpuload     - if set, use minimum cpuload        [not yet implemented]
      memload     - if set, use minimum memory load    [not yet implemented]
      remove      - if set, remove the 'best' from the nodelist
 		     (used for succesive calls from a given program to spread 
		     the load around)
      defnodes    - if set, use nodelist defined by env $SITE_BATCHNODES
      goodorder   - (output) - all members of nodelist in order of 'bestness'
				(best first, worst last)
   Output:
      function returns the 'best' node name (or local node if it is best)

   Calling Sequence:
      best=is_bestnode(nodelist [,/nprocess, /cpuload, /memload, $
		 	           goodorder=goodorder , /defnodes]
   Calling Examples:
      rsh,is_bestnode(['flare13','flare7','isass1']), rshcommand
         [checks 3 node plus local node, and calls 'rsh' with the best]

      best=is_bestnode(/defnodes , goodorder=goodorder)
         [uses nodelist defined by $SITE_BATCHNODES; goodorder (output) 
         [contains the nodelist sorted by decresing 'bestness'; ie, best node
	  [first, worst node last]

 CALLED BY:
	go_batch [1], go_batch [2]
   History:
      26-Sep-1994 (SLF) - written to select best host for background tasks
      27-Sep-1994 (SLF) - dont allow zero processes (Problem TBD)
      29-sep-1994 (SLF) - fixed problem where rsh to local node resulted in
			   "Cant make Pipe" (use spawn instead of rsh for local)
      30-sep-1994 (SLF) - added GOODORDER output keyword

   Category:
      system, distributed processing, general utility

 CALLS: ***
	ARR2STR [1], Arr2Str [2], MESASGE, STR2ARR [1], STR2ARR [2], data_chk [1]
	data_chk [2], file_append [1], file_append [2], get_host [1], get_host [2]
	get_logenv [1], get_logenv [2], is_alive [1], is_alive [2], prstr [1], prstr [2]
	rem_elem [1], rem_elem [2], rsh
   Restrictions:
      Since this is based on a 'ps' snapshot, no written guarantees...
      only non-root process count for now


is_fits [2] $SSW/soho/eit/idl/util/is_fits.pro
[Previous] [Next]
     IS_FITS determines whether a file is in fits format

DESCRIPTION:  
     IS_FITS reads the primary header unit from a file and searches
     for the keyword 'SIMPLE'.  If SIMPLE = T then the file is 
     determined to be a fits file and result = 1.  The keyword 
     'EXTENSIONS' is then searched for; if it is found then then
     next header unit is read in and the value of the 'XTENSION'
     keyword is returned in the optional parameter 'extension'. If
     'EXTENSIONS' is not found then 'extension' is left blank.
     

CALLING SEQUENCE:  
     RESULT = IS_FITS ( filename, [extension] )

ARGUMENTS (I = input, O = output, [] = optional):
     RESULT        O   integer    Contains 1 for each file that is in
                                  fits format, SIMPLE = 'T'
     FILENAME      I   string     File name to be checked
     EXTENSION    [O]  string     Contains the extension type if 
                                  the fits file contains 'XTENSION'
                                  keyword

WARNINGS:

 CALLED BY:
	EIT_DISPLAY, EIT_IMAGE, EIT_MKMOVIE, EIT_PREP, MOVIE_MAKER, eit_dump, eit_lzsort
	read_eit
EXAMPLE:
	To check if file 'filename' is fits format use the following:

	    status = is_fits('filename') 

	The return status = 1 if it is a fits file and 0 if not.  No 
	information on extensions is returned.

	To determine if a file is a valid fits extension file and what
	type if extension it is, then include the optional 'extension'
	keyword:

	    status = is_fits('filename', extension)

	In this case status = 1 if the file is a valid fits file.  The
	keyword extension = 'BINTABLE' if the file is fits Binary
	Table Extension.  If no extensions were found then extension
	is left blank.  !ERROR will be returned as 0 for no errors and
	as 1 if the file was not found.
#
 CALLS: ***
	SXPAR [1], SXPAR [2], SXPAR [3]
COMMON BLOCKS:
     None

PROCEDURE (AND OTHER PROGRAMMING NOTES): 

PERTINENT ALGORITHMS, LIBRARY CALLS, ETC.:
	Uses a call to SXPAR to find keyword values.
  
MODIFICATION HISTORY:
     Written by Dave Bazell,  General Sciences Corp.  4 Feb 1993 spr 10477
     Modified by Dalroy Ward, General Sciences Corp. 24 Mar 1993 spr
              modified routine to handle headers longer than one record

.TITLE
 Routine IS_FITS


is_member [2] $SSW/soho/mdi/idl_old/gen/ys_util/is_member.pro
[Previous] [Next]
   Name: is_member

   Purpose: check set membership (element(s) IN set?), return boolean

   Input Parameters:
      elements - item(s) to check
      set - array (set) to check  (use keyword if not specified)

   Keyword_Parameters:
      swap_os - return true if current OS requires byte swapping
      wc - if set, just check for pattern match

   Calling Sequence:
      truth=is_member(element, set)	; user specified values
      truth=is_member(/swap_os)	; built in tests via keywords

   Calling Examples:
      IF is_member(/swap_os) THEN  			; check current OS
      IF is_member(name,['n1','n2','n3']) THEN		; is name in namelist?
      IF is_member(name,namelist,/ignore_case) THEN    ; case insensitive
      IF is_member(pattern,list,/wc) THEN		; pattern match?

 CALLS: ***
	data_chk [1], data_chk [2]
 CALLED BY:
	HESSI PACKET CLASS DEFINITION, SPEX__DEFINE
	STRATEGY HOLDER TOOLS ABSTRACT CLASS, UPDATE_LINE_TEMPLATES
	check_process [1], check_process [2], dbase2disk, decode_gev, disk_hog [1]
	disk_hog [2], diskfree [1], diskfree [2], eit_colors, files2data, fit_comp_kw
	fits2time [1], fits2time [2], fits2time [3], ftp_copy2sites, go_yo_prod_batch
	gt2exe [1], gt2exe [2], gt_pix_size, gtt_mnem, hsi_imagefile_2_plotman
	hsi_obs_source__define, hsi_params_2_top_struct, hsi_params_write_pro
	idl_server_control, is_alive [1], is_alive [2], keyword_db, mk_ssc_batch [1]
	mk_ssc_batch [2], mk_syn_sfc [1], mk_syn_sfc [2], mk_week_file [1]
	mk_week_file [2], mo_patch, mtcmd [1], mtcmd [2], plotman
	pprint OBSOLETE  See SPRINTPRO [1], pprint [1], rd_week_file [1]
	rd_week_file [2], rd_week_file [3], rd_week_file [4], ssw_contrib_ok2online
	ssw_ct2rgb, ssw_javamovie, ssw_start_rpcserver, str_istype, str_subset, sxt2file
	time_window, timeline, topsdb [1], topsdb [2], tr_hsm_fix, trace_dph2struct [1]
	trace_special_movie [1], trace_special_movie [2], trace_special_movie [3]
	trace_special_movie2, tvmulti, wdeletes, web_seq, weekid [2], xso_butevents [1]
	xso_butevents [2], ydb_exist [2]
   History:
      11-Apr-1994 (SLF) [reduce duplicate code, self-documenting code]
      25-oct-1994 (SLF) add WC keyword and function 


is_ss [2] $SSW/soho/eit/idl/util/is_ss.pro
[Previous] [Next]
     IS_SS determines whether a file is a valid IDL save set

DESCRIPTION:  
     IS_SS attempts to open FILENAME and read the first two bytes.
     IDL save sets have the first two bytes set to 83 and 84 so we 
     check the values of these bytes and return a 1 if the test is
     positivie and a 0 if either one is negative.

CALLING SEQUENCE:  
     RESULT = IS_SS(filename)

ARGUMENTS (I = input, O = output, [] = optional):
     RESULT        O   int        Return value = 1 if FILENAME is 
                                  determined to be an IDL save set
                                  and 0 if it is not.
     FILENAME      I   str        Name of file to be checked        

WARNINGS:
	This algorithm is based on the first two bytes of the save
	set record begin equal to 83 and 82.  It has been observed
	that IDL save sets start with these bytes.  Invalid results
	will occur if  RSI changes this convention (possible) or if
	a non-IDL save set starts with 83 82 (also possible).

 CALLED BY:
	EIT_DISPLAY
EXAMPLE:
	To determine if 'file' is a valid IDL save set use:

	   status = is_ss('file')

	Status = 1 if it is a save set and 0 if it is not.
#
COMMON BLOCKS:
     None

PROCEDURE (AND OTHER PROGRAMMING NOTES): 

PERTINENT ALGORITHMS, LIBRARY CALLS, ETC.:
     None
  
MODIFICATION HISTORY:
     Written by Dave Bazell,  General Sciences Corp. 4 Feb 1993 spr 10463

.TITLE
 Routine IS_SS


ISARRAY [3] $SSW/soho/mdi/idl_old/gen/jhuapl/isarray.pro
[Previous] [Next]
 NAME:
       ISARRAY
 PURPOSE:
       Tests if the argument is an array.
 CATEGORY:
 CALLING SEQUENCE:
       flag = isarray(a)
 INPUTS:
       a = variable to test.                                in
 KEYWORD PARAMETERS:
 OUTPUTS:
       flag = test result: 0 if not array, else non-zero.   out
 CALLED BY:
	MOONPOS, NUTATE, POSANG, RECPOL [1], RECPOL [2], RECPOL [3], RTMVI [1], STRSEC [1]
	STRSEC [2], qView_Save2File
 COMMON BLOCKS:
 NOTES:
 MODIFICATION HISTORY:
       R. Sterner  20 Mar, 1986.
       Checked for undefined variables.  RES 25 Aug, 1989.
       Johns Hopkins Applied Physics Lab.

 Copyright (C) 1986, Johns Hopkins University/Applied Physics Laboratory
 This software may be used, copied, or redistributed as long as it is not
 sold and this copyright notice is reproduced on each copy made.  This
 routine is provided as is without any express or implied warranties
 whatsoever.  Other limitations apply as described in the file disclaimer.txt.


ISVALID [3] $SSW/soho/mdi/idl_old/gen/util/isvalid.pro
[Previous] [Next]
 NAME:
	ISVALID
 PURPOSE:
	Returns validity flag for its argument
 CALLING SEQUENCE:
	result = isvalid(variable)
 INPUTS:
	variable: the variable to be tested
 OPTIONAL INPUT PARAMETERS:
	(none)
 KEYWORD PARAMETERS:
	(none)
 CALLED BY:
	CALC_LOI_ROLL, COORD [2], COORD [3], DISPLOI_MON5K, FIELDLINE, FOT_ROLL, GETV4TYPE
	MAKE_DIPOLES, MAKE_SYNOP, PIX2V4, PLOT_PTLIST, ROLL_PLOT, SUNEARTHDIST, V4, V42PIX
	V4DIFF_ROT, V4HELP, V4MCART, V4MSPH, V4PRINT, V4UNITS, V4XCARR2HEL, V4XCART2SPH
	V4XHEL2CARR, V4XS2SC, V4XS2SRS [1], V4XSC2HC [1], V4XSC2HC [2], V4XSC2HEC, V4XSC2S
	V4XSPH2CART, V4_RESOLVE_XFORM, ZCLIP, ZCONTAINS, ZDEGR, ZDEROTATE, ZGETPLUME, ZGRID
	ZHOVER, ZMKHDR, ZPAD, ZPRINTSUN, ZUNPAD, cartdist, cube_interp, datify, disp_sci160k [1]
	disp_sci160k [2], dpcstr [1], dpcstr [2], equalize_rasters, find_launchpoints
	fixinate_eit, fixinate_lasco, fixinate_trace, getct, hao_hdr, id_esc, id_unesc
	local_mag_extrap, make_grid_sphere, mdialign, mon_sci5k, plot_loi_mmad, radial_bkg
	redo_disploi, redo_mon_sci5k, struct_eq, trace_field, unpack_trace, wmatch, zaspect
	zbytscl, zcorralign, zcurs_ok, zd4, zdeheliographinize, zdiff_rot, zhelio2xy
	zheliographinize, zintervals, zmagoverlay, zmatch, zmontage, zmovie, zmovify
	zmovinate, zpb0r [1], zpb0r [2], zscale, zsi, zstructify, ztrack, zunits, zunspike
	zunwrap, zxy2helio
 RESTRICTIONS:
	None I know of....
 MODIFICATION HISTORY:
	Created by Craig DeForest, 4/13/1995