Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: projects/barrel/

Contents

.pro files

barrel_config_filedir.pro

NAME: barrel_config_filedirDESCRIPTION: Get the applications user directory for SPEDAS$LastChangedBy: nikos $$LastChangedDate: 2014-10-29 11:36:02 -0700 (Wed, 29 Oct 2014) $$LastChangedRevision: 16081 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/barrel/barrel_config_filedir.pro $

barrel_crib_basic_usage.pro
barrel_init.pro

NAME: barrel_initDESCRIPTION: Initializes system variables for BARREL.

barrel_load_data.pro

NAME: barrel_load_dataDESCRIPTION: master CDF-to-TDAS import routine for BARREL data productsREQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL launch order designators (e.g.

barrel_load_ephm.pro

NAME: barrel_load_ephmDESCRIPTION: CDF-to-TDAS import routine for BARREL ephemeris/gps (EPHM) data productsREQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_fspc.pro

NAME: barrel_load_fspcDESCRIPTION: CDF-to-TDAS import routine for BARREL fast-speed spectral (FSPC) data products (also 'FSPEC')REQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_hkpg.pro

NAME: barrel_load_hkpgDESCRIPTION: CDF-to-TDAS import routine for BARREL housekeeping (HKPG) data (also 'HSK')REQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_magn.pro

NAME: barrel_load_magnDESCRIPTION: CDF-to-TDAS import routine for BARREL magnetometer (MAGN) data products (also 'MAG', 'FGM')REQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_misc.pro

NAME: barrel_load_miscDESCRIPTION: CDF-to-TDAS import routine for miscellaneous BARREL data products (note: formerly the "pulse-per-second" / PPS datatype)REQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_mspc.pro

NAME: barrel_load_mspcDESCRIPTION: CDF-to-TDAS import routine for BARREL medium-speed spectral (MSPC) data products (also 'MSPEC')REQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_rcnt.pro

NAME: barrel_load_rcntDESCRIPTION: CDF-to-TDAS import routine for BARREL (RCNT) data productsREQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_load_sspc.pro

NAME: barrel_load_sspcDESCRIPTION: CDF-to-TDAS import routine for BARREL slow-speed spectral (SSPC) data products (also 'SSPEC')REQUIRED INPUTS: noneKEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B').

barrel_preload_actions.pro

NAME: barrel_preload_actionsDESCRIPTION: CDF-to-TDAS pre-import routine for BARREL dataREQUIRED INPUTS: (see Required Keyword Arguments, below) **NOTE** 'barrel_preload_actions' is not intended to be a user-facing routine.

barrel_read_config.pro

NAME: barrel_read_configDESCRIPTION: Reads the barrel_config fileREQUIRED INPUTS: none (filename is hardcoded, 'barrel_config.txt', and is put in a folder given by the routine 'barrel_config_filedir', that uses the IDL routine app_user_dir to create/obtain it: e.g.

barrel_write_config.pro

NAME: barrel_write_configDESCRIPTION: Writes the barrel_config fileREQUIRED INPUTS: none (filename is hardcoded, 'barrel_config.txt', and is put in a folder given by the routine 'barrel_config_filedir', that uses the IDL routine app_user_dir to create/obtain it: e.g.

brl_binvert.pro

INPUT: start is an initial estimate of bin value(s) f is a temperature/detector dependent constant KEYWORD: none OUTPUT: returns an object of the same type and dimension as start; object contains energy value(s) METHOD: two iterations of Newton-Raphson to solve a transcendental equation.

brl_dpucoeffs.pro

INPUT: flightID is a two-character string to identify which payload through a flight inumber (e.g., '1A') OUTPUT: [[a1,a2],[b1,b2],[c1,c2]] is a list of 3 sets of linear model coefficients, used by brl_makeedges() METHOD: linear search; guess if unrecognized input REVISION HISTORY: 16Jan2014 Added constants for payload 2I 14Sep2013 first version

brl_find511.pro

pro mygauss() and function brl_find511()++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ evaluate gaussian + linear model for use with curvefit() model is f(x) = a[0]*exp(-((x-a[1])/a[2])^2) + a[3]x + a[4] INPUT: x is where the model is to be evaluated a is the current list of 5 parameter values; these must be initialized by the caller OUTPUT: f is evaluated as a linear+gaussian model pder is a list of 5 partial derivatives of f wrt a WARNING: for speed, no checks for foolish function evaluation requests.

brl_makebkgd.pro

INPUT: energylist is a list of energies (keV) alt is altitude in km (25

brl_makeedges.pro

INPUT: all inputs through keywords KEYWORD: keyword parameters flightID=flightID 2 char identifier (e.g., '1S') dpu_temp=dpu_temp dpu temperature in C xtal_temp=xtal_temp scintillator temperature in C peak511=peak511 sspc location for 511keV; 200 nominal; 0