Directory Listing of Routines

projects/kaguya/map/pace

KGY_ESA1_GET3D
returns an ESA-S1 3D data structure
KGY_ESA2_GET3D
returns an ESA-S2 3D data structure
KGY_IEA_GET3D
returns an IEA 3D data structure
KGY_IMA_GET3D
returns an IMA 3D data structure
KGY_PACE_16X64TO4X16
rebin a data structure w/ 16x64 angles into 4x16 angles
KGY_PACE_COM
stores the PACE static memory
KGY_PACE_CONVERT_FRAME
Converts frame of 3d data using SPICE
KGY_PACE_CONVERT_UNITS
converts the units for a PACE 3d data structure
KGY_PACE_PARASPEC
generates energy spectra for 6 pitch angle ranges:
KGY_PACE_PLOT3D_SNAP
Plots 3D snapshots for times selected with the cursor in a tplot window.
KGY_READ_FOV
reads in Kaguya MAP/PACE FOV files
KGY_READ_INF
reads in Kaguya MAP/PACE information files
KGY_READ_PBF
reads in Kaguya MAP/PACE PBF format files

Routine Descriptions

KGY_ESA1_GET3D

 FUNCTION:
       kgy_esa1_get3d
 PURPOSE:
       returns an ESA-S1 3D data structure
 CALLING SEQUENCE:
       dat = kgy_esa1_get3d(time)
 OPTIONAL INPUTS:
       time: gets data at this time - otherwise uses index or clicks
             Can be in any format accepted by time_double.
 KEYWORDS:
       index: gets data at this index value in the common block
       cntcorr: conducts count correction (event & trash correction)
       sabin: sorts into solid angle bins instead of (Npol,Naz)
                compatible with the SSL infrastructure (Def: sabin=1)
       INFOangle: uses angles in the INFO files (Def: INFOangle = 1)
 CREATED BY:
       Yuki Harada on 2014-07-01

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-17 14:37:45 -0700 (Sat, 17 Sep 2016) $
 $LastChangedRevision: 21850 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_esa1_get3d.pro $

(See projects/kaguya/map/pace/kgy_esa1_get3d.pro)

KGY_ESA2_GET3D

[Previous Routine] [Next Routine] [List of Routines]

 FUNCTION:
       kgy_esa2_get3d
 PURPOSE:
       returns an ESA-S2 3D data structure
 CALLING SEQUENCE:
       dat = kgy_esa2_get3d(time)
 OPTIONAL INPUTS:
       time: gets data at this time - otherwise uses index or clicks
             Can be in any format accepted by time_double.
 KEYWORDS:
       index: gets data at this index value in the common block
       cntcorr: conducts count correction (event & trash correction)
       sabin: sorts into solid angle bins instead of (Npol,Naz)
                compatible with the SSL infrastructure (Def: sabin=1)
       INFOangle: uses angles in the INFO files (Def: INFOangle = 1) 
 CREATED BY:
       Yuki Harada on 2014-07-01

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-17 14:37:45 -0700 (Sat, 17 Sep 2016) $
 $LastChangedRevision: 21850 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_esa2_get3d.pro $

(See projects/kaguya/map/pace/kgy_esa2_get3d.pro)

KGY_IEA_GET3D

[Previous Routine] [Next Routine] [List of Routines]

 FUNCTION:
       kgy_iea_get3d
 PURPOSE:
       returns an IEA 3D data structure
 CALLING SEQUENCE:
       dat = kgy_iea_get3d(time)
 OPTIONAL INPUTS:
       time: gets data at this time - otherwise uses index or clicks
             Can be in any format accepted by time_double.
 KEYWORDS:
       index: gets data at this index value in the common block
       cntcorr: conducts count correction (event & trash correction)
       sabin: sorts into solid angle bins instead of (Npol,Naz)
                compatible with the SSL infrastructure (Def: sabin=1)
       INFOangle: uses angles in the INFO files (Def: INFOangle = 1)
 CREATED BY:
       Yuki Harada on 2014-07-02

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-17 14:37:45 -0700 (Sat, 17 Sep 2016) $
 $LastChangedRevision: 21850 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_iea_get3d.pro $

(See projects/kaguya/map/pace/kgy_iea_get3d.pro)

KGY_IMA_GET3D

[Previous Routine] [Next Routine] [List of Routines]

 FUNCTION:
       kgy_ima_get3d
 PURPOSE:
       returns an IMA 3D data structure
       sums up all mass channels and assumes protons
       Use kgy_ima_get4d (to be developed) to get mass separated data
 CALLING SEQUENCE:
       dat = kgy_ima_get3d(time)
 OPTIONAL INPUTS:
       time: gets data at this time - otherwise uses index or clicks
             Can be in any format accepted by time_double.
 KEYWORDS:
       index: gets data at this index value in the common block
       cntcorr: conducts count correction (event & trash correction)
       sabin: sorts into solid angle bins instead of (Npol,Naz)
                compatible with the SSL infrastructure (Def: sabin=1)
       INFOangle: uses angles in the INFO files (Def: INFOangle = 1)
 CREATED BY:
       Yuki Harada on 2014-07-02

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-17 14:37:45 -0700 (Sat, 17 Sep 2016) $
 $LastChangedRevision: 21850 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_ima_get3d.pro $

(See projects/kaguya/map/pace/kgy_ima_get3d.pro)

KGY_PACE_16X64TO4X16

[Previous Routine] [Next Routine] [List of Routines]

 FUNCTION:
       kgy_pace_16x64to4x16
 PURPOSE:
       rebin a data structure w/ 16x64 angles into 4x16 angles
 CALLING SEQUENCE:
       d2 = kgy_pace_16x64to4x16(dat)
 INPUTS:
       3d data structure generated by kgy_*_get3d
 KEYWORDS:
       
 CREATED BY:
       Yuki Harada on 2016-10-26

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-10-26 10:34:33 -0700 (Wed, 26 Oct 2016) $
 $LastChangedRevision: 22200 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_pace_16x64to4x16.pro $

(See projects/kaguya/map/pace/kgy_pace_16x64to4x16.pro)

KGY_PACE_COM

[Previous Routine] [Next Routine] [List of Routines]

 COMMON BLOCK:
       kgy_pace_com
 PURPOSE:
       stores the PACE static memory
       *_info_str: information structures which contain energies,
                   angles, g-factors, etc.
       *_header_arr: header structure arrays which contain time,
                     sensor, mode and other information
       *_type??_arr: data structure arrays which typically contain
                     'event', 'cnt', and 'trash' tags
 CREATED BY:
       Yuki Harada on 2014-06-30

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-09 11:33:47 -0700 (Fri, 09 Sep 2016) $
 $LastChangedRevision: 21810 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_pace_com.pro $

(See projects/kaguya/map/pace/kgy_pace_com.pro)

KGY_PACE_CONVERT_FRAME

[Previous Routine] [Next Routine] [List of Routines]

 FUNCTION:
       kgy_pace_convert_frame
 PURPOSE:
       Converts frame of 3d data using SPICE
       Available frames: SELENE_M_SPACECRAFT, MOON_ME, SSE, GSE
       'phi' and 'theta' tags will be converted
       'dphi' and 'dtheta' tags will NOT be converted
 CALLING SEQUENCE:
       dnew = kgy_pace_convert_frame(d,newframe='MOON_ME')
 INPUTS:
       3d data structure created by kgy_*_get3d
 KEYWORDS:
       oldframe: old frame (Def. frame defined in the input data)
       newframe: new frame (Def. 'SSE')
       vnew: returns new velocity vectors = {vx:vxnew,vy:vynew,vz:vznew}
 CREATED BY:
       Yuki Harada on 2016-09-17

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-17 14:37:45 -0700 (Sat, 17 Sep 2016) $
 $LastChangedRevision: 21850 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_pace_convert_frame.pro $

(See projects/kaguya/map/pace/kgy_pace_convert_frame.pro)

KGY_PACE_CONVERT_UNITS

[Previous Routine] [Next Routine] [List of Routines]

 PROCEDURE:
       kgy_pace_convert_units
 PURPOSE:
       converts the units for a PACE 3d data structure
 CALLING SEQUENCE:
       kgy_pace_convert_units, dat, units
 INPUTS:
       dat: 3d data structure for ESA-S1/ESA-S2/IMA/IEA
       units: units to convet the structure to
 KEYWORDS:
       scale: returns an array of conversion factors used
       nan2zero: if set, NaN and infinite in data -> 0 and bins = 0
 NOTES:
       This procedure does NOT include deadtime corrections.
       Use /cntcorr keyword in kgy_*_get3d function to correct counts.
 CREATED BY:
       Yuki Harada on 2014-06-30

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-09 11:33:47 -0700 (Fri, 09 Sep 2016) $
 $LastChangedRevision: 21810 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_pace_convert_units.pro $

(See projects/kaguya/map/pace/kgy_pace_convert_units.pro)

KGY_PACE_PARASPEC

[Previous Routine] [Next Routine] [List of Routines]

 PROCEDURE:
       kgy_pace_paraspec
 PURPOSE:
       generates energy spectra for 6 pitch angle ranges:
       parapara  paramid  paraperp  antiperp  antimid  antipara
       0-30      30-60    60-90     90-120    120-150  150-180
 CALLING SEQUENCE:
       kgy_pace_paraspec, sensor=0
 KEYWORDS:
       trange: time range
       sensor: 0: ESA-S1, 1: ESA-S2, 2: IMA, 3: IEA (Def. [0,1])
       units: (Def: 'eflux')
 CREATED BY:
       Yuki Harada on 2016-10-26

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-10-26 10:34:33 -0700 (Wed, 26 Oct 2016) $
 $LastChangedRevision: 22200 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_pace_paraspec.pro $

(See projects/kaguya/map/pace/kgy_pace_paraspec.pro)

KGY_PACE_PLOT3D_SNAP

[Previous Routine] [Next Routine] [List of Routines]

 PROCEDURE:
       kgy_pace_plot3d_snap
 PURPOSE:
       Plots 3D snapshots for times selected with the cursor in a tplot window.
       Hold down the left mouse button and slide for a movie effect.
 CALLING SEQUENCE:
       plot3d_options,map='cylindrical'
       kgy_pace_plot3d_snap,/log,units='counts',zrange=[1,100]
 KEYWORDS:
       frame: 'MOON_ME', 'SSE', 'GSE', or 'SELENE_M_SPACECRAFT'
              (Def. 'SELENE_M_SPACECRAFT')
       window: window number (Def. a new window will be generated)
       sensor: sensor number (Def. selected according to the clicked tplot)
               0: ESA-S1, 1: ESA-S2, 2: IMA, 3: IEA
       keepwin: do not delete the snap window
       other keyword will be passed to plot3d_new
 CREATED BY:
       Yuki Harada on 2016-09-17

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-17 15:54:11 -0700 (Sat, 17 Sep 2016) $
 $LastChangedRevision: 21852 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_pace_plot3d_snap.pro $

(See projects/kaguya/map/pace/kgy_pace_plot3d_snap.pro)

KGY_READ_FOV

[Previous Routine] [Next Routine] [List of Routines]

 PROCEDURE:
     kgy_read_fov
 PURPOSE:
     reads in Kaguya MAP/PACE FOV files
     and stores data in a common block (kgy_pace_com)
 CALLING SEQUENCE:
     kgy_raed_fov, files
 INPUTS:
     files: full paths to the FOV files (gziped or decompressed)
            e.g., ['dir/esas1-ch_angle', $
                   'dir/esas1-pol_angle-RAM0', ...]
 KEYWORDS:
     load: if set, download and read in publicly available files
           (override any inputs) 
 CREATED BY:
     Yuki Harada on 2014-07-01

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-09 11:33:47 -0700 (Fri, 09 Sep 2016) $
 $LastChangedRevision: 21810 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_read_fov.pro $

(See projects/kaguya/map/pace/kgy_read_fov.pro)

KGY_READ_INF

[Previous Routine] [Next Routine] [List of Routines]

 PROCEDURE:
     kgy_read_inf
 PURPOSE:
     reads in Kaguya MAP/PACE information files
     and stores data in a common block (kgy_pace_com)
 CALLING SEQUENCE:
     kgy_raed_inf, files
 INPUTS:
     files: full paths to the info files (gziped or decompressed)
            e.g., ['dir/IEA_ENE_POL_AZ_GFACTOR_16X64_20080225.dat', $
                   'dir/IEA_ENE_POL_AZ_GFACTOR_4X16_20080226.dat', ...]
 KEYWORDS:
     load: if set, download and read in publicly available files
           (override any inputs)
 CREATED BY:
     Yuki Harada on 2014-06-29

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-09 11:33:47 -0700 (Fri, 09 Sep 2016) $
 $LastChangedRevision: 21810 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_read_inf.pro $

(See projects/kaguya/map/pace/kgy_read_inf.pro)

KGY_READ_PBF

[Previous Routine] [List of Routines]

 PROCEDURE:
     kgy_read_pbf
 PURPOSE:
     reads in Kaguya MAP/PACE PBF format files
     and stores data in a common block (kgy_pace_com)
 CALLING SEQUENCE:
     kgy_load_pbf, files, trange=trange
 INPUTS:
     files: full paths to the data files (gziped or decompressed)
            e.g., [ 'dir/PBF1_C_20080101_ESA1_V001_I.DAT.gz', $
                    'dir/PBF1_C_20080101_IEA_V001_I.DAT' ]
 KEYWORDS:
     trange: 2-element array specifying time range (optional, Def. 1day), 
             e.g., ['yyyy-mm-dd/hh:mm:ss','yyyy-mm-dd/hh:mm:ss']
             Can be in any format accepted by time_double.
 NOTES:
     65535 = uint(-1) and 4294967295 = ulong(-1) mean NaN.
 CREATED BY:
     Yuki Harada on 2014-06-30
     Modified from 'read_pbf_v2.c' and 'paceql_outputdata_090805.h'

 $LastChangedBy: haraday $
 $LastChangedDate: 2016-09-09 11:33:47 -0700 (Fri, 09 Sep 2016) $
 $LastChangedRevision: 21810 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/tags/spedas_3_00/projects/kaguya/map/pace/kgy_read_pbf.pro $

(See projects/kaguya/map/pace/kgy_read_pbf.pro)