Headers for LASCO IDL Library: CONVERT

This page was created by IDL lasco_mk_html_help.pro on Fri Jan 12 09:28:43 2007.


List of Routines


Routine Descriptions

AIR2VAC

[List of Routines] (See ./w_air2vac.pro)

 NAME:  
	air2vac

 PURPOSE:
	Convert air wavelength to vacuum wavelength

 CALLING SEQUENCE:
	air2vac

 INPUTS:
	wa - air wavelength (Angstroms)

 OPTIONAL INPUTS:
	none

 KEYWORD PARAMETERS:
	none

 OUTPUTS:
	The value returned is the vacuum wavelength (in Angstroms)
	corresponding to the input air wavelength.

 OPTIONAL OUTPUTS
	none
	
 COMMON BLOCKS:
	None

 SIDE EFFECTS:
	None

 RESTRICTIONS:
	Results are valid only between 2960 and 13000 Angstroms

 PROCEDURE:
	This procedure is the same algorithm used by Kurucz, et. al.
	"Solar Flux Atlas From 296 to 1300 nm", National Solar
	Observatory Atlas No. 1, June 1984.

 MODIFICATION HISTORY:
	Adapted from a FORTRAN program provided by R. Kurucz via
	private communication. Adapted by Paul Reiser July 22, 1997.


CNVRT2REF

[List of Routines] (See ./cnvrt2ref.pro)

 NAME:
	CNVRT2REF

 PURPOSE:
	This procedure converts coordinate system to the standard coordinate 
	system using the FITS keyword notation

 CATEGORY:
	DATA_ANAL
	Widgets.

 CALLING SEQUENCE:
	CNVRT2REF, Hdr, Level

 INPUTS:
	Hdr:	FITS header
	Level:	String indicating level to define coordinate system:
			'0.5', '1', '2'

 OUTPUTS:
	None

 SIDE EFFECTS:
	Keywords are added to the FITS header:
		CRPIX, CRVAL, CROTA, CDELT, CTYPE, CUNIT

 MODIFICATION HISTORY:
       RA Howard, NRL, 14 April 1996
	Vers 1   14 Apr 1996, Initial Release

	@(#)cnvrt2ref.pro	1.1 03/06/97 LASCO IDL LIBRARY


CNVRT_FILTER

[List of Routines] (See ./cnvrt_filter.pro)

 NAME:				CNVRT_FILTER

 PURPOSE:			Interprets the LASCO/EIT filter number into a 
				text string (or the reverse: str to int)

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = CNVRT_FILTER( Tel, Filt)

 INPUTS:			Tel   = Telescope number (0..3)
				Filt  = Filter number (0..4) or string ('Orange')

 OUTPUTS:			Result = Text string containing the description
					or integer index of filter (if filt is type string)

 MODIFICATION HISTORY:		Written RA Howard, NRL
				Version 1   RAH  15 Nov 1995
				Version 2   RAH  04 Apr 1996   Changed EIT
                               Version 3   AEE  09 Jul 1996   Allowed array inputs.
                               Version 4   SEP  30 Aug 1996   Modified to allow reverse conversion
								Note: does not work with tel array inputs

	@(#)cnvrt_filter.pro	1.1 04 Apr 1996 LASCO IDL LIBRARY


CNVRT_IP

[List of Routines] (See ./cnvrt_ip.pro)

 NAME:				CNVRT_IP

 PURPOSE:			Convert image processing steps into one 
                               character per step codes.

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = CNVRT_IP(Hdr)

 INPUTS:			Hdr:    Header Structure

 OPTIONAL INPUTS:		None
	
 KEYWORD PARAMETERS:		None

 OUTPUTS:			Result:  String containing the IP characters

 OPTIONAL OUTPUTS:		None

 COMMON BLOCKS:		None

 SIDE EFFECTS:			None

 RESTRICTIONS:			None

 PROCEDURE:			

 EXAMPLE:

 MODIFICATION HISTORY:		Written, RA Howard, NRL
    VERSION 1   rah   30 Nov 1995
    VERSION 2   sep   31 May 1996  Modified to read data from cnvrt_ip.dat
    VERSION 3   rah   14 Jun 1996  Modified ip_arr structure names

	@(#)cnvrt_ip.pro	1.2 03/06/97 LASCO IDL LIBRARY


CNVRT_LP

[List of Routines] (See ./cnvrt_lp.pro)

 NAME:				CNVRT_LP

 PURPOSE:			Interprets the LEB Programs (LP) number 
				into a string

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = CNVRT_LP ( Lpnum)

 INPUTS:			Lpnum  = LP number (0..23)
					-or- string containing the description

 OUTPUTS:			Result = string containing the description
					-or- lpnum (0..23)

 MODIFICATION HISTORY:		Written  RA Howard, NRL, 15 Nov 1995
				Version 1   RAH, 15 Nov 1995  Initial Release
				Version 2   NBR,  2 Nov 1998  allow string input for number output
							jake	030811	added AltMech = 25


       @(#)cnvrt_lp.pro	1.1 03/06/97 LASCO IDL LIBRARY


CNVRT_POLAR

[List of Routines] (See ./cnvrt_polar.pro)

 NAME:				CNVRT_POLAR

 PURPOSE:			Interprets the LASCO/EIT polarizer wheel
				number into a text string

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = CNVRT_POLAR ( Tel, Polar)

 INPUTS:			Tel   = Telescope number (0..3)
				Polar  = Polarizer wheel number (0..4)

 OUTPUTS:			Result = string containing the description

 MODIFICATION HISTORY:		Written   RA Howard, NRL, 15 Nov 1995
				Version 1	RAH 15 Nov 1995 Initial Release
				Version 2	RAH 02 Dec 1996 Changed EIT
                               Version 3       AEE 09 Jul 1996 Allowed array
                                                               inputs.

 @(#)cnvrt_polar.pro	1.4 07/23/97 :NRL Solar Physics



CNVRT_PORT

[List of Routines] (See ./cnvrt_port.pro)

 NAME:				CNVRT_PORT

 PURPOSE:			Interprets the readout port number into
				a text string

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = CNVRT_PORT (Port)

 INPUTS:			Port  =  Read port number (0..3)

 OUTPUTS:			Result = string containing the description

 MODIFICATION HISTORY:		Written		RA Howard, NRL
				Version 1	RAH, 15 Nov 1995 Initial Release

       @(#)cnvrt_port.pro	1.1 03/06/97 LASCO IDL LIBRARY


CNVRT_RO_COORDS

[List of Routines] (See ./cnvrt_ro_coords.pro)

 NAME:
       CNVRT_RO_COORDS

 PURPOSE:
       This procedure converts readout coordinates, P1 and P2, to new 
       values depending upon the readout port.

       The LASCO/EIT CCDs may be read out from any of the four ports.
       However, the P1 and P2 coordinates are specified according to
       the readout port.  This routine converts the P1 and P2 into 
       values that would have been used had the readout been from port A.

 CATEGORY:
       REDUCTION

 CALLING SEQUENCE:
       CNVRT_RO_COORDS, P1in, P2in, Port, P1out, P2out

 INPUTS:
       P1in	A two word array giving the column and row numbers of the
               P1 point.
       P2in	A two word array giving the column and row numbers of the
               P2 point.
       Port	A string of indicaing the readout port, 'A',..'D' 

 OUTPUTS:
       P1out	A two word array giving the rectified column and row 
               numbers of the P1 coordinate.
       P2out	A two word array giving the rectified column and row 
               numbers of the P2 coordinate.

 RESTRICTIONS:
       The coordinates are only truly valid if the image area is not
       over or underscanned, that is the image area is from the CCD
       parallel register.

 MODIFICATION HISTORY:
       Written		RAHoward  NRL 6 November 1995
	Version		1

       @(#)cnvrt_ro_coords.pro	1.1 03/06/97 LASCO IDL LIBRARY


DISTORTION_COEFFS

[List of Routines] (See ./distortion_coeffs.pro)

 NAME:			        DISTORTION_COEFFS	

 PURPOSE:			Returns a 3-element array of distortion 
                               coefficients (mm) for the requested telescope

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = DISTORTION_COEFFS (Telescope)

 INPUTS:			Telescope = Number of the telescope that the
					    distortion coefficients are desired
                                           Either (C1..C4/EIT) or (0..3)

 OPTIONAL INPUTS:		None
	
 KEYWORD PARAMETERS:		None

 OUTPUTS:			Result = A 3-element array of distortion 
					 coefficients in millimeters (mm). 
                                        Returns zeros if telescope not defined.

 OPTIONAL OUTPUTS:		None

 COMMON BLOCKS:		None

 MODIFICATION HISTORY:		Written,  AEE, NRL
   Version 1  aee  24 Nov 1998
	nbr  21 Jul 2000 - Put version info in common block


ersion= '@(#)distortion_coeffs.pro	1.3 08/07/00' ; LASCO IDL LIBRARY 


FIX_HT_SCALE

[List of Routines] (See ./fix_ht_scale.pro)

 NAME:
	FIX_HT_SCALE

 PURPOSE:
	This procedure is used to fix the scaling of the HT files

 CATEGORY:
	MOVIE

 CALLING SEQUENCE:
	FIX_HT_SCALE,Fname

 INPUTS:
	Fname:	String containing the filename to be fixed

 OUTPUTS:
	This routine renames the filename to Fname.old and copies the 
	information to a new file, correcting the scaling factors.

 COMMON BLOCKS:
	None

 RESTRICTIONS:
	The file should not have any blank lines.

 PROCEDURE:

 MODIFICATION HISTORY:
 	Written by:	RAH, 9 May 97

 @(#)fix_ht_scale.pro	1.1 05/14/97 :NRL Solar Physics


OFFSET_BIAS

[List of Routines] (See ./offset_bias.pro)

 NAME:			OFFSET_BIAS

 PURPOSE:		Provides the electronic offset introduced for
			each readout port

 CATEGORY:		LASCO Calibration

 CALLING SEQUENCE:	Offset = OFFSET_BIAS(Telescope,Readport)

 INPUTS:		Telescope = String indicating telescope
				Values are 'C1','C2','C3','EIT'
			Readport = String indicating read out port
				Values are 'A','B','C','D'

 OPTIONAL INPUTS:	Date= string giving the date as YYMMDD

 KEYWORD PARAMETERS:	SUM:	If present, computes the proper bias for LEB Summing

 OUTPUTS:		Integer giving the offset bias in DN

 OPTIONAL OUTPUT PARAMETERS:
 COMMON BLOCKS:
 SIDE EFFECTS:
 RESTRICTIONS:
 PROCEDURE:		Obtained from flight calibration

 MODIFICATION HISTORY:
			RA Howard Writen 6 Feb 1996
      V1    RAH   02/06/96     Initial Release
      V2    RAH   06/02/97     Added function of date to C3
      V3    RAH   06/10/97     Added function of date to C1 & C2
      V4    RAH   08/21/97     Added correction for leb summing
      V5    RAH   06/08/98     Updates to C2 and C3 coefficients for port C
      V6    RAH   06/10/98     Updates to C2 and C3 coefficients for port C, QL through 5/98
      V7    RAH   09/18/98     Updates to C2 and C3 coefficients for port C, LZ through 6/21/98
      V8    NBR   10/21/98	Use lasco_ftshdr2struct, not ftshdr2struct
      V9    RAH   08/20/99     Updates to C2 and C3 coefficients for port C
      V10   RAH   12/21/99     Updates to C2 and C3 coefficients for port C
      V11   RAH   01/21/00     Syntax change from ENDIF to END for IDL 5.3
      V12   RAH   07/03/00     Updates to C2 and C3 coefficients for port C
	NBR, 08/04/00 - Use SCCS version number; Add HISTORY to header if FITS header
      V13   RAH   01/06/01     Updates to C2 and C3 coefficients for port C, split c2 before/after mispoint
      V14   RAH   12/13/01     Updates to C2 and C3 coefficients for port C
      V15   RAH   07/09/02     Updates to C2 and C3 coefficients for port C
      V16   RAH   05/11/05     Updates to C2 and C3 coefficients for port C


READ_IP_DAT

[List of Routines] (See ./read_ip_dat.pro)

 NAME:
	READ_IP_DAT

 PURPOSE:
	Returns an array of structures comtaining defined
	image processing id codes and descriptions.

 CATEGORY:
	LASCO CONVERT

 CALLING SEQUENCE:
	Result = READ_IP_DAT ()

 INPUTS:
	None

 OUTPUTS:
	Result = array of structures containing:
		Result.ip_num    ;int: compression type as understood by OBE
		Result.ip_char   ;string: 1 character compression code 
		Result.ip_description  	;string: String describing compression step 

 CALLS:
	GET_DB_STRUCT

 RESTRICTIONS:
	The file cnvrt_ip.dat must exist in $NRL_LIB/lasco/convert

 MODIFICATION HISTORY:
         Written,  SE Paswaters, NRL
   Version 1  sep  13 Jun 1996
     Karl Battams   2 Nov 2005 - Add swap_if_little_endian keyword for opening binary data files

       @(#)read_ip_dat.pro	1.6 11/02/05  LASCO IDL LIBRARY


READ_OCC_DAT

[List of Routines] (See ./read_occ_dat.pro)

 NAME:
         READ_OCC_DAT

 PURPOSE:
         Returns an array of structures containing LASCO occulter centers, and EIT Sun Centers

 CATEGORY:
         LASCO CONVERT

 CALLING SEQUENCE:
         Result = READ_OCC_DAT ()

 INPUTS:
         None

 OUTPUTS:
         Result = 4 by 5 by 2 element array of structures containing:
			 4 for C1,C2,C3,EIT
			 5 for filter position
			 2 for valid dates (now have only two)
                   Result.xcen    ;double: x center of occulter
                   Result.ycen    ;double: y center of occulter
                   Result.mjd     ;long: start date of validity

 RESTRICTIONS:
         The file occulter_center.dat must exist in $NRL_LIB/lasco/convert

 MODIFICATION HISTORY:
         Written,  SE Paswaters, NRL
         Version 1  sep  30 Aug 1996
         Version 2  rah  27 Nov 1998	added valid date
	11 Jan 2002, nbr - Change path for windows compatibility
       Karl Battams   2 Nov 2005 - Add swap_if_little_endian keyword for opening binary data files

 11/02/05 @(#)read_occ_dat.pro	1.9 :NRL Solar Physics



SUBTENSE

[List of Routines] (See ./subtense.pro)

 NAME:				SUBTENSE

 PURPOSE:			Returns the angular subtense (arc sec/pixel)
				for the requested telescope

 CATEGORY:			REDUCTION

 CALLING SEQUENCE:		Result = SUBTENSE (Telescope)

 INPUTS:			Telescope = Number of the telescope that the
					    angular subtense is desired
                                           Either (C1..C4/EIT) or (0..3)

 OPTIONAL INPUTS:		None
	
 KEYWORD PARAMETERS:		None

 OUTPUTS:			Result = angular subtense of a pixel in arc 
					 seconds

 OPTIONAL OUTPUTS:		None

 COMMON BLOCKS:		None

 MODIFICATION HISTORY:		Written,  RAH, NRL
   Version 1  rah  5 Nov 1995
   Version 2  rah  13 Apr 1996		Added test for telescope as string
   Version 3  rah   6 May 1997		Changed C2 and C3 based on star transits
   Version 4  sep  16 Dec 1997		Changed EIT from 2.8 to 2.59
   Version 4  rah  26 Feb 1998		Changed C2 from 12.4 to 12.1
   Version 5  sep   7 Apr 1998		Changed C1 from 5.6 to 5.8
   Version 6  sep  28 Aug 1998		Mods for telescope being a structure
   Version 7  rah  12 Nov 1998		Mods for MLO MK3 k-coronameter
   Version 8  rah  20 Nov 1998		Changed C2 from 12.1 to 11.9
   Version 9  dab  14 Jan 2000		Mods for MLO MK$ k-coronameter
	nbr	26 Jul 2000	Use SCCS version for reduce_history common block

 SCCS variables for IDL use
 
ersion= '@(#)subtense.pro	1.13 08/07/00' ; LASCO IDL LIBRARY


W_VAC2AIR

[List of Routines] (See ./w_vac2air.pro)

 NAME:  
	w_vac2air

 PURPOSE:
	Convert vacuum wavelength to air wavelength

 CALLING SEQUENCE:
	w_vac2air

 INPUTS:
	wv - vacuum wavelength (Angstroms)

 OPTIONAL INPUTS:
	none

 KEYWORD PARAMETERS:
	none

 OUTPUTS:
	The value returned is the air wavelength (in Angstroms)
	corresponding to the input vacuum wavelength.

 OPTIONAL OUTPUTS
	none
	
 COMMON BLOCKS:
	None

 SIDE EFFECTS:
	None

 RESTRICTIONS:
	Results are valid only between 2960 and 13000 Angstroms

 PROCEDURE:
	This procedure is the same algorithm used by Kurucz, et. al.
	"Solar Flux Atlas From 296 to 1300 nm", National Solar
	Observatory Atlas No. 1, June 1984.

 MODIFICATION HISTORY:
	Adapted from a FORTRAN program provided by R. Kurucz via
	private communication. Adapted by Paul Reiser July 22, 1997.


This page was created by IDL lasco_mk_html_help.pro on Fri Jan 12 09:28:43 2007.