projects/themis/spin/
spinmodel_get_info.pro
NAME: SPINMODEL_GET_INFO.PRO PURPOSE: Given a probe string or spinmodel pointer, return information about the valid time range or shadow times. CATEGORY: TDAS CALLING SEQUENCE: spinmodel_get_info,model=modelptr,min_shadow_duration=min_shadow_duration,$ shadow_count=shadow_count, $ shadow_start=shadow_start,shadow_end=shadow_end,$ start_time=start_time, end_time=end_time INPUTS: Model: pointer to s spinmodel structure Probe: a string identifying the probe. The caller must specify either a model pointer or probe string. min_shadow_duration: Optional parameter specifying the minimum gap between BAU sun sensor crossing times to be considered a shadow interval. Defaults to 60.0 sec. OUTPUTS: (all optional) shadow_count: Number of shadow intervals found. shadow_start: Double precision array of shadow start times. shadow_end: Double precision array of shadow end times. start_time: Double precision scalar indicating start time of loaded spinmodel data end_time: Double precision scalar indicating end time of loaded spinmodel data PROCEDURE: Shadow intervals consist of spinmodel segments where the "maxgap" parameter exceeds the min_shadow_duration threshold. Start time is the start time of the first segment. End time is the end time of the last segment. If no spinmodel data is loaded for the requested probe, start_time = end_time = 0.0D. If no shadows are found, shadow_count is set to zero and no start/end times are returned. EXAMPLE: timespan,'2007-03-23',1,/days thm_load_state,probe='a',/get_support_data spinmodel_get_info,probe='a',shadow_count=shadow_count,$ shadow_start=shadow_start, shadow_end=shadow_end,$ start_time=start_time,end_time=end_time
Routines
top source spinmodel_get_info
spinmodel_get_info, model=model, probe=probe, min_shadow_duration=min_shadow_duration, shadow_count=shadow_count, shadow_start=shadow_start, shadow_end=shadow_end, start_time=start_time, end_time=end_time
Keywords
- model
- probe
- min_shadow_duration
- shadow_count
- shadow_start
- shadow_end
- start_time
- end_time
File attributes
Modification date: | Thu Feb 13 16:42:34 2014 |
Lines: | 31 |