Home

CALXtract User Guide

1. CALXtract User Guide Ref 0605004 NT UDEV V01 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 17 Name P3L1 Q Stokes 490P P3L1 Q Stokes 670P P3L1 Q Stokes 865P P3L1 U Stokes 490P P3L1 U Stokes 670P P3L1 U Stokes 865P MYDO21KM_Input File_Ind ex MYD021KM_Input_Pixel_In dex Description Second component of Stokes Unit Type vector Q for Channel 490P for unitless int16 16 each direction Second component of Stokes vector Q for Channel 670P for unitless int16 16 each direction Second component of Stokes vector Q for Channel 865P for unitless int16 16 each direction Third component of Stokes vector U for Channel 490P for each direction unitless int16 16 Third component of Stokes vector U for Channel 670P for each direction unitless int16 16 Third component of Stokes vector U for Channel 865P for each direction MODIS MYDO21KM unitless int16 16 Index of the input file where the in the file attributes to see the of files Index i_row icol of the coincident Pixel in the input granule Earth View 250M Aggregated MYDO21KM_EV_250 Aggrl 1km Reflective Solar Bands km_RefSB_Band1 Scaled Integers of channel n 1 0 645um Earth View 250M Aggregated MYD0O21KM_EV_250 Aggrl 1km Reflective Solar Bands km_RefSB_Band2 Scaled Integers of channel n 2 0 865um Earth View 500M Aggregated
2. S z Ed 1 Date 11 04 06 de Traitement de Donn es Gu amp Date 31 08 09 Software version 0 6 5 Number of pages 30 CALXTRACT project extraction of multi sensors data in coincidence with CALIPSO CALXtract User Guide Name Date Signature Prepared by Nicolas PASCAL James MANLEY ICARE CGTD UDEV 31 08 09 Approved by For Application CALXtract User Guide Ref 0605004 NT UDEV VO1 R06 Eek s dl Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 2 MODIFICATIONS Edition Revision Date Revision Purpose 1 0 11 04 06 Creation 1 1 31 05 07 The philosophy of the project has also been changed At the beginning calxtract was supposed to be a tool that can be run by any user At this time the focus points more on the products which are built by the Icare exploitation team Update to reflect changes in the calxtract software v0 3 3 New variables have been added in the caltrack products This document includes those addings The unit of the Optical Thickness variables has been set as none In previous revision it was set as km 27 07 07 New variables have been added in the caltrack products This document includes those addings The MODIS Modis_Rad_ XX which were ignored and the PARASOL water vapour collum The generated file doe
3. MYD021KM_EV_500 Aggrl 1km Reflective Solar Bands km_RefSB_Band3 Scaled Integers of channel n 3 0 469um Earth View 500M Aggregated MYDO21KM_EV_500 Aggrl 1km Reflective Solar Bands km_RefSB_Band4 Scaled Integers of channel n 4 0 555um coincidence has been found See list unitless int16 2 unitless int16 W m um sr uint16 W m 2 um sr uint16 W m 2 um sr uint16 W m um sr uint16 CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 18 Name Description Unit Type Earth View 500M Aggregated MYDO21KM_EV_500 Aggrl 1km Reflective Solar Bands 5 km_RefSB_Band5 Scaled Integers of channel n 5 ZER UIEN 1 240um Earth View 500M Aggregated MYDO21KM_EV_500 Aggrl 1km Reflective Solar Bands 3 km_RefSB_Band6 Scaled Integers of channel n 6 HOME SIE 1 640um Earth View 500M Aggregated MYDO21KM_EV_500 Aggrl 1km Reflective Solar Bands 5 km_RefSB_Band7 Scaled Integers of channel n 7 PANIER UEL 2 130um Earth View 1KM Reflective Solar MYDO 1KM_EV_IKM_RefSB Bands Scaled Integers of channel W m um sr uint16 n 8 0 4125yum Earth View 1KM Reflective Solar a re Ne Bands Scaled Integers of channel W m2 um sr uint16 n 9 0 443um Earth View 1KM Reflective Solar EE EE Bands Scaled Integers of channel W m2 um sr uint16 n 10 0 488um Earth View 1KM Reflective Solar E Bands Scaled Integers of channel W m
4. 90 Land 100 100 Land P3L2TRGB_Cos Solar Zen Cosine of the Solar Zenith Angle th_Angle for central pixel aka mus SE ne Relative Angular standard EE E deviation of the Scene Albedo uint8 g aka rad_ascvis Homogeneity coefficient of the optical thickness T T e E where Tt is the scene mean dE optical thickness and tT is the unitless uint8 g y optical thickness derived from the scene mean reflectance aka eps_tau MODIS MYD04_L2 Index of the input file where the e coincidence has been found See l MYDO4_ Input File Index inthe file attributes to see th list unitless intl6 of files Index i_row icol of the MYDO04 Input Pixel Index coincident Pixel in the input unitless int16 granule Aerosol Optical Thickness at 0 55 MYDO4 Optical Depth Lan micron for both ocean best and nitesi int16 d_And_Ocean land corrected with best quality data Quality flag 3 MYD04_Optical_Depth_Rati Ratio of small mode optical depth e o Small Land And Ocean at 0 55 micron EHS RES Aerosol Optical Thickness at 7 MYDO4 Effective Optical bands for best solution for 0 47 Depth Best Ocean 0 55 0 66 0 86 1 24 1 63 2 13 He at LOL um MYDO4 Angstrom_Expone Angstrom Exponent for 0 55 and nt_1_ Ocean 0 86 micron amiss int16 2 MODIS MYDO5_L2 Index of the input file where the MYDO5 Input File Index coincidence has been found See unitless int16 2 in the file attributes to see the list of files CALXtract User Guide
5. clouds with lower chance of a being a false detection Gaseous attenuation Radar reflectivity factor Ze is in Li and Durden 2001 CLOUDSAT 2B CLDCLASS Index of the input file where th in the file attributes to see the of files Index of the coincident profile Height of range bin in Reflectivity Cloud Mask above reference surface mean sea level Algorithm outputs cloud type and different flags are combin into a 16 bit cloud_scenario OMI CLDO2 Effective cloud fraction clipped between 0 0 and 1 0 omi_cldo2_cloud_pressure Effective cloud pressure omi_no2_cloud_fraction omi_no2_cloud_pressure OMI NO2 Effective cloud fraction Effective cloud pressure calculated with the echo power and other input data as described coincidence has been found See Unit Type int16 125 unitless int8 125 dBZe int16 125 dBZe int16 125 e list unitless int16 unitless int16 int16 125 ed unitless int16 125 unitless float32 hPa int16 unitless int16 hPa int16 Ref 0605004 NT UDEV VO1 A5 ET CALXtract User Guide ROG Cate LAN Ed 1 Date 11 04 06 i Rev 6 Date 31 08 09 Software version 0 6 5 Page 29 Name Description Unit Type ou HO NO2 tropospheric column density molec cm 2_ float32 omi_no2_ColumnAmountN Precision of the NO2 tropospheric A O2TropStd column density BEER Toilas OMI CLDRR omi_cldrr_cloud_fraction Cloud Fraction for O3 omi_cldrr_cloud_pressure Cloud Pressure for 03
6. i INPUT DIR input_directory INPUT DIR Root of the CALIPSO data directory default DATA LIENS o OUTPUT_DIR output_directory OUTPUT DIR CALXTRACT output directory default home pascal calxtract data c CALXTRACT_CFG_FILE calxtract_cfg CALXTRACT_CFG_FILE Path to the calxtract configuration file It contains the calxtract fixed parameters K verbos Print out processing informations Ky overwrit Overwrite existing files k keep_pcf_file Keep the output PCF file at the end of the script s MAIN_SUBTRACK main_subtrack MAIN_SUBTRACK Sets the main subtrack product either caliop_05kmclay or caliop_11 In most cases the basic usage of this script is python lt path to install dir gt tools production_calxtract py t o lt output dirs root gt where lt path to install dir gt the directory where calxtract has been installed lt calipso orbit timestamp gt the timestamp of a CALIPSO half orbit start having the format lt YYYY MM DDTHH MM SS gt with YYYY MM and DD are respectively the year on 4 digits the month on 2 digits and HH MM SS are the hours minutes and seconds on 2 digits e lt output dirs root gt must be an existing directory where you are allowed to write The subdirectories lt YYYY gt lt YYYY_MM_ DD gt will be created to store the output files with YYYY MM and DD are respectively the year the month and the day of
7. CAL_LID_L1_ Relative Humi The relative humidity for each dity CAL_LID_L1_Land_Water_M ask CAL_LID_L1_Tropopause_H eight meteo level The Land Water Mask The height of the tropopause CAL_LID_L1_Tropopause T The temperature of the emperature P3L1_Input_Index tropopause PARASOL L1 Index i_row icol of the coincident Pixel in the input product See in the file attribut to know which is this file The Temperature for each meteo C Unit Type north 90 90 float32 east 180 180 float32 seconds float64 km 1 sr 1 float32 583 The perpendicular component of km 1 sr 1 float32 583 km 1 sr 1 float32 583 molecules m KE float32 33 float32 33 mb float32 33 M ecules float32133 float32 33 unitless int8 Km float32 C float32 unitless int16 2 e CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 16 Name Description Unit Type Number of available viewing eee directions Ndir in the following unitless uint8 2 1 lt id lt Ndir P3L1 Solar Azimuth Angle Solar Azimuth Angle uint8 Pixel Data Quality Index for each P3L1_Pixel_Quality_Index direction Also known as DOX unitless uint16 Solar Zenith Angle for each S P3L1_Solar_Zenith_Angle direction uint16 P3L1 View Zenith Angle 6 View Zenith Angle for filter uint16 16 70P2 670P2 for each direction P3L1 Rel
8. Eek s dl Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 10 Product lt product gt token syntax Misc CALIOP cloud 5km Will be filtered to the output in any case CALIOP L1 caliop_lid_11 CLOUDSAT Cloud geometrical profile cloudsat 2b geoprof CLOUDSAT Cloud Class cloudsat 2b cldclass IIR L2 track ir 12 MODIS L1B modis_myd021km MODIS cloud modis myd06_12 MYDO4 MODIS MYDO4 MYDO5 MODIS _MYDO5 PARASOL BR2 parasol_rb2 PARASOL OC2 PARASOL_OC2 PARASOL LS2 PARASOL _LS2 PARASOL L1 PARASOL L1 CERES CRS ceres OMI CLDO2 omi_cldo2 OMI NO2 omi_no2 OMI CLDRR omi_cldrr 4 2 2 Main subtrack Select the main subtrack and its variables Product lt product gt token syntax Misc CALIOP cloud 5km caliop 05kmclay CALIOP L1 caliop_lid_11 4 3 EXECUTION SCRIPT HIGH LEVEL USAGE The another way to run the application is to use a python script which is situed in the tools directory Usage production _calxtract py options Options h help show this help message and xit CALXtract User Guide e 2 Heger Eek s 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 11 t TIMESTAMP timestamp TIMESTAMP Timestamp of the master CAL_LID_L2 or CAL LID Li input file format YYYY MM DDTHH MM SS MANDATORY
9. Identification MYD06_Cloud_Multi_Layer_ From MODIS Shortwave int16 g Observations MYDO6 Cloud Fraction Cloud Fraction int8 MYD06_Cloud_Mask_5km Gees Cloud Mask at akm First int8 MODIS Cloud Mask at 1km L2 MYDO6 Cloud Mask km MOD06 QA Plan int8 MYDO6 Quality Assurance Quality Assurance at 5x5 int8 _5km Resolution MYDO6 Quality Assurance Quality Assurance at 1x1 int8 _1km Resolution CLOUDSAT 2B GEOPROF Index of the input file where the CS AB GEOPROF Input Fil coincidence has been found See e Index in the file attributes to see the list Ges RE of files EES Index of the coincident profile unitless int16 ofile Index CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 28 Name CS AB GEOPROF Height CS 2B_ GEOPROF CPR Clo ud mask CS ZB GEOPROF Gaseous _Attenuation CS_2B_GEOPROF Radar R eflectivity CS 2B CLDCLASS Input Fil e Index CG AR CLDCLASS Input Pr ofile Index CS 2B CLDCLASS Height CS 2B CLDCLASS cloud s cenario omi_cldo2 cloud fraction Description Height of range bin in Reflectivity Cloud Mask above reference surface mean sea level Each CPR resolution volume is assigned 1 bit mask value 0 No cloud detected 1 likely bad data 5 likely ground clutter 5 10 week detection found using along track integration 20 to 40 Cloud detected increasing values represents
10. NT UDEV VO1 RO6 lec 3 il Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 21 Name Description Unit Type CAL LID_L2_05KMCLAY Su rface_Elevation_Detection_ a EE REES unitless uint8 Frendi requency quency EAL D Le 0e RAS TAY Nu Number of Cloud Layers Found Layer int8 mber_Layers_Found CAL LID_L2_05KMCLAY La yer Top Altitude Cloud Layer Top Altitude Km float32 10 CAL UD L2 05KMCLAY La yer Base Altitude Cloud Layer Base Altitude Km float32 10 CAL_LID_L2_O5KMCLAY Fe Cloud Layer feature classification ature Classification Flags flags EE uint16 10 CAL UD L2 O5KMCLAY Fe Cloud Layer Optical Depth at ature Optical Depth 532 532nm RES Nee Cloud Layer Thermodynamic Phase as read in the feature classification flags Oe LE DRNEA EN O undefined unitless uint8 ase 1 ice 2 water 3 mixed CALIOP L2 O5kmALay CAL UD L2 05KMALAY_ Nu mber_Layers_ Found Number of Aerosol Layers Found Layer int8 CAL_LID_L2_ O5KMALAY La yer Top Altitude Aerosol Layer Top Altitude Km float32 8 CAL_LID_L2_ O5KMALAY La yer Base Altitude Aerosol Layer Base Altitude Km float32 8 CAL_LID_L2_O5KMALAY_ Fe Aerosol layer feature ature Classification Flags classification flags EE uint16 8 CAL UD L2 O5KMALAY La Se yer Top Temperature Aerosol Layer Top Temperature C float32 8 CAL UD L2 05KMALAY La F yer Base Temperature Aerosol Layer Base Temperature C float32 8 een ee Aerosol Layer Top Pressure hPa float32 8 yer Top Pressure CAL UD
11. Ref 0605004 NT UDEV V01 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 26 Name MYDO5_Input_Pixel_Index MYDO5 Water Vapor Near _Infrared MYDO5_Water_Vapor_Infra red MYDO5 Water Vapor Corr ection_Factors MYDO5 Quality Assurance _Infrared MYDO5 Quality Assurance Near Infrared MYDO5 Cloud Mask MYDO06_Input File Index MYDO06_Input_Pixel_Index MYDO6 Brightness Tempe rature Band 29 MYDO6 Brightness Tempe rature Band 31 MYDO6 Brightness Tempe rature_Band_32 MYDO6 Brightness Tempe rature_Band_33 MYDO6 Brightness Tempe rature Band 34 MYDO6 Brightness Tempe rature_Band_35 MYDO6 Brightness Tempe rature Band_36 MYDO6 Cloud Optical The kness Description Index i_row icol of the coincident Pixel in the input granule Total Column Precipitable Water Vapor Near Infrared Retrieval Total Column Precipitable Water Vapor Infrared Retrieval Aerosol Correction Factor for Water Vapor Near Infrared Retrieval Run time QA flags Run time QA flags MODIS Cloud Mask First Byte MODIS MYDO6_L2 Index of the input file where the coincidence has been found See in the file attributes to see the list of files Index i_row icol of the coincident Pixel in the input granule Brightness Temperature of Channel n 29 8 550um Brightness Temperature of Channel n 31 11 030um Brightness Temperature of Channel n 32 12 020um Brightness Temperatur
12. m um sr uint16 n 26 1 375um Earth View 1KM Emissive Bands POSA ET E R eee Scaled Integers of channel n 20 W m um sr uint16 ive_Band20 3 750um Earth View 1KM Emissive Bands OU TETE EV EEM EMSS Scaled Integers of channel n 21 W m um sr uint16 ive_Band21 3 959um Earth View 1KM Emissive Bands ee eee Ea Scaled Integers of channel n 22 W m um sr uint16 ive Band22 3 959um Earth View 1KM Emissive Bands a E E Scaled Integers of channel n 23 W m um sr uint16 4 050um Earth View 1KM Emissive Bands AEN tees Scaled Integers of channel n 24 W m um sr uint16 ive Band24 4 465um Earth View 1KM Emissive Bands ERR Scaled Integers of channel n 25 W m um sr uint16 ive Band25 4 515um Earth View 1KM Emissive Bands E Scaled Integers of channel n 27 W m 2 um sr uint16 ive Band27 6 715um Earth View 1KM Emissive Bands eee LAM es Scaled Integers of channel n 28 W m um sr uint16 ive Band28 7 325um Earth View 1KM Emissive Bands RE Scaled Integers of channel n 29 W m 2 um sr uint16 8 550um CALXtract User Guide Ref 0605004 NT UDEV VO1 ar Surface Elevation ta R06 leara Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 20 Name Description Unit Type _ Earth View 1KM Emissive Bands Epos LEM EV LEM Emig Scaled Integers of channel n 30 W m um sr uint16 ive_Band30 9 730um __ Earth View 1KM Emiss
13. omi_cldrr rad cloud Trach on Radiative Cloud Fraction unitless float32 hPa float32 unitless float32 The values used to represents absent or dummy ones also called Fill Values depend of the type of the variable Type Fill Value float32 inf float64 inf int8 128 uint8 255 CALXtract User Guide e 2 Heger Eek s 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 30 5 REFERENCES Title Versio Link n HDF 4 reference manual 4 2r1 http hdf ncsa uiuc edu doc html HDF 4 user guide 4 2r1 http hdf ncsa uiuc edu doc html CALIPSO DPC 3 0 http eosweb larc nasa gov PRODOCS calipso DP C MODIS file specifications http modis atmos gsfc nasa gov MOD06_L2 spec html CERES DPC R4V1 http earth www larc nasa gov ceresdoc DPC DPC_current D PC html PARASOL Level Data Format Manual 2 Product EdiRev and User 1 http www icare univ lille1 fr fr parasol php Cloudsat Data Products http www cloudsat cira colostate edu cloudsat_ Handbook documentation OMI Data description http disc sci gsfc nasa gov Aura data holdings website OMI
14. project that has been submitted to ICARE by Genevi ve S ze Fr d ric Parol Jacques Pelon e aE CALXtract User Guide Ref 0605004 NT UDEV V01 EEE RO6 Leate Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 6 3 INSTALLATION AND CONFIGURATION 3 1 PREREQUISITES APPLICATIONS Name Version Description gcc gt 3 2 3 Needed to build the application autoconf gt 2 5 Needed to configure the build automake gt 1 6 Needed to build the application python gt 2 4 1 OPTIONAL Needed to use the high level run script 3 2 PREREQUISITES LIBRARIES Libraries external to ICARE Name Version Description Lien HDF gt 4 2r1 Used to read and write hdf files http hdf ncsa uiuc ed u ICARE libraries Name Vers Description Lien ion hdfcpp 1 1 0 This library encapsulates the hdf one to offer a higher level access in C filedata 0 2 0 Contains modules that permit to read the data of different types of sensors 3 3 INSTALLATION 1 Download and extract the package using the command tar xzf calxtract_X_X tgz 2 Go in the extraction directory cd calxtract and use the usual tryptic 3 configure prefix lt the_directory_where_you_want_to _install_the_software gt REM If you do not give a prefix argument to the configure script by typing only configure the software will be insta
15. um sr uint16 n 11 0 541um Earth View 1KM Reflective Solar a E Bands Scaled Integers of channel W m um sr uint16 n 12 0 551um Earth View 1KM Reflective Solar cao Bands Scaled Integers of channel W m um sr uint16 n 13LO 0 667um Earth View 1KM Reflective Solar pe ee Bands Scaled Integers of channel W m2 um sr uint16 n 13HI 0 667um Earth View 1KM Reflective Solar ae RER Bands Scaled Integers of channel W m um sr uint16 n 14LO 0 678um Earth View 1KM Reflective Solar age CEERD Bands Scaled Integers of channel W m um sr uint16 n 14HI 0 678um Earth View 1KM Reflective Solar MARO LEM EY IEM parah Bands Scaled Integers of channel W m 2 um sr uint16 _Band15 n 15 0 748um CALXtract User Guide Ref 0605004 NT UDEV VO1 ive Band29 ee R06 leara Ed 1 Date 11 04 06 i i Rev 6 Date 31 08 09 Software version 0 6 5 Page 19 Name Description Unit Type Earth View 1KM Reflective Solar Dor ee Bands Scaled Integers of channel W m um sr uint16 n 16 1 3005um Earth View 1KM Reflective Solar MDO TRM EC IRMEReISS Bands Scaled Integers of channel W m um sr uint16 Band17 6 n 17 0 9051m Earth View 1KM Reflective Solar Gees eee Bands Scaled Integers of channel W m um sr uint16 n 18 0 936um Earth View 1KM Reflective Solar E a EE Bands Scaled Integers of channel W m um sr uint16 n 19 0 940um Earth View 1KM Reflective Solar paige SE Bands Scaled Integers of channel W
16. 005 2006242032723 hdf lt path gt MYD021KM A2006240 1330 005 2006242032225 hdf lt path gt MYD021KM A2006240 1335 005 2006242031317 hdf The CLOUDSAT files that have potential coincidences with the CAL_LID_L2_05kmCLay orbit CLOUDSAT_GEOPROF lt path gt 2006240121122 01779 CS_2B EOPROF_GRANULE_P_R0O3_E02 hdf G CLOUDSAT_CLDCLASS lt path gt 2006240121122_01779_CS_2B CLDCLASS_GRANULE_P_R03_E02 hdf The GMAO meteo files GMAO_mis_x lt path gt DAS 1llk asm tsyn2d_mis_x GEOS403 2006082800 2006082821 V01 GMAO_mis_p lt path gt DAS 1lk asm tsyn3d_mis_p GEOS403 2006082800 2006082818 V01 RAR RAA EEE SENSOR FILTERS d RARE EEE EEEE EHH Select the product to extract in addition to caliop O5mclay all others are filtered out SensorFilters lt product gt Select the main sub track ether caliop_05kmclay or caliop_lid_11 MainSubTrack lt main subtrack gt 4 2 1 Product Sensor Filters The extraction of data take in account only two products one of which is CALIOP cloud 5km A filter must be set in order to ignore all other files The syntax of this command is SensorFilters lt product gt The lt product gt token is one of the following Product lt product gt token syntax Misc CALIOP aerosol 5km caliop_O5kmalay CALXtract User Guide Ref 0605004 NT UDEV VO1 R06
17. 1 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 4 1 ABBREVIATIONS AND GLOSSARY CALIOP CALIPSO CALTRACK CALXTRACT Cvs DPC HDF IIR OMI PCF WFC Cloud Aerosol Lidar with Orthogonal Polarization Cloud Aerosol Lidar Infrared Pathfinder Satellite Observations The name of the products that constructs the calxtract application The application that produces the caltrack files Concurrent Versions System Data Product Catalog Hierarchical Data Format Imaging Infrared Radiometer Ozone Monitoring Instrument Process Control File It is an ascii file that contains all the parameters required for a run Wide Field Camera CALXtract User Guide mi Ref 0605004 NT UDEV V01 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 5 2 INTRODUCTION This document focused mainly on the usage of the calxtract application It also describes the content and the structure of the caltrack files but if your need is only to use those files you could prefer the document entitled caltrack product catalog that focuses more on the files produced by the calxtract software This application does the extraction of parameters issued of different sensors CALIOP IIR MODIS PARASOL CERES ECMWF analysis CLOUDSAT and more in the future under the CALIPSO s LIDAR subtrack or under the CALIOP level one subtrack This software is mainly the result of a
18. 40 A2006240 A2006240 A2006240 A2006240 1230 1233 1240 1245 Ie 1233 1300 1305 LL LES ISSUE Les LSB 1335 ous 2006245103716 200024511092 s2 000245105911 SE 2006245105605 2000245110250 2006245103408 2006245104705 2006245110133 2006245105636 s2 000243112225 2006245104432 2006245104758 005 005 005 005 005 005 005 005 005 005 005 005 005 The MODIS_MYD021KM files that have potential 2006245102737 hdf hdf hdf hdf hdf hdf hdf hdf hdf hdf hdf hdf hdf hdf coincidences with the CALXtract User Guide e 2 Heller Eek s 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 9 CAL_LID_L2_05kmCLay orbit MODIS_MYD021KM lt path gt MYD021KM A2006240 1230 005 2006242023728 hdf lt path gt MYD021KM A2006240 1235 005 2006242023628 hdf lt path gt MYD021KM A2006240 1240 005 2006242025311 hdf lt path gt MYD021KM A2006240 1245 005 2006242030306 hdf lt path gt MYD021KM A2006240 1250 005 2006242030010 hdf lt path gt MYD021KM A2006240 1255 005 2006242025504 hdf lt path gt MYD021KM A2006240 1300 005 2006242030023 hdf lt path gt MYD021KM A2006240 1305 005 2006242025804 hdf lt path gt MYD021KM A2006240 1310 005 2006242031142 hdf lt path gt MYD021KM A2006240 1315 005 2006242031511 hdf lt path gt MYD021KM A2006240 1320 005 2006242033440 hdf lt path gt MYD021KM A2006240 1325
19. L2 O5KMALAY La yer Base Pressure Aerosol Layer Base Pressure hPa float32 8 CAL_LID_L2_ O5KMALAY Fe Aerosol Layer Optical Depth at ature Optical Depth 532 532nm RSS eebe CALIPSO IIR L2 Track Ge Brightness Temperature at 12um K float32 mperature_12 05 Ref 0605004 NT UDEV VO1 e H CALXtract User Guide ROG L Cate Ed 1 Date 11 04 06 E Rev 6 Date 31 08 09 Software version 0 6 5 Page 22 Name Description Unit Type CAL_IIR_L2_ Brightness Te Brightness Temperature at K float32 mperature_10 60 10 6um CAL IR L Brightness Te Brightness Temperature at K float32 mperature 08 65 8 65um CAL_IIR_L2_Effective_Parti Size of the Particles at 5km um float32 cle Size Resolution CAL IIR_L2_Particle_shape Particle Shape Index unitless int8 CAL IIR_L2_Ice_ Water Path Ice Water Path float32 PARASOL OC2 Index i_row icol of the coincident Pixel in the input l P3L2TOGC_Input_Index product See in the file attribute unitless int16 2 to know which is this file Pi Ne Pixel confidence data indicator unitless uint32 R l l Quality of the fit IQ 1 P3L2TOGC Fit_Quality DLmoy 2E 3 gt 0 unitless uint8 RC Solar Zenith Angle uint16 ee pie Optical Thickness at unitiess uint16 E GE Optical Thickness at initi s uint16 Deal io A Aerosol Angstrom Coefficient unitless uint16 P3L2TOGC Single Scatteri Single Scattering Albedo at ng Albedo 865 865nm ER uinte P3L2TOGC_Aerosol_Scatte Aerosol Scattering Asymmetry initl ss
20. SOL LS2 Index i_row icol of the coincident Pixel in the input P3L2TLGC_Input_Index product See in the file attribute unitless int16 2 to know which is this file P3L2TLGC Land Water Ind Land 100 Water 0 or Mixed icator 50 Indicator EES HME No Pixel confidence data indicator unitless uint32 eier SE Optical Thickness at GEES uint16 P3L2TLGC Aerosol Model Aerosol Model Refractive Index Refractive_Index Real Part umes DIRES P3L2TLGC Aerosol Model Aerosol Model Angstr m Angstrom_Coefficient Coefficient UnIEESS a P3L2TLGC Aerosol Index Aerosol Index unitless uint16 Mr eue EE Optical Thickness at unitiess uint16 P3L2TLGC Quality_Index_V Quality Index for Viewing iewing Geometry Geometry 0 bad l excellent ARMES ER Quality Index for Polarized ee Us Maex Reflectance Fit O bad unitless uint8 olarized_Reflectance_Fit l excellent Ref 0605004 NT UDEV VO1 i CALXtract User Guide ROG Cate LAN Ed 1 Date 11 04 06 i Rev 6 Date 31 08 09 Software version 0 6 5 Page 24 Name Description Unit Type PARASOL RB2 Index i_row icol of the coincident Pixel in the input P3L2TRGB_Input_Index product See in the file attribute unitless int16 2 to know which is this file cloud cover defined as the P3L2TRGB_Cloud_ Cover number of cloudy pixels divided unitless uint8 by the total number of pixels Po TROP Direcuonal ele Directional Apparent Cloud Cover unitless uint8 ud_Cover mean cloud oxy
21. Software version 0 6 5 Page 13 Capteur Produit Type de Centre R solution Fr quence ty fichier distribu lat lon ou le pe teur long de la trace CLOUDSAT Cloud 2B CIRA 1 1km 1 per orbit o geometrical GEOPROF profile Cloud Class 2B CIRA 1 1km 1 per orbit o CLDCLASS Liquid Water 2B LWC RO CIRA 1 1km 1 per orbit u Content RADAR Liquid Water 2B LWC CIRA 1 1km 1 per orbit u Content RADAR LIDAR Ice Water 2B IWC RO CIRA 1 1km 1 per orbit u Content method RADAR Ice Water 2B IWC CIRA 1 1km 1 per orbit u Content RADAR LIDAR Optical 2B TAU CIRA 1 1km 1 per orbit u Thickness OMI CLDO2 OMI GSFC Nadir pixels 1 per orbit o Aura_L2 GES 13x24 km OMCLDO2 DISC NO2 OMI GSFC Nadir pixels 1 per orbit o Aura_L2 GES 13x24 km OMNO2 DISC CLDRR OMI GSFC Nadir pixels 1 per orbit o Aura_L2 GES 13x24 km OMCLDRR DISC CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 14 4 5 OUTPUT PRODUCT DESCRIPTION 4 5 1 File format The output products will be in a HDF4 format where each sds will contain the values of an physical variable along the CALIPSO subtrack The output files will have a name that has been defined in the configuration file For more details on the HDF4 format link to the official page reading tools and more you may refer to the ICARE hdf description page http ww
22. ative Azimuth An Relative Azimuth Angle for filter uint16 16 gle 670P2 670P2 for each direction Relative variation of viewing geometry between the filters for each direction See the appendix P3L1 Delta Thetav Cosphi C of the PARASOL Level 1 Product int8 16 Data Format and User Manual for details Relative variation of viewing geometry between the filters for each direction See the appendix l P3L1_Delta_Thetav_Sinphi C of the PARASOL Level 1 Product int8 16 Data Format and User Manual for details P3L1_Normalized_Radianc Normalized Radiance for Channel e_443NP 443NP for each direction unites int telte P3L1_Normalized_Radianc Normalized Radiance for Channel e 490P 490P for each direction DEES RES P3L1 Normalized Radianc Normalized Radiance for Channel e 1020NP 1020NP for each direction unitess idee P3L1 Normalized Radianc Normalized Radiance for Channel e 565NP 565NP for each direction GE IER P3L1 Normalized Radianc Normalized Radiance for Channel e 670P 670P for each direction SE ECRKR P3L1 Normalized Radianc Normalized Radiance for Channel e 763NP 763NP for each direction unites dee bes P3L1 Normalized Radianc Normalized Radiance for Channel e 765NP 765NP for each direction UNIKIESS meLeLLG P3L1_Normalized_Radianc Normalized Radiance for Channel e e 865P 865P for each direction DEE ERR P3L1 Normalized Radianc Normalized Radiance for Channel ini l es int16 16 e 910NP 910NP for each direction
23. e of Channel n 33 13 3351m Brightness Temperature of Channel n 34 13 6351m Brightness Temperature of Channel n 35 13 935um Brightness Temperature of Channel n 36 14 2351m Cloud Optical Thickness two channel retrieval using band 7 and either band 1 2 or 5 Unit Type unitless int16 cm int16 cm int16 unitless int16 unitless int8 5 unitless int8 unitless int8 unitless int16 2 unitless int16 K int16 K int16 K int16 K int16 K int16 K int16 K int16 unitless int16 CALXtract User Guide Ref 0605004 NT UDEV VO1 LAF ROG l CANS Ed 1 Date 11 04 06 i Rev 6 Date 31 08 09 Software version 0 6 5 Page 27 Name Description Unit Type Column Water Path two band MYDO6 Cloud Water Path retrieval using band 7 and either g m int16 band 1 2 or 5 So eee earner Cloud Top Pressure hPa int16 Number of Clear Pixels of 1km SE nen at 5km resolution Read in the nb_pixels int8 Cloud_Mask_1km dataset Number of Cloudy Pixels of 1km EE at 5km resolution Read in the nb_pixels int8 Cloud_Mask_1km dataset Number of Indetermined Pixels ey ee of 1km at 5km resolution Read nb_pixels int8 in the Cloud_Mask_1km dataset Cloud Particle Effective Radius two channel retrieval using band oo eee 7 and either band 1 2 or 5 um int8 specified in Quality_Assurance_1km _ Cloud Phase Determination Used Beier EE in Optical Thickness Effective int16 TOP Radius Retrieval e Cloud Multi Layer
24. gen pressure SC E expected to be close of the cloud hPa uint8 middle pressure P3L2TRGB_Cloud_Oxygen_ Angular Standard Deviation of the hPa uints Pressure Angular Stddev Cloud Oxygen Pressure mean cloud Rayleigh pressure e EE expected to be close of the cloud hPa uint8 top pressure P3L2TRGB Cloud Rayleigh Angular Standard Deviation of the hPa int _Pressure Angular Stddev Cloud Rayleigh Pressure linear mean cloud optical EE EE thickness 670 nm over land and unitless uint16 865 nm over ocean Relative Spatial Standard a er a Deviation of Cloud Optical uint8 Thickness P3L2TRGB Cloud Phase Cloud Phase unitless uint8 P3L2TRGB_Water_Vapor_C Water Vapor Column based on e e g cm uint8 olumn clear pixel measurements Mean albedo at 670 nm over land P3L2TRGB Mean Albedo and 865 nm over ocean aka avis unitless uint16 Relative spatial standard P3L2TRGB Albedo Spatial_ deviation of the albedos based o uint8 Stddev on the direction means aka i rsd_avis Relative angular standard P3L2TRGB Albedo Angular deviation of the albedos based uint _Stddev on the spatial means aka rad_avis Ref 0605004 NT UDEV VO1 i CALXtract User Guide ROG Cate LAN Ed 1 Date 11 04 06 i Rev 6 Date 31 08 09 Software version 0 6 5 Page 25 Name Description Unit Type Surface type indicator aka tmc 0 100 water P3L2TRGB Surface Type 10 gt 90 water uint8 ndex 50 mixed 90 gt
25. ile must use the HDF compression or not UseHDFCompression 0 Print out process information Verbose 1 Overwrite the existing files Overwrite 1 The radix that will start the output file name OutputFileRadix calxtract_ Name of the log file LogName calxtract log Set the acceptable colocation frame between a CALIOP shot and a sensor measurement if the distance between the position of a sensor s measurement and the position of a CALIOP shot is less than the ColocationTolerance set those 2 measurements are considered as colocated The ColocationTolerance value is in in a plane approximation CALXtract User Guide Ref 0605004 NT UDEV V01 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 8 d d T MAN CAL T 522 T one T T IIRColocationTolerance 0 005 MODISColocationTolerance 0 005 PARASOLColocationTolerance 0 05 CLOUDSATColocationTolerance 0 01 CERESColocationTolerance 0 1 FE FE HE HE E FE HE AE FE HE FE AE FE HE AE FE HE FE AE FE HE FE HEHE H OUTPUTS FE HE HE HE FE HE HE AE FE FE HEHE AE FE HE FE AE FE HE FE HEHE H HEH CAL_ CAL CAL CAL The MODIS MYDO6 CAL_LID_L2_05kmCLay orbit MODIS_MYDO6 lt path gt MY INPUTS DATORY LID_L2_05kmCLay Beaks kag he input CAL_LID_L1 file lt path gt M lt path gt M lt path gt M lt path gt M lt path g
26. ive Bands MDO LTM aes Scaled Integers of channel n 31 W m um sr uint16 ive_Band31 11 030um _ Earth View 1KM Emissive Bands RER Scaled Integers of channel n 32 W m 2 um sr uint16 12 020um __ Earth View 1KM Emissive Bands MAPOZI EV_IKM_Emiss Scaled Integers of channel n 33 W m um sr uint16 13 335um _ Earth View 1KM Emissive Bands eee Scaled Integers of channel n 34 W m um sr uint16 13 635um _ Earth View 1KM Emissive Bands E E Ce Scaled Integers of channel n 35 W m 2 um sr uint16 13 9351m _ Earth View 1KM Emissive Bands RER Scaled Integers of channel n 36 W m 2 um sr uint16 14 2351m CLOUDSAT 1B CPR Index of the input file where the CS_1B_CPR Input File Ind coincidence has been found See ex in the file attributes to see the list EES WE of files CS_1B_CPR_Input_Profile_ Index of the coincident profile unitless int16 CS_1B_CPR_Range_to_inte Range to the CPR boresight Km float32 rcept intercept with the geoid Range to first bin is the distance CS_1B_CPR_Range_to_first between the satellite and the float32 _bin starting bin number of the ray in meters Echo Power is the calibrated D one range gate power in watts made W float32 125 in flight and averaged CALIOP L2 05kmCLay CAL_LID_L2_O5KMCLAY_DE Surface Elevation read from the Km float32 M_Surface_Elevation Digital Elevation Model DEM CALD LA DARME AY Lg Lidar Echo Ground Elevation Km float32 CALXtract User Guide Ref 0605004
27. lled in the default install directory on your system usr bin or usr local bin and will be accessible to all users on your system but you will need the root access to execute the make install command 4 make 5 make install CALXtract User Guide e 2 Heger Eek s 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 7 4 USAGE The basic principle of calxtract is to take as only argument a Process Control File PCF that contains all the parameters needed for the run like the input files But the drawback is that the user is responsible of the determination of the input files that contain some potential coincidences So to make the usage of calxtract easier a high level script in python that encapsulates the build of the PCF file and the call to the executable has been developed This method is the easy to use one and should be better for users external to the Icare Team 4 1 COMMAND LINE LOW LEVEL USAGE usage lt path to the install directory gt bin calxtract lt pcf_file gt 4 2 PCF FILE CONTENT The file given as a command line argument is an ascii file that contains the following parameters lt path gt must be replaced by a directory path lt product gt designs the product to output in addition to CALIOP cloud 5km AAA AE AAA AMAR RER EEEH Se HE te HE CONFIGURATION FILE CALXTRACT Wether the output f
28. s not contain all the products as before The new version generates scientific data files issued from only two different products One of which is caliop 05kmclay The second one is configured in the pcf configuration 14 01 08 CALIOP Cloud is not the only possible sub track It is possible to have a CALIOP level 1 sub track 27 06 08 Insert new variables names 31 08 09 Insert new variables names to reflect software updates CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 3 TABLE OF CONTENTS LABBREVIATIONS AND GLOSSARY ns den msn Rent 4 2 INE RODUG TON EEN 5 3 INSTALLATION AND CONFIGURATION scsisissccvusveveuscpinntiacnde ENNERT 6 3 1 Prerequisites applicatioN EE 6 3 2 Pr r quisit s TEE 6 E le Een E 6 4 USAG eene Ee eegen 7 4 1 Command line low level WEepet essgksuekages rde Ee Ae Eege gea dE et eabs eur 7 4 2 POS ON EE 7 4 2 1 Product Sensor FillerSiccscccccccccccscacetessesecaccesscncsedacascsestancanacndaenvascsacesuecsedteancesenes 9 E EE Bet nn sen dei tenue ee eee 10 4 3 Execution script high level usage 11 PE PENNE TVS E 12 4 5 0utput Product desc PU ON eege Een 14 A SLPS formateras rene ennemies diese ten eine 14 GET 15 S REFERENGES egene donnee ant EE EE 26 CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 1
29. t M lt path gt M lt path gt M lt path gt M lt path gt M lt path gt M lt path gt M lt path gt M lt path gt MY KKK HG HG HG KK KK he input CAL_IIR_L2_Trac The output file directory OutputDirectory lt path gt d EHH HEE HEHE HEHE EEE HEH HE HH ne input CAL_LID_L2_05kmCLay ne input CAL_LID_L2_05kmALay one LID_L2_05kmALay lt path gt CAL_LID_L2_05kmALay Prov V1 10 2006 08 28T12 38 file s that DOE LZ D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 D06_L2 DOG L D06_L2 k file The log file output directory LogDirectory lt path gt HEHE HEE HEHE HEHEHE HEH HH file file Same half orbit than t LID_L1 lt path gt CAL_LID_L1 Prov V1 10 2006 08 28T12 38 522D hdf Same This file is the Same half half orbit IIR_L2_Track lt path gt CAL_IIR_L2_Track Prov V1 0 master one and is _ LID_L2_O05kmCLay lt path gt CAL_LID_L2_05kmCLay Prov V1 10 2006 08 28T12 38 522D hdr orbit than the 1 2006 08 than the CAL_LID_L2_05kmCLay he input PARASOL_RB2 file that has potential coi CAL_LID_L2_05kmCLay orbit PARASOL_RB2 lt path gt P3L2TRGB040110JL ncidences 28T12 38 522D hd he CAL_LID_L2_05kmCLay one with the have potential coincidences with the A2006240 A2006240 A2006240 A2006240 A2006240 A2006240 A2006240 A2006240 A2006240 A20062
30. the input CALIPSO half orbit 4 4 INPUT FILES kind o stands for optional m stand for mandatory and u stands for unused CALXtract User Guide Ref 0605004 NT UDEV V01 CL ROG AACE Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 12 Capteur Produit Type de Centre R solution Fr quence ty fichier distribu lat lon ou le pe teur long de la trace CALIOP L1 CAL LID_L1 LARC 333m 2 par orbite m 1 jour 1 nuit cloud 5km CAL LID_L2 LARC 5km 2 par orbite m _05kmCLay 1 jour 1 nuit aerosol 5km CAL_LID_L2 LARC 5km 2 par orbite o _05kmALay 1 jour 1 nuit IIR L2 track CAL_IIR_L2_ LARC 1km 1km 2 par orbite o Track 1 jour 1 nuit MODIS L1B MYDO21KM DAAC 21km 21km 1 par 5 min cloud MYDO6 L2 DAAC 5km 5km 1 par 5 min MYDO4 MODIS MYD DAAC 1 par 5 min 04 MYDO5 MODIS_MYD DAAC lpar5min o 05 PARASOL cloud BR2 PARASOL _R ICARE 20km 20km 1 per orbit o B2 1 jour OC2 PARASOL_O ICARE 20km 20km 1 per orbit o C2 1 jour LS2 PARASOL L ICARE 20km 20km 1 per orbit o S2 1 jour L1 PARASOL L ICARE 3km 3km 1 per orbit o 1 1 jour CERES CRS CER_CRS_A LARC 1 par heure u qua FM4 MODIS ECMWF analysis ECMWF 1km 1 25km 1 par jour u Et CALXtract User Guide EE Lcare Ed 1 Date 11 04 06 Rev 6 Date 31 08 09
31. uint8 ring_Asymmetry_Factor Factor P3L2TOGC Aerosol Index Aerosol Index unitless uint16 E TO ATORO lec Aerosol Effective Radius um uint8 ve_Radius F EATOSE Fine Mode Eme Fine Mode Effective Radius um uint8 ctive_Radius P3L2TOGC_Large_Mode_Ef fective Radius Large Mode Effective Radius um uint8 e eee T Optical Thickness at nities uint16 P3L2TOGC Fine Mode OD Fine Mode Optical Thickness at nitj ss uint16 _670 670nm CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 23 Description Unit Type Ro EE Fine Mode Angstr m Exponent unitless uint16 P3L2TOGC Spherical_Coar Optical Thickness of Spherical se Mode OD 865 Coarse Mode at 865nm SE ele P3L2TOGC Non Spherical_ Optical Thickness of Non Coarse_Mode_OD_865 Spherical Coarse Mode at 865nm ARLES SNE P3L2TOGC Relative Contri Relative Contribution of Non b_ Non Spherical_ Part Coar Spherical Particles in Coarse unitless uint8 se Mode Mode Refractive Index of Fine Mode a only for Fine Mode Optical unitless uint8 Thickness at 865nm gt 0 02 Refractive Index of Coarse Mode Nig rata a aa only for Spherical Coarse Mode at unitless uint8 865nm gt 0 02 P3L2TOGC_Log_Backscatte Logarithm of the Backscattering ring_Coefficient_565 Coefficient at 565nm ERR RES P3L2TOGC Log Backscatte Logarithm of the Backscattering ring_Coefficient_1020 Coefficient at 1020nm GE Ge PARA
32. w icare univ lillel fr howto_hdf The output file will be organised like this SDS list 4224 Latitude 2 4224 Longitude 3 4224 Time 4 4224 S_hgt 5 4224 1 Echo bot 6 4224 1 Nb_Cld_Layer_5km 7 4224 x 10 Hot _Cld_Top_5km 8 4224 x 10 Hgt_Cld_Base_Skm 9 4224 x 10 OptTh_Cld_5km 10 4224 x 10 1 Phase_5km x 11 4224 1 Nb_Cld_Layer_20km 12 4224 10 Hgt_Cld_Top_20km CALXtract User Guide Ref 0605004 NT UDEV VO1 RO6 Ed 1 Date 11 04 06 Rev 6 Date 31 08 09 Software version 0 6 5 Page 15 4 5 2 Variables Here is an exhaustive list of the variables extracted variables are present it depends on the products filtered Name Latitude Longitude Time CAL UD L1 Total _Attenuat The Total Attenuated Backscatter ed Backscatter 532 CAL UD LL Perpendicular Description from the input files Not all Common to all caltrack unit products Latitude Longitude Time using the TAI 93 convention CALIOP L1 signal at 532nm _Attenuated_Backscatter_ the attenuated backscatter at 532 532nm CAL_LID_L1_Attenuated_B The Attenuated Backscatter ackscatter_1064 CAL_LID_L1_Molecular_Nu mber_Density CAL_LID_L1_Temperature CAL_LID_L1_Pressure CAL_LID_L1_ Ozone Numbe r_ Density signal at 1064nm The Molecular Number Density level The Pressure for each meteo level The Ozone Number Density

CALXtract User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents