Go to the bottom.
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name: QREADOUT.SDDL
!
! Purpose: This SDDL file defines the qreadout relation.
!
! Modification History:
!
! Date PR Who Reason
! -------- ------- --- -------------------------------------------------
! 10/30/94 27329 EGB Original implementation
! 01/05/96 29777 MRB Add two fields for STIS/NICMOS SM97
! 02/23/96 30921 RJS Revise definition of PAR_READOUT flag
! 03/12/96 31033 EGB Modify num_ fields descriptions
! 05/10/96 31409 NLC Added field: recording_dur
! 10/10/97 30934 EGB Backout changes from 30921.
! 05/08/98 36870 MRB Add C output
! 03/14/01 39536 DPJ Add "HN" as possible value for eng_data_fmt.
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
LANGUAGE C, FORTRAN, SQL
INCLUDE ZSPSS_USER_TYPES.SDDL
RECORD RDOUT_TYPE
!------------------------------------------------------------------------------
!
! RECORD INFORMATION
!
!------------------------------------------------------------------------------
DESCRIPTION "When an exposure is taken by a science instrument the
data is usually 'read out' to one of the onboard tape
recorders or to a groundstation via a TDRS downlink.
The readout can occur while the data is being collected
or after the data has been collected. This relation is
used to define a readout for the telescope and will
correspond directly to a readout activity on the SPSS
calendar.
While a readout implies it is only for reading from
the telescope, you can also define readout records for
the transfer of data up to the telescope.
Readouts transferring data from the telescope can be
destined for the Science Tape Recorder, the Engineering
Tape Recorder, or to a TDRS satellite.
Readouts that define the transfer of data up to the
telescope are primarily Commanding activities that
are sent via TDRS using one of the onboard low gain
antennae.
Any readout, regardless of the direction of data
transfer, will have a set of data rates defined for the
readout, all of which are data dependent (see TRANS
for SI-specific rate information). These rates include
a nominal data rate, a default data rate, and a maximum
data rate. These rates are particularly important for
SPSS when readouts are scheduled in parallel for separate
scheduling units. When this situation occurs the
actual calendar readout rate for an alignment can be
upgraded to a faster rate to facilitate the parallel SUs.
Calendar readout activities can be displayed using the
SPSS CALENDAR/DISPLAY commands. The /TAPE and /TDRS
qualifiers will cause the information to be displayed."
!------------------------------------------------------------------------------
!
! FIELD INFORMATION
!
!------------------------------------------------------------------------------
FIELD proposal_id
TYPE PROPOSAL_ID_TYPE
FORM
NAME "ARD"
LABEL "PROPOSAL ID"
END_FORM
END_FIELD
FIELD obset_id
TYPE OBSET_ID_TYPE
FORM
NAME "ARD"
LABEL "OBSET ID"
END_FORM
END_FIELD
FIELD alignment_id
TYPE ALIGN_ID_TYPE
FORM
NAME "ARD"
LABEL "ALIGNMENT ID"
END_FORM
END_FIELD
FIELD exposure_id
TYPE EXPOSURE_ID_TYPE
DESCRIPTION "The exposure identifier may be blank if this records
is a readout that is intended to merge data across
multiple exposures."
FORM
NAME "ARD"
LABEL "EXPOSURE ID"
END_FORM
END_FIELD
FIELD version_num
TYPE VERSION_NUM_TYPE
FORM
NAME "ARD"
LABEL "VERSION NUM"
END_FORM
END_FIELD
FIELD interval_num
TYPE I4
DESCRIPTION "To ensure uniqueness for qreadout records when there
are multiple entries for a given (proposal_id/obset_id/
alignment_id/exposure_id) combination, an interval
number is added. The number starts at 1 and is
incremented by one for each record per above
combination."
FORM
NAME "ARD"
LABEL "INTERVAL NUM"
END_FORM
RANGE " 1..99"
END_FIELD
FIELD interval_typ
TYPE C4
DESCRIPTION "This field specifies the type of readout this record
is defining. It would have been better to call this
field readout_type. 'NSSC' type is obsolete."
FORM
NAME "ARD"
LABEL "INTERVAL TYPE (NSSC/TAPE/TDRS)"
END_FORM
DISCRETE "NSSC", "TAPE", "TDRS"
END_FIELD
FIELD start_time
TYPE I4
DESCRIPTION "This is the start time of the readout relative to the
start or end of the alignment (i.e. an offset from
the start of end of the alignment)."
UNITS "SECONDS"
FORM
NAME "ARD"
LABEL "START TIME OF INTERVAL"
END_FORM
END_FIELD
FIELD interval_dur
TYPE I4
DESCRIPTION "This field specifies the duration of the readout to
be scheduled. For TDRS contacts, this is the
duration of the TDRS window."
UNITS "SECONDS"
FORM
NAME "ARD"
LABEL "INTERVAL DURATION"
END_FORM
END_FIELD
FIELD contact_dur
TYPE I4
DESCRIPTION "This field specifies the duration of the TDRS readout
to be scheduled. It only applies to TDRS readouts."
UNITS "SECONDS"
FORM
NAME "ARD"
LABEL "CONTACT DURATION"
END_FORM
END_FIELD
FIELD contact_off
TYPE I4
DESCRIPTION "This field specifies the nominal offset of the contact
duration within the TDRS window."
UNITS "SECONDS"
FORM
NAME "ARD"
LABEL "CONTACT OFFSET"
END_FORM
END_FIELD
FIELD data_type
TYPE C1
DESCRIPTION "This field specifies the datatype of the readout.
'S' designates a SCIENCE readout.
'E' designates an ENGINEERING readout.
'C' designates HST commanding (i.e. uplinking
spacecraft commands using TDRS). "
RELATED_FIELDS "wtdrs_link.data_type"
FORM
NAME "ARD"
LABEL "DATA TYPE (C/E/S)"
END_FORM
DISCRETE "C", "E", "S"
END_FIELD
FIELD eng_data_fmt
TYPE C2
DESCRIPTION "This field lists the format of the engineering
readout data: AN/FN/HN/PN/XN.
Document LMSC DM-01 defines the engineering data and
nominal formats. The PDB files define the actual
contents of each format."
FORM
NAME "ARD"
LABEL "ENG. DATA FORMAT (AN/FN/HN/PN/XN)"
END_FORM
DISCRETE "AN", "FN", "HN", "PN", "XN"
END_FIELD
FIELD nom_data_rat
TYPE R8
DESCRIPTION "This field contains the nominal science data rate
during this readout interval. It is used to restrict
scheduling parallel readout (typically tape recorder)
activities such that the sum of the nominal data rates
(of the parallel readouts) cannot exceed the maximum
data rate (of any of the parallel readouts).
The nominal data rate will always be less than or
equal to the default data rate of the readout. If it
is less than this rate there will be filler data to
pad out the data stream."
UNITS "KILOBITS/SECOND"
RELATED_FIELDS "qreadout.def_data_rat",
"qreadout.max_data_rat"
FORM
NAME "ARD"
LABEL "NOMINAL SCIENCE DATA RATE"
END_FORM
END_FIELD
FIELD def_data_rat
TYPE C5
DESCRIPTION "This field contains the instrument dependent default
data rate for this readout interval. It is the rate
that will be used on the spacecraft unless parallel
activities promote a higher rate. The nominal rate
(from above) will be less than or equal to this rate."
UNITS "KILOBITS/SECOND"
RELATED_FIELDS "qreadout.nom_data_rat",
"qreadout.max_data_rat"
FORM
NAME "ARD"
LABEL "DEFAULT DATA RATE (0.125/0.5/1/4/32/1024)"
END_FORM
DISCRETE "0.125", "0.5", "1", "1024", "32", "4"
END_FIELD
FIELD max_data_rat
TYPE C5
DESCRIPTION "This field is the maximum data rate for this readout
interval. The rate will depend on the readout type.
For example, the tape recorders onboard the HST can
either run at 4, 32, or 1024K. The TDRS contacts can
include these speeds plus some lower speeds for uplinks
(0.125, 0.5, 1.0).
When SPSS schedules parallel readout activities the
sum of the nominal data rates (of the parallel
readouts) cannot exceed this maximum data rate (for
any of the parallel readouts) field. "
UNITS "KILOBITS/SECOND"
FORM
NAME "ARD"
LABEL "MAXIMUM DATA RATE (0.125/0.5/1/4/32/1024)"
END_FORM
DISCRETE "0.125", "0.5", "1", "1024", "32", "4"
END_FIELD
FIELD tdrs_link
TYPE C1
DESCRIPTION "This field lists the direction of TDRS link requested:
F = forward (or UPLINK)
R = return (or DOWNLINK)."
RELATED_FIELDS "wtdrs_link.direction"
FORM
NAME "ARD"
LABEL "TDRS LINK REQUESTED (F/R)"
END_FORM
DISCRETE "F", "R"
END_FIELD
FIELD tdrs_service
TYPE C1
DESCRIPTION "This field defines the type of TDRS service requested.
'M' implies Multi Access service requested which means
the TDRS connection will be shared with other 'users'.
'S' implies Single Source Access which means the HST
is the sole user of the TDRS connection. The latter
implies a higher rate."
RELATED_FIELDS "wtdrs_link.service"
FORM
NAME "ARD"
LABEL "TDRS SERVICE REQUESTED (M/S)"
END_FORM
DISCRETE "M", "S"
END_FIELD
FIELD critical_flg
TYPE YES_NO_FLAG_TYPE
DESCRIPTION "If this field is 'Y', then this readout is defining a
critical TDRS contact. These must be scheduled during
a TDRS interval granted prior to scheduling by the
NCC> This feature has never been used operationally."
FORM
NAME "ARD"
LABEL "CRITICAL FLAG (Y/N)"
END_FORM
END_FIELD
FIELD tape_mode
TYPE C1
DESCRIPTION "For TAPE readouts, this field specifies is what
operating mode the science or engineering tape
recorder is being used:
'R' means it is in RECORD mode.
'P' means it is in PLAYBACK mode.
For TDRS readouts, this field specifies how the tape
recorder is being used:
'B' means it is recording in BACKUP mode to a TDRS
downlink.
'N' means it is not being used at all.
'P' means it is in PLAYBACK mode."
FORM
NAME "ARD"
LABEL "TAPE MODE (B/N/P/R)"
END_FORM
DISCRETE "B", "N", "P", "R"
END_FIELD
FIELD par_readout
TYPE YES_NO_FLAG_TYPE
DESCRIPTION "When this field is 'Y', it means that parallel readouts
(TAPE or TDRS) are allowed of the *same* data type."
RELATED_FIELDS "qalignment.par_readout"
FORM
NAME "ARD"
LABEL "PARALLEL READOUT FLAG (Y/N)"
END_FORM
END_FIELD
FIELD interrupt
TYPE YES_NO_FLAG_TYPE
DESCRIPTION "If this field is 'Y', the TAPE readout activity can
be interrupted. When a TAPE readout activity is
interrupted the total duration of the readout
activity will be increased by the alignment
interruption overhead time. You will see mutliple
TAPE readout activites on the calendar timeline for the
interrupted alignment.
If the alignment is interruptible and this flag is 'N'
then the alignment interruption must occur before the
readout activity begins.
A TDRS alignment or readout activity cannot be
interrupted."
RELATED_FIELDS "qalignment.interrupt" "qalignment.int_overhead"
FORM
NAME "ARD"
LABEL "INTERRUPT (Y/N)"
END_FORM
END_FIELD
FIELD num_images
TYPE I4
DESCRIPTION "This field contains the number of images being read
out. It informs Commanding how much data needs to be
dumped from the memory buffer for SM97 SIs.
For pre-SM97 instruments, readout commanding is done
via exposure-level commanding. This makes sense with
the current SIs for which readouts are tied to the
exposures, but not for the next generation of SIs
which will have the ability to accumulate data in a
buffer and read it out at a later time.
Note that it is desirable to have the ability to
invoke readout commanding independent of exposure
commanding, by going directly from the readout
activity on a calendar to the appropriate instruction."
FORM
NAME "ARD"
LABEL "NUMBER OF IMAGES"
END_FORM
END_FIELD
FIELD num_lines
TYPE I4
DESCRIPTION "This field contains the total number of data lines
being read out.
This informs Commanding how much data needs to be
dumped from the memory buffer for next-generation SIs."
FORM
NAME "ARD"
LABEL "NUMBER OF LINES"
END_FORM
END_FIELD
FIELD recording_dur
TYPE I4
UNITS "SECONDS"
DESCRIPTION "This field indicates the duration of the interval
in which data is being recorded for onboard storage
(via tape or SSR) for this readout. It is used
to enforce recorder-capacity constraints during
scheduling.
During scheduling, the constraint on tape data volume
per orbit should now be enforced via QReadout
recording_dur rather than QAlignment data_volume.
Alignments must be scheduled in such a way that total
science recorder usage does not exceed WIDCR_Parms
tap_data_vol over any one-orbit period. Science
recorder usage for an alignment occurs only during
readouts with QReadout data_type = S and
tape_mode = [R | B]. The total science recorder usage
for such an alignment is the sum of QReadout
recording_dur * def_data_rat over all readouts in an
alignment that use the science recorder (generally an
alignment will have at most one such readout).
If a readout's data rate is upgraded to accomodate a
parallel readout, the upgraded data rate should be
used in place of def_data_rat in the above formula.
Data volume for primary and parallel alignments
should be added together for purposes of checking it
against the tap_data_vol limit, even when the readouts
appear to overlap (SPSS cannot be sure that the
readouts will actually overlap in Commanding).
(OPR 30732)."
END_FIELD
END_RECORD
!------------------------------------------------------------------------------
!
! RELATION DECLARATION
!
!------------------------------------------------------------------------------
RELATION qreadout
TYPE RDOUT_TYPE
DESCRIPTION "TDRS and Tape Recorder Readout Relation"
SUBSYSTEM_USING "SPSS", "TRANS", "IM", "CCLIST"
RELATED_FIELDS "wtdrs_link.*"
FORM
NAME "ARD"
END_FORM
INDEX qreadout_1
TYPE unique, clustered
FIELDS proposal_id, obset_id, alignment_id, version_num,
exposure_id, interval_num, interval_typ
END_INDEX
END_RELATION
!------------------------------------------------------------------------------
!
! INSTANCE DECLARATION
!
!------------------------------------------------------------------------------
INSTANCE qreadout
GLOBAL
TYPE RDOUT_TYPE
END_INSTANCE
Go to the top.