BLbluestaq
Observation

GET /udl/gnssrawif/{id}

Changed on

Service operation to get a single GNSSRawIF by its unique ID passed as a path parameter.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/gnssrawif/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the GNSSRawIF to retrieve.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

idOnOrbitstring

Unique identifier of the primary satellite on-orbit object.

satNointeger

Satellite/catalog number of the target on-orbit object.

origObjectIdstring

Optional identifier provided by the data source to indicate the target object of this record. This may be an internal identifier and not necessarily map to a valid satellite number.

eventIdstring

Optional source-provided identifier for this collection event. This field can be used to associate records related to the same event.

esIdstring

Unique identifier of the parent Ephemeris Set, if this data is correlated with an Ephemeris. If reporting for a spacecraft with multiple onboard GNSS receivers, this ID may be associated with multiple GNSS Raw IF records if each receiver is synced to the ephemeris points.

receiverstring

The number or ID of the GNSS receiver associated with this data. If reporting for multiple receivers a separate record should be generated for each. If null, it is assumed to indicate that only one receiver is present, or reported.

boresightnumber[]

Unit vector of the outward facing direction of the receiver boresight in a body-fixed coordinate system.

quatnumber[]

The quaternion describing the rotation of the body-fixed frame used for this system into the local geodetic frame, at the sample start time (startTime). The array element order convention is scalar component first, followed by the three vector components. For a vector u in the body-fixed frame, the corresponding vector u' in the geodetic frame should satisfy u' = quq*, where q is this quaternion. The quaternion should be normalized to 1.

startIndexinteger

The index of the sample within the associated binary file that corresponds to the startTime indicated in this record. This is especially useful on high sample-rate sensors when some samples are less than one microsecond before the value of startTime. This index is 0-based. If null, the startIndex is assumed to be 0.

startTimestring date-time required

Start time of the data contained in the associated binary file, in ISO 8601 UTC format with microsecond precision.

endTimestring date-time required

End time of the data contained in the associated binary file, in ISO 8601 UTC format with microsecond precision.

startLatnumber double

WGS-84 spacecraft latitude sub-point at start time (startTime), represented as -90 to 90 degrees (negative values south of equator).

startLonnumber double

WGS-84 spacecraft longitude sub-point at start time (startTime), represented as -180 to 180 degrees (negative values west of Prime Meridian).

startAltnumber double

Spacecraft altitude at start time (startTime), expressed in kilometers above WGS-84 ellipsoid.

endLatnumber double

WGS-84 spacecraft latitude sub-point at end time (endTime), represented as -90 to 90 degrees (negative values south of equator).

endLonnumber double

WGS-84 spacecraft longitude sub-point at end time (endTime), represented as -180 to 180 degrees (negative values west of Prime Meridian).

endAltnumber double

Spacecraft altitude at end time (endTime), expressed in kilometers above WGS-84 ellipsoid.

centerFreqnumber[] required

The center frequency, in MHz, of the observation bands. More than one band may be reported in each binary file, so this is an array of the center frequency of each band (including an array of length 1 if only one band is present).

ifFreqnumber[]

The center frequency, in MHz, after downconversion to intermediate frequency. If provided, this array should have the same length as centerFreqs.

sampleRateinteger[]

The number of samples taken per second.

postFourierstring[]

After converting the raw data in the file, to generate (frequency-space) spectra some sets require an additional transformation or correction based on details of the hardware that recorded it. This field marks any such transformations. Currently supported options are NONE (no correction) and MIRRORED (frequency axis is flipped around the corresponding value of ifFreq). If null, it is assumed that NONE applies to all frequency bands.

sampleTypestring

The sample type associated with the IF data. REAL for data with only an I-component or COMPLEX for data with both I & Q components.

bitDepthinteger

The number of bits in each datum, for example 2 for 2-bit integers or 8 for 8-bit integers.

diffCodeBiasnumber[]

Differential Code Biases (DCBs) are the systematic errors, or biases, between two GNSS code observations at the same or different frequencies. If applicable, this field should contain an array of DBC with length equal to the number of frequencies in the binary file. The reference frequency should show DCB equal to 0. If null, it is assumed that there is no DCB (all values are 0).

dataRatenumber double

The amount of data generated per unit time, expressed in Megabytes/minute.

setIdstring

User-defined ID of a set or sequence of records/files. Used to associate a set of related raw IF records.

setLengthinteger

The number of raw IF records/files in a set.

sequenceIDinteger

The sequence number of a raw IF record/file within a set. Sequence number should start at 1. If null, then it is assumed that the order of records within a raw IF set is not relevant.

fileNamestring required

The file name of the Raw IF Binary file. The files should be in the Hierarchical Data Format (HDF5).

srcTypsstring[]

Array of UDL record types (GNSSSET) associated with this GNSSRawIF record. See the associated 'srcIds' array for the record UUIDs, positionally corresponding to the record types in this array. The 'srcTyps' and 'srcIds' arrays must match in size.

srcIdsstring[]

Array of UUIDs of the UDL data records associated with this GNSSRawIF record. See the associated 'srcTyps' array for the specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps' and 'srcIds' arrays must match in size. See the corresponding srcTyps array element for the data type of the UUID and use the appropriate API operation to retrieve that object (e.g. /udl/gnssobservationset/{uuid}).

fileSizeinteger

The binary file size, in bytes, auto-populated by the system. The maximum file size for this service is 5,000,000 Bytes (5 MB). Files exceeding the maximum size will be rejected.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourcestring required

Source of the data.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

{
  "id": "GNSSRawIF-ID",
  "classificationMarking": "U",
  "idOnOrbit": "32375",
  "satNo": 32375,
  "origObjectId": "L2045",
  "eventId": "2f2205c9-7bc2-4e1a-8416-2f80cc71f64b",
  "esId": "60f7a241-b7be-48d8-acf3-786670af53f9",
  "receiver": "GPS1",
  "boresight": [
    0,
    1,
    0
  ],
  "quat": [
    0,
    -0.2734104,
    0.1562345,
    0.9491246
  ],
  "startIndex": 2,
  "startTime": "2022-04-09T18:11:28.919768Z",
  "endTime": "2022-04-09T18:12:28.919768Z",
  "startLat": 38.834,
  "startLon": -104.821,
  "startAlt": 525.664,
  "endLat": 38.922,
  "endLon": -104.67,
  "endAlt": 525.626,
  "centerFreq": [
    1227.6,
    1575.4
  ],
  "ifFreq": [
    4.09,
    5.87
  ],
  "sampleRate": [
    8000,
    9000
  ],
  "postFourier": [
    "NONE",
    "NONE"
  ],
  "sampleType": "COMPLEX",
  "bitDepth": 8,
  "diffCodeBias": [
    0.0271,
    0.0016
  ],
  "dataRate": 0.205,
  "setId": "2b0b1b1a-a3c0-4267-894a-0c40cb84a5af",
  "setLength": 7,
  "sequenceID": 1,
  "fileName": "somefile.hdf5",
  "srcTyps": [
    "GNSSSET"
  ],
  "srcIds": [
    "GNSSSET_ID"
  ],
  "fileSize": 3168895,
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "origNetwork": "OPS1"
}

Changes

  • 173e4aff893fRevision changes
    • breaking

      the response property's minItems was decreased from 3 to 0 for the response status

    • breaking

      the response property's minItems was decreased from 4 to 0 for the response status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.