fig_tsmean [1] $SSW/hinode/eis/idl/analysis/fig_tsmean.pro
[Previous] [Next]
   fig_tsmean ,/ps

            plots temporal mean of spectrum

 CALLS:


FITS_HDR__DEFINE [1] $SSW/hinode/eis/idl/objects/fits_hdr__define.pro
[Previous] [Next]
 NAME:
       FITS_HDR__DEFINE

 PURPOSE:
       fits_hdr__define defines the class structure 'fits_hdr'. 
       An object of class 'fits_hdr' contains the fits header of
       SOLAR B EIS fits files.

 CATEGORY:
       Hansteen/Wikstol Data analysis SW

 CALLING SEQUENCE:
       The FITS_HDR__DEFINE procedure is not called directly. An
       object of class FITS_HDR is created with the following
       statement: 
                   fits_hdr = obj_new('fits_hdr')
       To fill the object with information use the following statement:
                     fits_hdr-> read, fitsfile

 INPUTS:

 KEYWORD PARAMETERS:

 OUTPUTS:
       Objects of class FITS_HDR

 CALLS: ***
	FITS_HDR::GETAEC_HEPC, FITS_HDR::GETAEC_LEPC, FITS_HDR::GETBTE_HDR
	FITS_HDR::GETCCD_NR, FITS_HDR::GETDATATYPE, FITS_HDR::GETDATE
	FITS_HDR::GETDATE_END, FITS_HDR::GETDATE_OBS, FITS_HDR::GETDURMHC
	FITS_HDR::GETDURSEC, FITS_HDR::GETFMIRR, FITS_HDR::GETHSL
	FITS_HDR::GETINSTRUME, FITS_HDR::GETLINE_WVL, FITS_HDR::GETMAIN_HDR
	FITS_HDR::GETMHCSG, FITS_HDR::GETOBS_PROG, FITS_HDR::GETOBS_TITLE
	FITS_HDR::GETOBT_END, FITS_HDR::GETOBT_TIME, FITS_HDR::GETORIGIN
	FITS_HDR::GETT1, FITS_HDR::GETT2, FITS_HDR::GETTELESCOP, FITS_HDR::GETXCEN
	FITS_HDR::GETXRT_FLFL, FITS_HDR::GETXRT_FL_X, FITS_HDR::GETXRT_FL_Y
	FITS_HDR::GETYCEN, FITS_HDR::INIT, FITS_HDR::SETBTE_HDR, FITS_HDR::SETDATATYPE
	FITS_HDR::SETMAIN_HDR
 CALLED BY:
	EIS_DATA_READFOREIGN, EIS_DATA__READFITS [1], EIS_DATA__READFITS [2]
 COMMON BLOCKS:
       

 PROCEDURE:
       The procedure opens an object of class FITS_HDR. The FITS_HDR
       class inherits the superclass HW_HDR, that defines the general
       structure of header classes used by the HW data analysis SW. 
       This procedure also includes various functions (methods of
       class  'fits_hdr' whose purpose is make data available to the
       "world" outside of the object.For example printing the FITS
       keyword "telescop", is done by the following statement:
               print, fits_hdr-> gettelescop()

 RESTRICTIONS:


 MODIFICATION HISTORY:
       13-Jan-2003: Oivind Wikstol.
       16-Feb-2004: Oivind Wikstol - Added hdr (full hdr) as instance
                                     of the fits_hdr object
       17-Feb-2004: Oivind Wikstol: Added BTE column auxiliary data (timing,
       positions etc.) to fits_hdr object.
       11-May-2004: Oivind Wikstol: Added setbte_hdr and setmain_hdr
       methods.
       14-Oct-2004: Moved nccd parameter to' hw_hdr' object.


FITS_HDR__DISPLAY [1] $SSW/hinode/eis/idl/objects/fits_hdr__display.pro
[Previous] [Next]
 NAME:
       FITS_HDR__DISPLAY

 PURPOSE:
       FITS_HDR__DISPLAY is a method of the class EIS_HDR. It is used
       to display the contents of a fits_hdr object as text.

 CATEGORY:
       Hansteen/Wikstol Data analysis SW

 CALLING SEQUENCE:
       fits_hdr-> display, textdump. fits_hdr is an object of class
       FITS_HDR, textdump is the output.

 INPUTS:


 KEYWORD PARAMETERS:

 OUTPUTS:
       Textdump: A string containing the values of all the parameters
       of the header object and a description of it.

 CALLS:
 COMMON BLOCKS:


 PROCEDURE:
       FITS_HDR__DISPLAY reads all the instance data of an FITS_HDR
       object, and stores it as strings in a string array together
       with a description of the data. All strings are then finallly
       joined in one long string (textdump) with CR at the rigth
       places. The variable 'textdump is the output from the method,
       and the header can then be displayed as text by printing
       'textdump'.

 RESTRICTIONS:


 MODIFICATION HISTORY:
       14-Oct-2004: Oivind Wikstol.


FITS_HDR__READ [1] $SSW/hinode/eis/idl/objects/fits_hdr__read.pro
[Previous] [Next]
 NAME:
       FITS_HDR__READ

 PURPOSE:
       FITS_HDR__READ reads EIS FITS headers and stores information
       in the object fields of an FITS_HDR class object. 

 CATEGORY:
       Hansteen/Wikstol Data analysis SW

 CALLING SEQUENCE:
       An object of class FITS_HDR is declared with this statement: 
                   hdrobj = obj_new('fits_hdr')

       FITS_HDR__READ reads EIS FITS headers and stores information
       into the object, with this statement:
                     hdrobj-> read, filename

       If called from within an fits_hdr procedure, the
       FITS_HDR__READ statement looks like this:
                     self-> read, file

 INPUTS:
       file:  Name of FITS file (string) containing EIS FITS data and headers.

 KEYWORD PARAMETERS:

 OUTPUTS:
       Reads EIS FITS files and fills the parameters of the FITS_HDR
       object with information.

 CALLS:
	HEADFITS [1], HEADFITS [2], HEADFITS [3], READFITS [1], READFITS [2], READFITS [3]
	TBGET
 CALLED BY:
	EIS_DATA_READFOREIGN, EIS_DATA__READFITS [1], EIS_DATA__READFITS [2]
 COMMON BLOCKS:
       

 PROCEDURE:
       
       

 RESTRICTIONS:


 MODIFICATION HISTORY:
       22-Jan-2003: Oivind Wikstol.
       16-Feb-2004: Oivind Wikstol - Added main header and bte header read
       31-OCT-2006: Harry Warren - Modified to read compressed fits files


FITS_HDR__READ [2] $SSW/hinode/eis/idl/objects/fits_hdr__readforeign.pro
[Previous] [Next]
 NAME:
       FITS_HDR__READ

 PURPOSE:

 CATEGORY:
       Hansteen/Wikstol Data analysis SW

 CALLING SEQUENCE:
       An object of class FITS_HDR is declared with this statement: 
                   hdrobj = obj_new('fits_hdr')

 INPUTS:
       file:  Name of FITS file (string) containing FITS data and headers.

 KEYWORD PARAMETERS:

 OUTPUTS:

 CALLS:
 CALLED BY:
	EIS_DATA_READFOREIGN, EIS_DATA__READFITS [1], EIS_DATA__READFITS [2]
 PROCEDURE:

 RESTRICTIONS:

 MODIFICATION HISTORY:


FXBOPEN [3] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_fxbopen.pro
[Previous] [Next]
 NAME: 
	FXBOPEN
 Purpose     : 
	Open binary table extension in a disk FITS file for reading or updating
 Explanation : 
	Opens a binary table extension in a disk FITS file for reading.  The
	columns are then read using FXBREAD, and the file is closed when done
	with FXBCLOSE.
 Use         : 
	FXBOPEN, UNIT, FILENAME, EXTENSION  [, HEADER ]
 Inputs      : 
       FILENAME  = Name of FITS file to be opened.  Optional
                   extension *number* may be specified, in either of
                   the following formats (using the FTOOLS
                   convention): FILENAME[EXT] or FILENAME+EXT, where
                   EXT is 1 or higher.  Such an extension
                   specification takes priority over EXTENSION.
                
	EXTENSION = Either the number of the FITS extension, starting with the
		    first extension after the primary data unit being one; or a
		    character string containing the value of EXTNAME to search
		    for.
 Opt. Inputs : 
	None.
 Outputs     : 
	UNIT	  = Logical unit number of the opened file.
 Opt. Outputs: 
	HEADER	  = String array containing the FITS binary table extension
		    header.
 Keywords    : 
	NO_TDIM	  = If set, then any TDIMn keywords found in the header are
		    ignored.

       ACCESS    = A scalar string describing access privileges as
                   one of READ ('R') or UPDATE ('RW').
                   DEFAULT: 'R'

       REOPEN    = If set, UNIT must be an already-opened file unit.
                   FXBOPEN will treat the file as a FITS file.

	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 = ''
			FXBOPEN, ERRMSG=ERRMSG, ...
			IF ERRMSG NE '' THEN ...

 Calls       : ***
	EIS_FXBOPEN, FXBFINDLUN [1], FXBFINDLUN [2], FXBPARSE [1], FXBPARSE [2]
	FXHREAD [1], FXHREAD [2], FXPAR [1], FXPAR [2]
 CALLED BY:
	CDS_IMAGE, CFITSLIST, CHECKCDSFITS, CW_XTD_NRHF, EIS_DATA_READFOREIGN
	EIS_DATA__READFITS [1], EIS_DATA__READFITS [2], FIND_FILE_DUR
	FITS CLASS DEFINITION, FITS_HDR__READ [3], FOPEN_NRH2, Fits_spectra [1]
	Fits_spectra [2], GET_CDS_TEMPS, GET_ORBIT [1], GET_ORBIT [2], GET_ORBIT_FITS
	GET_SC_ATT [1], GET_SC_ATT [2], GT_EXPTIME [2], GT_MIRRPOS, GT_NUMEXP, GT_NUMWIN
	GT_SLITNUM, GT_SLITPOS, GT_START, GT_WINSIZE, GT_WLABEL, GT_WNUM, ITOOL_RD_FITS
	JPLEPHREAD, LEC_NRH1D, LIT_HEADER_NRH1, Open Packet File, Open Score File
	PLOT_DELTAT, RDFILEPOS, RD_IMAGE_FITS, RD_LAS_CAT_FITS, READCALFITS, READCDSFITS
	READSUM2CDS, READ_CENTER_POINT [1], READ_CENTER_POINT [2], READ_COMPRESSED
	READ_SC_ATT, Radio Astronomy Group Fits Read
	Radiospectrogram FITS File reader [1], SHRINK_SUMER_FITS, SUMER_FITS
	TIME_IND_NRH, WCS_FIND_TABLE, eis_rd_sts_fits [1], eis_read_fits_data [2]
	eis_read_fits_data [3], eis_read_fits_header [1], eis_read_fits_header [2]
	eis_status_fits_reader1, ft_sumread_fits, gt_exptime [1]
	hsi_check_qlook_extensions, hsi_data_gap_fxbr, hsi_ephemeris_fxbr
	hsi_filedb_fxbr, hsi_flare_list_entry_fxbr, hsi_flare_list_info_fxbr
	hsi_obs_summ_data_fxbr, hsi_obs_summ_fxbr, hsi_obs_summ_info_fxbr
	hsi_obs_summ_inp, hsi_obs_summ_otp, hsi_obs_summ_read
	hsi_obs_summ_soc__define, hsi_obs_summ_write, hsi_qlook__define
	hsi_test_bad_file, mk_query [1], mk_query [2], mrdfits_spectra, rd_sumer [1]
	rd_sumer [2], read_cds_im, read_ovsa_fits, smei_hdr_get, where_are [1]
	where_are [2]
 Common      : 
	Uses common block FXBINTABLE--see "fxbintable.pro" for more
	information.
 Restrictions: 
	The file must be a valid FITS file.
 Side effects: 
	None.
 Category    : 
	Data Handling, I/O, FITS, Generic.
 Prev. Hist. : 
	W. Thompson, Feb 1992, based on READFITS by J. Woffard and W. Landsman.
	W. Thompson, Feb 1992, changed from function to procedure.
	W. Thompson, June 1992, fixed up error handling.
 Written     : 
	William Thompson, GSFC, February 1992.
 Modified    : 
	Version 1, William Thompson, GSFC, 12 April 1993.
		Incorporated into CDS library.
	Version 2, William Thompson, GSFC, 27 May 1994
		Added ERRMSG keyword.
	Version 3, William Thompson, GSFC, 21 June 1994
		Extended ERRMSG to call to FXBPARSE
       Version 4, William Thompson, GSFC, 23 June 1994
               Modified so that ERRMSG is not touched if not defined.
       Version 4, 23 June 1994
       	Converted to IDL V5.0   W. Landsman   September 1997

 Added ACCESS, REOPEN keywords, and FXFILTER package, CM 1999 Feb 03
 Added FILENAME[EXT] and FILENAME+EXT extension parsing, CM 1999 Jun 28
 Some general tidying, CM 1999 Nov 18

 mcrw Dec 2006 Added /compressed keyword to file open call.
               Renamed file to eis_fxbopen