1PLCONFIGTIME(3plplot)             PLplot API             PLCONFIGTIME(3plplot)
2
3
4

NAME

6       plconfigtime - Configure the transformation between continuous and bro‐
7       ken-down time for the current stream
8

SYNOPSIS

10       plconfigtime(scale, offset1, offset2, ccontrol,  ifbtime_offset,  year,
11       month, day, hour, min, sec)
12

DESCRIPTION

14       Configure  the  transformation  between continuous and broken-down time
15       for the current stream.  This  transformation  is  used  by  both  plb‐
16       time(3plplot) and plctime(3plplot).
17
18       Redacted form: General: plconfigtime(scale, offset1, offset2, ccontrol,
19       ifbtime_offset, year, month, day, hour, min, sec)
20
21
22       This function is used in example 29.
23

ARGUMENTS

25       scale (PLFLT(3plplot), input)
26              The number of days per continuous time unit.  As a special case,
27              if  scale  is  0., then all other arguments are ignored, and the
28              result (the default used by PLplot) is the equivalent of a  call
29              to  plconfigtime(1./86400.,  0.,  0.,  0x0, 1, 1970, 0, 1, 0, 0,
30              0.). That is, for this special case broken-down time  is  calcu‐
31              lated with the proleptic Gregorian calendar with no leap seconds
32              inserted, and the continuous time is defined as  the  number  of
33              seconds since the Unix epoch of 1970-01-01T00:00:00Z.
34
35       offset1 (PLFLT(3plplot), input)
36              If  ifbtime_offset  is  true, the parameters offset1 and offset2
37              are completely ignored. Otherwise, the sum of  these  parameters
38              (with  units  in  days) specify the epoch of the continuous time
39              relative to the MJD epoch corresponding to the Gregorian  calen‐
40              dar  date  of 1858-11-17T00:00:00Z or JD = 2400000.5.  Two PLFLT
41              numbers are used to specify the origin to allow users (by speci‐
42              fying offset1 as an integer that can be exactly represented by a
43              floating-point variable and specifying offset2 as  a  number  in
44              the range from 0. to 1) the chance to minimize the numerical er‐
45              rors of the continuous time representation.
46
47       offset2 (PLFLT(3plplot), input)
48              See documentation of offset1.
49
50       ccontrol (PLINT(3plplot), input)
51              ccontrol contains bits controlling the transformation.   If  the
52              0x1  bit  is set, then the proleptic Julian calendar is used for
53              broken-down time rather than the proleptic  Gregorian  calendar.
54              If the 0x2 bit is set, then leap seconds that have been histori‐
55              cally used to define UTC are inserted into the broken-down time.
56              Other possibilities for additional control bits for ccontrol ex‐
57              ist such as making the historical time corrections in  the  bro‐
58              ken-down time corresponding to ET (ephemeris time) or making the
59              (slightly non-constant) corrections  from  international  atomic
60              time  (TAI) to what astronomers define as terrestrial time (TT).
61              But those additional possibilities have not been implemented yet
62              in the qsastime library (one of the PLplot utility libraries).
63
64       ifbtime_offset (PLBOOL(3plplot), input)
65              ifbtime_offset  controls  how  the  epoch of the continuous time
66              scale is specified by the user. If ifbtime_offset is false, then
67              offset1  and offset2 are used to specify the epoch, and the fol‐
68              lowing broken-down time parameters are completely  ignored.   If
69              ifbtime_offset  is true, then offset1 and offset2 are completely
70              ignored, and the following broken-down time parameters are  used
71              to specify the epoch.
72
73       year (PLINT(3plplot), input)
74              Year of epoch.
75
76       month (PLINT(3plplot), input)
77              Month of epoch in range from 0 (January) to 11 (December).
78
79       day (PLINT(3plplot), input)
80              Day of epoch in range from 1 to 31.
81
82       hour (PLINT(3plplot), input)
83              Hour of epoch in range from 0 to 23
84
85       min (PLINT(3plplot), input)
86              Minute of epoch in range from 0 to 59.
87
88       sec (PLFLT(3plplot), input)
89              Second of epoch in range from 0. to 60.
90
91

AUTHORS

93       Many  developers  (who  are  credited at http://plplot.org/credits.php)
94       have contributed to PLplot over its long history.
95

SEE ALSO

97       PLplot documentation at http://plplot.org/documentation.php.
98
99
100
101                                 January, 2023           PLCONFIGTIME(3plplot)
Impressum