! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ! ! SDDL Name: WGGS_PAIRS.SDDL ! ! Purpose: This SDDL file defines the wggs_pairs relation. ! ! Modification History: ! ! Date OPR Who Reason ! -------- ------- --- ------------------------------------------------- ! 11/ 2/94 27329 RSL Original implementation ! 12/21/94 27329 EGB Change record type name to avoid conflict with ! GS_RESPONSE.SDDL. ! 01/15/96 30148 RJS Unrelated to PR, used to modify comment for ! the field cnt_man_dr ! 04/26/96 27745 bao Eliminate two-step GS acquisition support ! from database and SPSS ! 05/17/96 31490 bao Remove unneeded fields from WGGS_PAIRS to improve ! insert performance ! 01/30/98 35442 sss Removed several unused fields. ! 02/07/98 35442 bao New GS_REQUEST command required to perform Guide ! Star Processing ! 11/03/98 37306 bao Delete remnants of GSSS interface from SPSS !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ! LANGUAGE FORTRAN, SQL, C INCLUDE ZSPSS_USER_TYPES.SDDL RECORD GSPAIRS_TYPE !------------------------------------------------------------------------------ ! ! RECORD INFORMATION ! !------------------------------------------------------------------------------ DESCRIPTION "The wggs_pairs relation stores data that identifies and characterizes potentially usable guide star pairs. The fields are populated by the following: - the GS_REQUEST response processing function, which uses data generated by its request processing module - the GS_REQUEST command's centerlining function, which determines values for the fields specifically used for guide star acquisitions - the PMDB/UPDATE/TYPE=SU command, which calculates the roll window times - an Operations tool, which populates the 'selected' field When PMDB/UPDATE/TYPE=SU is run, it deletes observation set specific data for observation sets other than the first in a previous acquisition sequence. When this occurs, it deletes records from wggs_pairs. When GSSELECT is run, pairs are selected from wggs_pairs. The FOV program selects pair information from this relation. SMSG/SCHEDULE accesses data from the relation when generating OSS/PODPS observation records." !------------------------------------------------------------------------------ ! ! FIELD INFORMATION ! !------------------------------------------------------------------------------ FIELD proposal_id TYPE PROPOSAL_ID_TYPE FORM NAME "GPS" LABEL "PROPOSAL ID" END_FORM END_FIELD FIELD obset_id TYPE OBSET_ID_TYPE FORM NAME "GPS" LABEL "OBSET ID" END_FORM END_FIELD FIELD version_num TYPE VERSION_NUM_TYPE FORM NAME "GPS" LABEL "VERSION NUM" END_FORM END_FIELD FIELD gs_pair_id TYPE GS_PAIR_ID_TYPE RELATED_FIELDS "wguide_stars.gs_pair_id", "wguide_stars.gs_id", "wguide_stars.fgs_id" FORM NAME "GPS" LABEL "GS PAIR ID" END_FORM END_FIELD FIELD gsc_plate_id TYPE C4 DESCRIPTION "The field specifies the identifier of a guide star catalog plate which was used to determine the target position." RELATED_FIELDS "qtargets.gsc_plate_id" END_FIELD FIELD overlap TYPE YES_NO_FLAG_TYPE DESCRIPTION "This field specifies whether a plate overlap solution was performed by the GS_REQUEST, request processing function. If coordinates for all the selected guide stars are not available from the same plate, a local plate overlap solution is performed to minimize relative positional errors." END_FIELD FIELD preusage TYPE YES_NO_FLAG_TYPE DESCRIPTION "This is the successful pair preusage flag. It is always set to a value of 'N'. If the preusage data ever becomes available, a value of 'Y' means the pair was used successfully in the past. A value of 'N' means the pair was not used successfully." FORM NAME "GPS" LABEL "PU" END_FORM END_FIELD FIELD est_acq_prob TYPE C4 DESCRIPTION "This field is the estimate of the success to be expected in acquiring the guide star pair." FORM NAME "GPS" LABEL "ACQUISITION PROBABILITY" END_FORM END_FIELD FIELD spoiler_pair TYPE C6 DESCRIPTION "The field is an estimate of the probability that for either guide star, an object other than the guide star will be in the magnitude window recommended for acquisition; and that the separation of the two objects will be in the separation window recommended for acquisition." FORM NAME "GSS" LABEL "ESTIMATED SPOILER PAIR ACQUISITION PROB" END_FORM END_FIELD FIELD gs_sepratn TYPE R4 DESCRIPTION "The field contains the separation of the guide star pair members." FORM NAME "GSS" LABEL "GS PAIR SEPARATION" END_FORM UNITS "ARCSECONDS" END_FIELD FIELD acq_order TYPE C1 DESCRIPTION "The guide star pair acquisition order field indicates which star in the pair should be acquired first. A value of 'D' means the dominant star should be acquired first. 'S' means the subdominant star should be acquired first. See the description of GS_PAIR_ID_TYPE for definitions of dominant and subdominant." RELATED_FIELDS "wggs_pairs.gs_pair_id" FORM NAME "GSS" LABEL "ACQUISITION ORDER" END_FORM DISCRETE "D", "S" END_FIELD FIELD ref_v1ax_ra TYPE R8 UNITS "DEGREES" DESCRIPTION "This is the right ascension of the reference V1-axis position. It is the vector average of the target positions (using the reference point for area targets) of all targets in this observation set, for fixed targets. It is specified in the heliocentric coordinate system relative to the mean equator and equinox at the beginning of Julian epoch J2000.0. For moving targets, the reference target id in qbs_obset will be used as the reference target for specification of the angle ranges." RANGE "0..360" RELATED_FIELDS "qbs_obset.ref_targ_id" END_FIELD FIELD ref_v1ax_dec TYPE R8 UNITS "DEGREES" DESCRIPTION "This is the declination of the reference V1-axis position. It is the vector average of the target positions (using the ref. POINT for area targets) of all targets in this observation set, for fixed targets. It is specified in the heliocentric coordinate system relative to the mean equator and equinox at the beginning of Julian epoch J2000.0. For moving targets, the reference target id in qbs_obset will be used as the reference target for specification of the angle ranges." RANGE "-90...90" RELATED_FIELDS "qbs_obset.ref_targ_id" END_FIELD FIELD min_v3_angle UNITS "ARCDEGREES" TYPE R8 DESCRIPTION "The minimum V3 position angle is the lower limit of the position angle range." FORM NAME "GSS" LABEL "MINIMUM V3 ANGLE" END_FORM END_FIELD FIELD max_v3_angle UNITS "ARCDEGREES" TYPE R8 DESCRIPTION "The maximum V3 position angle is the upper limit of the position angle range." FORM NAME "GSS" LABEL "MAXIMUM V3 ANGLE" END_FORM END_FIELD FIELD ear_tim_usbl TYPE SOGS_CHAR_TIME_TYPE DESCRIPTION "The is the earliest time the guide star pair is usable. This field is valid for moving targets only." END_FIELD FIELD lat_tim_usbl TYPE SOGS_CHAR_TIME_TYPE DESCRIPTION "This is the latest time the guide star pair is usable. This field is valid for moving targets only." FORM NAME "GSS" LABEL "USABILITY END TIME" END_FORM END_FIELD FIELD complete TYPE C1 DESCRIPTION "This is the target/aperture completeness flag. 'A' means all requested target/aperture combinations are accessible. 'P' means all primary (non-parallel) combinations are accessible. 'H' means all high priority combinations are accessible. 'S' means some of the requested combinations are accessible." FORM NAME "GPS" LABEL "TARG. APER. TYPE" END_FORM DISCRETE "A", "H", "P", "S" END_FIELD FIELD al_complete TYPE YES_NO_FLAG_TYPE DESCRIPTION "The target/aperture nominal alignment completeness flag indicates whether or not the guide star pair is accessible for all corresponding primary target/aperture combinations, for which the pair is available, so that their nominal pointing positions and their aperture reference positions are aligned, and all their viewing constraints are fulfilled." FORM NAME "GPS" LABEL "TARG. APER. FLG" END_FORM END_FIELD FIELD sel_seq TYPE I2 DESCRIPTION "This is the recommended guide star pair selection sequence number, which indicates the preferred usage order of guide star pairs. The field contains a sequence counter, unique to the response, with the most preferred guide star pair numbered one, and the less preferred numbered sequentially afterwards." FORM NAME "GPS" LABEL "SEQ. NUM" END_FORM FORM NAME "GSP" LABEL "SEQ NUM" END_FORM END_FIELD FIELD usable TYPE C1 DESCRIPTION "This field indicates whether or not the guide star pair is usable. 'Y' means the pair is usable. 'N' means the pair is not usable. 'B' means the pair contains a bad guide star." FORM NAME "GPS" LABEL "USABLE" END_FORM DISCRETE "N", "Y", "B" END_FIELD FIELD selected TYPE C1 DESCRIPTION "This field is the selected flag. '0' means the guide star pair has not been selected for use in a guide star acquisition. '1' means the pair has been selected as the primary pair in an acquisition. '2' means the pair has been selected as the first backup pair. '3' means the pair has been selected as the second backup pair. The default is '0', which is filled in by the GS_REQUEST program. PFORM GPS can be used to update the field, but it is normally set by an Operations tool. The field is no longer used during SMS generation to identify the selected guide star pair. Instead, fields (listed below) in the qbgsp_select relation are used. The wggs_pairs 'selected' field is still used by Operations however, for other purposes." RELATED_FIELDS "qbgsp_select.select_order", "qbgsp_select.sel_seq" FORM NAME "GPS" LABEL "SEL FLAG" END_FORM DISCRETE "0", "1", "2", "3" END_FIELD FIELD acq_min_v3 UNITS "ARCDEGREES" TYPE R8 DESCRIPTION "This is the minimum acquisition V3 position angle. It is the lower limit of the acquisition position angle range." END_FIELD FIELD acq_max_v3 UNITS "ARCDEGREES" TYPE R8 DESCRIPTION "This is the maximum acquisition V3 position angle. It is the upper limit of the acquisition position angle range." END_FIELD FIELD acq_flag TYPE C1 DESCRIPTION "The acquisition flag indicates if the guide star pair can be acquired without centerlining. 'N' means neither primary nor secondary can be acquired. 'P' means only the primary can be acquired. 'S' means only the secondary can be acquired. 'B' means both can be acquired. 'G' means the primary and secondary can be acquired, but when intersected with the guide star roll range, the result is a null roll range." DISCRETE "N", "P", "S", "B", "G" END_FIELD FIELD cnt_min_v3 UNITS "ARCDEGREES" TYPE R8 DESCRIPTION "This is the minimum centerline V3 position angle. It is the lower limit of the centerline position angle range." END_FIELD FIELD cnt_max_v3 UNITS "ARCDEGREES" TYPE R8 DESCRIPTION "This is the maximum centerline V3 position angle. It is the upper limit of the centerline position angle range." END_FIELD FIELD cnt_flag TYPE C1 DESCRIPTION "This field indicates if the guide star pair can be centerlined. 'B' means both stars can be centerlined without overlapping the outer edge of the FGS field of view. 'O' means both stars overlap the outer edge of the FGS field of view. 'N' means the guide star pair cannot be acquired." DISCRETE "B", "O", "N" END_FIELD FIELD cnt_man_dr TYPE I4 DESCRIPTION "This field represents the guide star centerline maximum distance offset angle." UNITS "ARCSECONDS" END_FIELD END_RECORD !------------------------------------------------------------------------------ ! ! RELATION DECLARATION ! !------------------------------------------------------------------------------ RELATION wggs_pairs TYPE GSPAIRS_TYPE DESCRIPTION "Guide Star Pair Data Relation" SUBSYSTEM_USING "SPSS" FORM NAME "GPS", "GSP", "GSS" END_FORM INDEX wggs_pairs_1 TYPE unique, clustered FIELDS proposal_id, obset_id, version_num, gs_pair_id END_INDEX INDEX wggs_pairs_2 TYPE nonclustered FIELDS gs_pair_id END_INDEX END_RELATION !------------------------------------------------------------------------------ ! ! INSTANCE DECLARATION ! !------------------------------------------------------------------------------ INSTANCE wggs_pairs GLOBAL TYPE GSPAIRS_TYPE END_INSTANCE