Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

projects/themis/spacecraft/particles/

thm_part_getmodechange.pro


Routines

Routines from thm_part_getmodechange.pro

result = thm_part_getmodechange_esa(probe, datatype, tindex)

Purpose: Helper function to access ESA common blocks and return array of indices for mode changes.

result = thm_part_getmodechange_SST(probe, datatype, tindex)

Purpose: Helper function to access SST common block and return array of indices for mode changes.

result = thm_part_getmodechange_SST2(probe, datatype, tindex)

Purpose: Helper function to access raw SST data stored in tplot variables and return array of indices for mode changes.

result = thm_part_getmodechange(probe, datatype, tindex, sst_cal=sst_cal, n=n)

Purpose: Access particle data common blocks to determine where mode changes occure and how many samples are in each configuration.

Routine details

top source thm_part_getmodechange_esa

result = thm_part_getmodechange_esa(probe, datatype, tindex)

Purpose: Helper function to access ESA common blocks and return array of indices for mode changes. Notes: When editing this code: -make sure calls to scope_varfetch do not copy unnecessary data (see IDL documentation)

Parameters

probe
datatype
tindex

top source thm_part_getmodechange_SST

result = thm_part_getmodechange_SST(probe, datatype, tindex)

Purpose: Helper function to access SST common block and return array of indices for mode changes. Notes: When editing this code: -make sure calls to scope_varfetch do not copy unnecessary data (see IDL documentation) -make sure not to free pointers copied from the common block

Parameters

probe
datatype
tindex

top source thm_part_getmodechange_SST2

result = thm_part_getmodechange_SST2(probe, datatype, tindex)

Purpose: Helper function to access raw SST data stored in tplot variables and return array of indices for mode changes. Data loaded with thm_load_sst2 (/sst_cal keyword on higher level routines) is stored in tplot vars instead of the original common block. Notes:

Parameters

probe
datatype
tindex

top source thm_part_getmodechange

result = thm_part_getmodechange(probe, datatype, tindex, sst_cal=sst_cal, n=n)

Purpose: Access particle data common blocks to determine where mode changes occure and how many samples are in each configuration. Input: probe: String specifying the spacecraft (e.g. 'a','b',...) datatype: String specifying the type of data (e.g. 'peif') tindex: Array of indices specifying which samples are within the time range. Output: returned value: Array of indices correspinding to the first distribution for each new configuration. n: The total number of samples for each configuration. Usage: indices = thm_part_dist_array_getmodechange(probe='a', datatype='psif', $ tindex=time_index_array, n=n)

Parameters

probe
datatype
tindex

Keywords

sst_cal
n

File attributes

Modification date: Thu Feb 13 16:42:51 2014
Lines: 125