OV-GSO-DC / dustem-wrapper_idl

Blame view

src/idl_misc/coyote_for_Dustemwrap/jn2time.pro 4.75 KB
Edit Raw Normal View History
6db3528a   Jean-Philippe Bernard   adding librairies... 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
;+
; NAME:
;    JN2TIME
;
; PURPOSE:
;
;    The purpose of this function is to convert a Julian number into
;    a time string of the form "16 Mar 2009 15:34:26."
;
; AUTHOR:
;
;   FANNING SOFTWARE CONSULTING
;   David Fanning, Ph.D.
;   1645 Sheely Drive
;   Fort Collins, CO 80526 USA
;   Phone: 970-221-0438
;   E-mail: david@idlcoyote.com
;   Coyote's Guide to IDL Programming: http://www.idlcoyote.com/
;
; CATEGORY:
;
;    Utility.
;
; CALLING SEQUENCE:
;
;    result = JN2TIME(jnumber)
;
; INPUTS:
;
;    jnumber:   A Julian number or array of Julian numbers. If absent,
;                today's current local time is returned.
;
; OUTPUTS:
;
;    result:     A scalar or vector of time strings of the form "16 Mar 2009 15:34:26".
;
; KEYWORDS:
;
;    SHORT:      Set this keyword to return just the day, month, year portion of the string.
;    
; DEPENDENCIES:
; 
;    Requires THEMONTHS from the Coyote Library.
;    
;         http://www.idlcoyote.com/programs/themonths.pro
;
; MODIFICATION HISTORY:
;
;    Written by: David W. Fanning, 25 June 2009.
;    Retired 9 Jan 2013 and replaced with cgJulian2Date.
;-
;******************************************************************************************;
;  Copyright (c) 2009, by Fanning Software Consulting, Inc.                                ;
;  All rights reserved.                                                                    ;
;                                                                                          ;
;  Redistribution and use in source and binary forms, with or without                      ;
;  modification, are permitted provided that the following conditions are met:             ;
;                                                                                          ;
;      * Redistributions of source code must retain the above copyright                    ;
;        notice, this list of conditions and the following disclaimer.                     ;
;      * Redistributions in binary form must reproduce the above copyright                 ;
;        notice, this list of conditions and the following disclaimer in the               ;
;        documentation and/or other materials provided with the distribution.              ;
;      * Neither the name of Fanning Software Consulting, Inc. nor the names of its        ;
;        contributors may be used to endorse or promote products derived from this         ;
;        software without specific prior written permission.                               ;
;                                                                                          ;
;  THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY        ;
;  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES    ;
;  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT     ;
;  SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,             ;
;  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED    ;
;  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;         ;
;  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND             ;
;  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT              ;
;  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS           ;
;  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                            ;
;******************************************************************************************;
FUNCTION JN2Time, jnumber, SHORT=short

    ; Return to caller, on error
    On_Error, 2
    
    ; Get today's date, if argument is not present.
    IF N_Elements(jnumber) EQ 0 THEN jnumber = Systime(/JULIAN)
    
    ; Set up an array for storing the time string.
    num = N_Elements(jnumber)
    timeString = StrArr(num)
    
    ; Process the Julian day values.
    CalDat, jnumber, month, day, year, hour, minute, second
    IF Keyword_Set(short) THEN BEGIN
       timeString = String(day, FORMAT='(I2.2)') + ' ' + $
           theMonths(month, /ABBREVIATION, /FIRSTLETTER) + ' ' + $
            String(year, FORMAT='(I4)')   
    ENDIF ELSE BEGIN
       timeString = String(day, FORMAT='(I2.2)') + ' ' + $
            theMonths(month, /ABBREVIATION, /FIRSTLETTER) + ' ' + $
            String(year, FORMAT='(I4)') + ' ' + $
            String(hour, FORMAT='(I2.2)') + ':' + $
            String(minute, FORMAT='(I2.2)') + ':'  + $
            String(second, FORMAT='(I2.2)')  
    ENDELSE
     
    ; Make sure you return a scalar, if needed.
    IF num EQ 1 THEN Return, timeString[0] ELSE RETURN, timeString
   
END