Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

spedas/gui/objects/

spd_qf_list__define.pro


NAME: spd_qf_list__define PURPOSE: Defines an object for quality flag lists CALLING SEQUENCE: qf = Obj_New("spd_qf_list", t_start=t_start, t_end=t_end, qf_bits=qf_bits) INPUT: none KEYWORDS: t_start t_end qf_bits OUTPUT: quality flag list object reference METHODS: qf_merge(qf) returns an spd_qf_list which is a merge of self with qf qf_time_slice(tstart, tend) returns an spd_qf_list for times between tstart and tend get_qf(t) returns the quality flag for scalar time t qf_print() prints the values of the three arrays NOTES: 1. Quality flags qf_bits for semiclosed time intervals [t_start, t_end) with t_start0 2. qf_bits = 0 is ignored since it is assumed to be the default 3. t_start = t_end is not possible 4. Adding two quality flags (bitwise OR) is handled by qf_add() and qf_total() EXAMPLES: x = obj_new('SPD_QF_LIST', t_start=[1262304000.0], t_end=[1263081600.0], qf_bits=[1]) y = obj_new('SPD_QF_LIST', t_start=[1262649600.0,1263513600.0], t_end=[1263513600.0,1264377600.0], qf_bits=[2,3]) z = x.qf_merge(y) test = z.qf_print() HISTORY: $LastChangedBy: nikos $ $LastChangedDate: 2014-12-10 16:47:06 -0800 (Wed, 10 Dec 2014) $ $LastChangedRevision: 16448 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_qf_list__define.pro $

Class description for spd_qf_list

Properties

Properties in spd_qf_list

qf_bits init
t_end init
t_start init

Fields

Fields in spd_qf_list

QF_BITS ptr_new()
T_END ptr_new()
T_START ptr_new()

Routines

Routines from spd_qf_list__define.pro

result = spd_qf_list::init(t_start=t_start, t_end=t_end, qf_bits=qf_bits)
result = spd_qf_list::qf_time_slice(tstart, tend)
result = spd_qf_list::qf_merge(qf)
result = spd_qf_list::get_qf(t)
result = spd_qf_list::qf_check()
result = spd_qf_list::qf_total(qf_bits)
result = spd_qf_list::qf_add(qf_bits1, qf_bits2)
result = spd_qf_list::qf_sort()
result = spd_qf_list::qf_print()
result = spd_qf_list::count()
result = spd_qf_list::t_start()
result = spd_qf_list::t_end()
result = spd_qf_list::qf_bits()
spd_qf_list__define

Routine details

top source spd_qf_list::init

result = spd_qf_list::init(t_start=t_start, t_end=t_end, qf_bits=qf_bits)

Keywords

t_start
t_end
qf_bits

top source spd_qf_list::qf_time_slice

result = spd_qf_list::qf_time_slice(tstart, tend)

Parameters

tstart
tend

top source spd_qf_list::qf_merge

result = spd_qf_list::qf_merge(qf)

Parameters

qf

top source spd_qf_list::get_qf

result = spd_qf_list::get_qf(t)

Parameters

t

top source spd_qf_list::qf_check

result = spd_qf_list::qf_check()

top source spd_qf_list::qf_total

result = spd_qf_list::qf_total(qf_bits)

Parameters

qf_bits

top source spd_qf_list::qf_add

result = spd_qf_list::qf_add(qf_bits1, qf_bits2)

Parameters

qf_bits1
qf_bits2

top source spd_qf_list::qf_sort

result = spd_qf_list::qf_sort()

top source spd_qf_list::qf_print

result = spd_qf_list::qf_print()

top source spd_qf_list::count

result = spd_qf_list::count()

top source spd_qf_list::t_start

result = spd_qf_list::t_start()

top source spd_qf_list::t_end

result = spd_qf_list::t_end()

top source spd_qf_list::qf_bits

result = spd_qf_list::qf_bits()

top source spd_qf_list__define

spd_qf_list__define

File attributes

Modification date: Wed Dec 10 20:48:01 2014
Lines: 172