Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/state/cotrans/

thm_cotrans.pro


Procedure: thm_cotrans Purpose: Transform between various THEMIS and geophysical coordinate systems keywords: probe = Probe name. The default is 'all', i.e., transform data for all available probes. This can be an array of strings, e.g., ['a', 'b'] or a single string delimited by spaces, e.g., 'a b' datatype = The type of data to be transformed, can take any of the values allowed for datatype for the various thm_load routines. You can use wildcards like ? and [lh]. 'all' is not accepted. You can use '*', but you may get unexpected results if you are using suffixes. in_coord = 'spg', 'ssl', 'dsl', 'gse', 'gsm','sm', 'gei','geo', 'sse', 'sel' or 'mag' coordinate system of input. This keyword is optional if the dlimits.data_att.coord_sys attribute is present for the tplot variable, and if present, it must match the value of that attribute. See cotrans_set_coord, cotrans_get_coord out_coord = 'spg', 'ssl', 'dsl', 'gse', 'gsm', 'sm', 'gei','geo', 'sse','sel', or 'mag' coordinate system of output. This keyword is optional if out_suffix is specified and last 3 characters of suffix specify the output coordinate system. in_suffix = optional suffix needed to generate the input data quantity name: 'th'+probe+'_'datatype+in_suffix out_suffix = optional suffix to add to output data quantity name. If in_suffix is present, then in_suffix will be replaced by out_suffix in the output data quantity name. valid_names:return valid coordinate system names in named varibles supplied to in_coord and/or out_coord keywords. support_suffix: if support_data is loaded with a suffix you can specify it here out_vars: return a list of the names of any transformed variables ignore_dlimits: set this keyword to true so that an error will not be produced if the internal label of the coordinate system clashed with the user provided coordinate system. interpolate_state: use interpolation on 1-minute state CDF spinper/spinphase samples for despinning instead of spin model no_update_labels: Set this keyword if you want the routine to not update the labels automatically Optional Positional Parameters: in_name Name(s) of input tplot variable(s) (or glob patern) (space-separated list or array of strings.). If the in_name parameter is provided, the probe and datatype keywords will be ignored. However, if the input name is not of format 'th[a-e]_*', use the probe keyword to indicate which probe's state data should be used for each input variable. out_name Name(s) of output tplot variable(s). glob patterns not accepted. Number of output names must match number of input names (after glob expansion of input names). (single string, or array of strings.) Examples: thm_load_state, /get_support thm_cotrans, probe='a', datatype='fgl', out_suffix='_gsm' ; or equivalently thm_cotrans, 'tha_fgl', 'tha_fgl_gsm', out_coord='gsm' ; to transform all th?_fg?_dsl to th?_fg?_gsm thm_cotrans, 'th?_fg?', in_suffix='_dsl', out_suffix='_gsm' ; for arbitrary input variables, specify in_coord and probe: thm_cotrans,'mydslvar1 mydslvar2 mydslvar3', $ in_coord='dsl', probe='b c d', out_suff='_gse' $LastChangedBy: egrimes $ $LastChangedDate: 2014-03-04 09:59:31 -0800 (Tue, 04 Mar 2014) $ $LastChangedRevision: 14487 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/state/cotrans/thm_cotrans.pro $

Routines

Routines from thm_cotrans.pro

thm_cotrans_update_dlimits, out_name, in_coord, out_coord
thm_cotrans_update_limits, out_name, in_coord, out_coord
thm_cotrans_check_valid_transform, in_name, in_coord, out_coord
thm_cotrans_transform_helper, in_name, out_name, in_coord, out_coord, spinras, spindec, spinper, spinphase, ignore_dlimits=ignore_dlimits, interpolate_state=interpolate_state, use_spinphase_correction=use_spinphase_correction, name_sun_pos=name_sun_pos, name_lun_pos=name_lun_pos, name_lun_att_x=name_lun_att_x, name_lun_att_z=name_lun_att_z, prb=prb, use_eclipse_corrections=use_eclipse_corrections
thm_cotrans, in_name, out_name, probe=probe, datatype=datatype, in_coord=in_coord, out_coord=out_coord, verbose=verbose, in_suffix=in_suffix, out_suffix=out_suffix, valid_names=valid_names, support_suffix=support_suffix, ignore_dlimits=ignore_dlimits, interpolate_state=interpolate_state, out_vars=out_vars, use_spinaxis_correction=use_spinaxis_correction, use_spinphase_correction=use_spinphase_correction, use_eclipse_corrections=use_eclipse_corrections, slp_suffix=slp_suffix, no_update_labels=no_update_labels

Routine details

top source thm_cotrans_update_dlimits

thm_cotrans_update_dlimits, out_name, in_coord, out_coord

Parameters

out_name
in_coord
out_coord

top source thm_cotrans_update_limits

thm_cotrans_update_limits, out_name, in_coord, out_coord

Parameters

out_name
in_coord
out_coord

top source thm_cotrans_check_valid_transform

thm_cotrans_check_valid_transform, in_name, in_coord, out_coord

Parameters

in_name
in_coord
out_coord

top source thm_cotrans_transform_helper

thm_cotrans_transform_helper, in_name, out_name, in_coord, out_coord, spinras, spindec, spinper, spinphase, ignore_dlimits=ignore_dlimits, interpolate_state=interpolate_state, use_spinphase_correction=use_spinphase_correction, name_sun_pos=name_sun_pos, name_lun_pos=name_lun_pos, name_lun_att_x=name_lun_att_x, name_lun_att_z=name_lun_att_z, prb=prb, use_eclipse_corrections=use_eclipse_corrections

Parameters

in_name
out_name
in_coord
out_coord
spinras
spindec
spinper
spinphase

Keywords

ignore_dlimits
interpolate_state
use_spinphase_correction
name_sun_pos
name_lun_pos
name_lun_att_x
name_lun_att_z
prb
use_eclipse_corrections

top source thm_cotrans

thm_cotrans, in_name, out_name, probe=probe, datatype=datatype, in_coord=in_coord, out_coord=out_coord, verbose=verbose, in_suffix=in_suffix, out_suffix=out_suffix, valid_names=valid_names, support_suffix=support_suffix, ignore_dlimits=ignore_dlimits, interpolate_state=interpolate_state, out_vars=out_vars, use_spinaxis_correction=use_spinaxis_correction, use_spinphase_correction=use_spinphase_correction, use_eclipse_corrections=use_eclipse_corrections, slp_suffix=slp_suffix, no_update_labels=no_update_labels

Parameters

in_name
out_name

Keywords

probe
datatype
in_coord
out_coord
verbose
in_suffix
out_suffix
valid_names
support_suffix
ignore_dlimits
interpolate_state
out_vars
use_spinaxis_correction
use_spinphase_correction
use_eclipse_corrections
slp_suffix
no_update_labels

File attributes

Modification date: Thu Mar 13 16:35:35 2014
Lines: 485