METRIC Tool

METRIC Library

Last modified: Wed Dec 05 10:45:22 2001.

• CRIT_DES_QUAL
• CRIT_DES_R443
• CRIT_DES_SPEC
• CRIT_GLI_MASK
• CRIT_GLI_PRES
• CRIT_GLI_QUAL
• CRIT_GLI_REF
• CRIT_GLI_UNIF
• CRIT_GLI_WAVE
• CRIT_GLI_WIND
• CRIT_RAY_AERO
• CRIT_RAY_CLOUD
• CRIT_RAY_MASK
• CRIT_RAY_QUAL
• CRIT_RAY_WAVE
• CRIT_RAY_WIND
• GET_FLAGBYTYPE
• LIMITS_IMAGE
• METRIC_LD
• METRIC_MAP
• METRIC_TEST
• RD_HDFMETRIC
• RD_L1MASK
• RD_SITES
• SELECTED_PIXELS
• TEST_ALL
• TEST_AVERAGING
• TEST_COUNTERS
• TEST_CRIT_DES_QUAL
• TEST_CRIT_DES_R443
• TEST_CRIT_DES_SPEC
• TEST_CRIT_GLI_MASK
• TEST_CRIT_GLI_PRES
• TEST_CRIT_GLI_QUAL
• TEST_CRIT_GLI_REF
• TEST_CRIT_GLI_UNIF
• TEST_CRIT_GLI_WAVE
• TEST_CRIT_GLI_WIND
• TEST_CRIT_RAY_AERO
• TEST_CRIT_RAY_CLOUD
• TEST_CRIT_RAY_MASK
• TEST_CRIT_RAY_QUAL
• TEST_CRIT_RAY_WAVE
• TEST_CRIT_RAY_WIND
• TEST_DATECHANGE
• TEST_FORMAT
• TEST_GEO_DATE_2TEST
• TEST_INTERSECT
• TEST_MACROPIX
• TEST_POLE
• TEST_RESAMPLING
• TEST_ROIWRTSEL
• TEST_SEGMENT
• TEST_TIMEVALIDITY

Routine Descriptions

 NAME:
		crit_DES_qual

 PURPOSE:
		tests the quality of the pixels for desert sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_DES_qual(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_desert.pro)

 NAME:
		crit_DES_r443

 PURPOSE:
		tests whether pixels are bright(cloud) in the band2 for desert sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_DES_r443(mer_prod, l1_mask, param, r_443)

(See $METRICDIR\src\idl\criteria_desert.pro)

 NAME:
		crit_DES_spec

 PURPOSE:
		tests whether pixels have the spectral comportement of cloudy pixels for desert sites
;
 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_DES_spec(mer_prod, l1_mask, param, S)

(See $METRICDIR\src\idl\criteria_desert.pro)

 NAME:
       crit_GLI_mask

 PURPOSE:
       tests whether pixels are near the coasline for GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_mask(mer_prod, l1_mask, param, data)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_GLI_pres

 PURPOSE:
		tests whether pixels are cloudy by testing their apparent pressure for GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_pres(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_GLI_qual

 PURPOSE:
		tests the quality of the pixels for GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_qual(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_GLI_ref

 PURPOSE:
		tests the reflectance and the radiance of the p™xels in band 13 for GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_ref(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_GLI_unif

 PURPOSE:
		tests the uniformity (to eliminate cloud) for GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_unif(mer_prod, l1_mask, param, RES0)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_GLI_wave

 PURPOSE:
		tests the wave angle above which there is GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_wave(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_GLI_wind

 PURPOSE:
		tests the wind speed (no foam) for GLITTER conditions

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_GLI_wind(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_glitter.pro)

 NAME:
		crit_RAY_aero

 PURPOSE:
		tests whether there is not to much aerosol for Rayleigh calibration

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_RAY_aero(mer_prod, l1_mask, param , tau_aero)

(See $METRICDIR\src\idl\criteria_rayleigh.pro)

 NAME:
		crit_RAY_cloud

 PURPOSE:
		tests whether pixels are near a cloud(bright) for Rayleigh sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_RAY_cloud(mer_prod, l1_mask, param, data)

(See $METRICDIR\src\idl\criteria_rayleigh.pro)

 NAME:
		crit_RAY_mask

 PURPOSE:
		tests whether pixels are near the coastline for Rayleigh sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_RAY_mask(mer_prod, l1_mask, param, data)

(See $METRICDIR\src\idl\criteria_rayleigh.pro)

 NAME:
		crit_RAY_qual

 PURPOSE:
		tests the quality of the pixels for Rayleigh sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_RAY_qual(mer_prod, l1_mask, param, data)

(See $METRICDIR\src\idl\criteria_rayleigh.pro)

 NAME:
		crit_RAY_wave

 PURPOSE:
		tests whether the wave angle doesn t allow glitter conditions for Rayleigh calibration

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_RAY_wave(mer_prod, l1_mask, param, data)

(See $METRICDIR\src\idl\criteria_rayleigh.pro)

 NAME:
		crit_RAY_wind

 PURPOSE:
		tests the wind speed (not to have foam) for Rayleigh sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=crit_RAY_wind(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\criteria_rayleigh.pro)

 NAME:
		GET_FLAGBYTYPE

 PURPOSE:
		outputs Flag names for each site type

 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\get_flagbytype.pro)

 NAME:
		LIMITS_IMAGE

 PURPOSE:
		retrieves the limits (=[Latmin, Lonmin, Latmax, Lonmax]) of an image

 CATEGORY:
		I/O

 CALLING SEQUENCE:
		limit=LIMITS_IMAGE(PRDFILE=prdfile)

(See $METRICDIR\src\idl\limits_image.pro)

 NAME:
		METRIC_LD

 PURPOSE:
		loads data

 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\metric_ld.pro)

 NAME:
		METRIC_MAP

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\metric_map.pro)

 NAME:
		METRIC_TEST

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_all.pro)

 NAME:
       RD_HDFMETRIC

 PURPOSE:
       retrieves all data from an METRIC HDF product file.

 CATEGORY:
      INPUT/OUTPUT

 CALLING SEQUENCE:
	   res=RD_HDFMETRIC(FILENAME=filename,STRUCT=struct,/ATT)

 INPUTS:
      filename - HDF input filename

 OPTIONAL INPUTS:
      None

 KEYWORD PARAMETERS:
      ATT - if set then only global attributes are extracted

 OUTPUTS:
      None - the struct output is optional (see below)

 OPTIONAL OUTPUTS:
      struct - structure that will all the data of the HDF file
			w/ the two following main tags:
			DATA - data of the HDF file
			ATT - attributes of the HDF file
				which themselves are arrays of structure holding
               the three following tags:
					for the DATA structure:
 						NAME   	string data name
   					DATA   	pointer to the dataset
   					ATT 	pointer to the data attribute
                   ,and for the ATT structure:
 						NAME   	string attribute name
   					DATA   	pointer to the attribute
			in other words the output structure reflects
           completely the HDF file structure.

 COMMON BLOCKS:
      None

 SIDE EFFECTS:
      Unknown

 RESTRICTIONS:
		Beware of the nested pointers, for deleting the structure
       you should release memory of the nested structure before
       deleting the structure variable.

 PROCEDURE:
		The HDf file is first scanned w/ the HDF_SD_ATTRINFO function
		to get its structures, then all attributes and data sets are
       scanned one by one and the output structure created dynamically
       with the information found in the HDF file.

 EXAMPLE:
		filename='L:\data\METRIC\tests\format_content\test_Averaging\output\RAYLEIGH_TEST_NORTH_POLE_DATLINE_L1b_20000620_104318_00000.hdf'
		status=RD_HDFMETRIC(FILENAME=filename,STRUCT=struct)
		print,(struct.data)[*].name
		help,(struct.data)[*].name
		help,(struct.data)[3:4].name
		help,struct.att.name
		help,(struct.att)[*].name

		status=RD_HDFMETRIC(STRUCT=struct)

 MODIFICATION HISTORY:
       Created by Vincent Fournier-Sicre - vfs@acri-st.fr - June 2001

(See $METRICDIR\src\idl\rd_hdfmetric.pro)

 NAME:
		RD_L1MASK


 PURPOSE:



 CATEGORY:



 CALLING SEQUENCE:



 INPUTS:



 OPTIONAL INPUTS:



 KEYWORD PARAMETERS:



 OUTPUTS:



 OPTIONAL OUTPUTS:



 COMMON BLOCKS:



 SIDE EFFECTS:



 RESTRICTIONS:



 PROCEDURE:



 EXAMPLE:
   filename='/u7/metric/output/RAYLEIGH_TEST_GEOLOC_L1b_20000620_104450_00000.bin'
   res=RD_L1MASK(FILENAME=filename)

 MODIFICATION HISTORY:

(See $METRICDIR\src\idl\rd_l1mask.pro)

 NAME:
       RD_SITES

 PURPOSE:
       retrieves all sites specifications

 CATEGORY:
       I/O

 CALLING SEQUENCE:
       sites=RD_SITES(FILENAME=filename)

(See $METRICDIR\src\idl\rd_sites.pro)

 NAME:
		SELECTED_PIXELS

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\selected_pixels.pro)

 NAME:
		TEST_ALL

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_all.pro)

 NAME:
		test_Averaging

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_format_output.pro)

 NAME:
		test_Counters

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_format_output.pro)

 NAME:
		test_crit_DES_qual

 PURPOSE:
		tests the quality of the pixels for desert sites

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_DES_qual(DATADIR=datadir)

(See $METRICDIR\src\idl\test_desert.pro)

 NAME:
		test_crit_DES_r443

 PURPOSE:
		tests whether pixels are bright(cloud) in the band2 for desert sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=test_crit_DES_r443(DATADIR=datadir)

(See $METRICDIR\src\idl\test_desert.pro)

 NAME:
		test_crit_DES_spec

 PURPOSE:
		tests whether pixels have the spectral comportement of cloudy pixels for desert sites
;
 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=crit_DES_spec(DATADIR=datadir)

(See $METRICDIR\src\idl\test_desert.pro)

 NAME:
		test_crit_GLI_mask

 PURPOSE:
		tests whether pixels are near the coasline for GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_mask(DATADIR=datadir)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_GLI_pres

 PURPOSE:
		tests whether pixels are cloudy by testing their apparent pressure for GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_pres(DATADIR=datadir)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_GLI_qual

 PURPOSE:
		tests the quality of the pixels for GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_qual(DATADIR=datadir)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_GLI_ref

 PURPOSE:
		tests the reflectance and the radiance of the p™xels in band 13 for GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_ref(DATADIR=datadir)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_GLI_unif

 PURPOSE:
		tests the uniformity (to eliminate cloud) for GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_unif(DATADIR=datadir)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_GLI_wave

 PURPOSE:
		tests the wave angle above which there is GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_wave(DATADIR=datadir)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_GLI_wind

 PURPOSE:
		tests the wind speed (no foam) for GLITTER conditions

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_GLI_wind(mer_prod, l1_mask, param)

(See $METRICDIR\src\idl\test_glitter.pro)

 NAME:
		test_crit_RAY_aero

 PURPOSE:
		tests whether there is not too much aerosol for Rayleigh calibration

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_RAY_aero(DATADIR=datadir)

(See $METRICDIR\src\idl\test_rayleigh.pro)

 NAME:
		test_crit_RAY_cloud

 PURPOSE:
		tests whether pixels are near a cloud(bright) for Rayleigh sites

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_RAY_cloud(DATADIR=datadir)

(See $METRICDIR\src\idl\test_rayleigh.pro)

 NAME:
		test_crit_RAY_mask

 PURPOSE:
		tests whether pixels are near the coastline for Rayleigh sites

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_RAY_mask(DATADIR=datadir)

(See $METRICDIR\src\idl\test_rayleigh.pro)

 NAME:
		test_crit_RAY_qual

 PURPOSE:
		tests the quality of the pixels for Rayleigh sites

 CATEGORY:
		criteria testing

 CALLING SEQUENCE:
		status=test_crit_RAY_qual(DATADIR=datadir)

(See $METRICDIR\src\idl\test_rayleigh.pro)

 NAME:
		test_crit_RAY_wave

 PURPOSE:
		tests whether the wave angle doesn t allow glitter conditions for Rayleigh calibration

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_RAY_wave(DATADIR=datadir)

(See $METRICDIR\src\idl\test_rayleigh.pro)

 NAME:
		test_crit_RAY_wind

 PURPOSE:
		tests the wind speed (not to have foam) for Rayleigh sites

 CATEGORY:
		criteria testing (calling)

 CALLING SEQUENCE:
		status=test_crit_RAY_wind(DATADIR=datadir)

(See $METRICDIR\src\idl\test_rayleigh.pro)

 NAME:
		test_DateChange

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)

 NAME:
		test_Format

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_format_output.pro)

 NAME:
		test_geo_date_2test

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)

 NAME:
		test_Intersect

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)

 NAME:
		test_MacroPix

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_format_output.pro)

 NAME:
		test_Pole

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)

 NAME:
		test_Resampling

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_format_output.pro)

 NAME:
		test_ROIwrtSEL

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)

 NAME:
		test_Segment

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)

 NAME:
		test_TimeValidity

 PURPOSE:


 CATEGORY:


 CALLING SEQUENCE:

(See $METRICDIR\src\idl\test_geo_date.pro)