Access Services

Sensor Field of Regard Service

The Sensor Field of Regard service determines when one object is within the field of regard of a sensor on another object. The object being detected by the sensor is the "To" object, the object with the sensor on it is the "From" object. The field of regard is the entire area a sensor is capable of viewing, not necessarily the actual area it is currently viewing. The area it's currently viewing is called the field of view, and this service does not model that.

API Paths
access/sensorFOR/sgp4
access/sensorFOR/pointToPoint
access/sensorFOR/catalogObject
access/sensorFOR/simpleFlight
access/sensorFOR/greatArc
HTTP Method
POST

Call the specific Api path for the type of route your are using for the "To" object

Input Format
{
    "Start": "YYYY-MM-DDTHH:mm:ss",
    "Stop" : "YYYY-MM-DDTHH:mm:ss", 
    "ToObjectPath": {},
    "FromObjectCatalogPath":{},
    "SensorNameContains": "SensorIdentifyingString",
    "Sunlit": false,
    "IncludePath": true
}
Start
The analysis start date and time.
Stop
The analysis stop date and time.
ToObjectPath
The path definition for the object to be tracked.
FromObjectCatalogPath
The path definition for the catalog object that has a sensor.
SensorNameContains
A string representing the sensor name to use on the catalog object. This can be the entire sensor name, or a substring of the name. Optional, if this value is missing and the catalog object has multiple sensors, the first sensor listed will be used.
Sunlit
When true, the "To" object must be lit by the sun as well as being inside the sensor FOR for an access to be defined. Optional, the default is false.
IncludePath
If true, the results will include the path of the "To" and "From" objects, including sensor states for the "From" object during the times of access.

Notes: The "To" object path can be any of the following routes and is called by using the appropriate service route and route definition from the routing section.

The "From" object path must be a catalog object path. To determine the object URI to use, see the topic: Finding SDF Object URIs

Input Sample

Determines sensor FOR access times from the NOAA 16 satellite to the ISS (SSC# 25544).

{
    "Start": "2014-02-20T00:00:00",
    "Stop": "2014-02-21T00:00:00",
    "ToObjectPath": {
        "Start": "2014-02-20T00:00:00",
        "Stop": "2014-02-21T00:00:00",
        "SSC": 25544,
        "OutputSettings": {
            "Step": 2,
            "TimeFormat": "UTC",
            "CoordinateFormat": { "Coord": "LLA" }
        }
    },
    "FromObjectCatalogPath": {
        "Start": "2014-02-20T00:00:00",
        "Stop": "2014-02-21T00:00:00",
        "URI": "https://sdf10.agi.com/SocSearch/catalogs/spacecraft/items/bald7veoYUqyISdiy-KK6w/definition",
        "OutputSettings": {
            "Step": 2,
            "TimeFormat": "UTC",
            "CoordinateFormat": { "Coord": "LLA" }
        }
    },
    "SensorNameContains": "Noaa19_Avhrr3",
    "Sunlit": false,
    "IncludePath": true
}
Output Sample

Note that the "AccessStart" and "AccessStop" time formats, and all position data formats are determined by the "ToObjectPath" OutputSettings from the input POST data.

 [
    {   "AccessStart":"2/20/2014 12:54:20 AM",
        "AccessStop":"2/20/2014 12:54:27 AM",
        "FromObjectPath":[
        {   "Position":
            {   "Latitude":32.575899920422032,
                "Longitude":-174.7245725508246,
                "Altitude":708051.11613013363
            },
            "SensorStates":[
            {   "Orientation":
                {
                    "W":-0.01870381278808346,
                    "X":0.86888656548005661,
                    "Y":0.11440857368402434,
                    "Z":0.48124524099781707
                },
                "Name":"Aqua_Modis_Vis_Ir_FixedPt_FieldOfView"
            }],
            "Time":"2/20/2014 12:54:22 AM"
        },
        ...,],
        "ToObjectPath":[
        {   "Position":
            {   "Latitude":32.698304805824186,
                "Longitude":-174.26348281096077,
                "Altitude":423994.55107065145
            },
            "SensorStates":[],
            "Time":"2/20/2014 12:54:22 AM"
        },
        ...,]
    }
]

SatellitePasses

The satellite passes service determines when a satellite (or set of satellites) can be seen from a site, route or orbit. The service determines access to the satellite(s) and returns the access times, begin access and end access data such as azimuth, elevation and range as well as the maximum elevation and maximum visual magnitude data. The service can also return CZML, to allow for visualization in Cesium. The service also returns both the from object's route and the satellite's route if desired.

You can specify whether either object is lit by the sun or not, and whether the from object should have a minimum elevation angle constraint. Finally, you can specify whether line of sight access is used. If it is, the Earth will block access. If line of sight is not used, the Earth will be transparent to the objects.

API Paths
access/satellitePasses/site
access/satellitePasses/sgp4
access/satellitePasses/pointToPoint
access/satellitePasses/catalogObject
access/satellitePasses/raster
access/satellitePasses/tol
access/satellitePasses/simpleFlight
access/satellitePasses/greatArc
HTTP Method
POST
Input Format
{
    "Start":"YYYY-MM-DDTHH:mm:ss",
    "Stop":"YYYY-MM-DDTHH:mm:ss",
    "FromObjectPath":{},
    "SSCs":[],
    "FromObjectDark":true,
    "ToObjectLit":true,
    "UseMinElevation": true,
    "FromObjectMinElevation":10.0,
    "LineOfSight":true,
    "IncludePathData":false,
    "IncludePathCzml":false,
    "SatelliteOrbitColor": "AliceWhite",
    "PassLinkColor": "Magenta"
}
Start
The analysis start date and time.
Stop
The analysis stop date and time.
FromObjectPath
The path definition for the object from which the satellite will be observed.
SSCs
An array of integers representing the NORAD catalog numbers for the satellites to be observed.
FromObjectDark
When true, the from object must be in complete shadow for the access to be successful. Optional, the default is true.
ToObjectLit
When true, the satellite object(s) must be lit by the sun for an access to be successful. Optional, the default is true.
UseMinElevation
When true, the satellite object(s) must be above the minimum elevation angle in the from objects frame of reference, for an access to be successful. Optional, the default is true.
FromObjectMinElevation
The minimum elevation angle the satellite(s) must be above before an access will be successful. In degrees. Optional, the default is 10 degrees.
LineOfSight
When true, the to and from objects will have no access if the Earth obstructs the line of sight view between them. When false, the Earth will act as if it is transparent and access will always be defined for the objects Optional, the default is true.
IncludePathData
If true, the results will include the path of the "To" and "From" objects. Optional, the default is false.
IncludePathCzml
If true, the results will include the czml for visualization of the satellite's pass, and lines between the from and to objects when the to object is visible. Optional, the default is false.
SatelliteOrbitColor
Defines the color of the orbit for the satellite in the Czml. Optional, the default is AliceWhite.
PassLinkColor
Defines the color of the line connecting the "From" and "To" objects, when the "To" object is visible. Optional, the default is magenta.

Notes: The "From" object path must be a site or one of the following routes - use the route json definition as the value for "FromObjectPath" from the routing section.

Input Sample

Determines passes for the International Space Station (SSC# 25544) at a site. Note that the site must be dark and the satellite must be lit and have line of sight.

{
    "Start": "2014-08-19T00:00:00",
    "Stop": "2014-08-19T01:00:00",
    "FromObjectPath": {
        "Location": {
            "Latitude": 40.0012,
            "Longitude": -75.661,
            "Altitude": 19.0
        },
        "MeanSeaLevel": true,
        "OutputSettings": {
            "Step": 120,
            "TimeFormat": "UTC",
            "CoordinateFormat": { "Coord": "LLA" }
        }
    },
    "SSCs": [ 25544 ],
    "FromObjectDark": true,
    "ToObjectLit": true,
    "UseMinElevation": true,
    "FromObjectMinElevation": 10.0,
    "LineOfSight": true,
    "IncludePathData": true,
    "IncludePathCzml": true,
    "SatelliteOrbitColor": "Magenta",
    "PassLinkColor": "Green"
}
Output Sample

The output will contain an array of access information - one set for each access to each satellite specified in the SSCs list, and the Czml data if requested. Note that the time formats and all position data formats are determined by the "FromObjectPath" OutputSettings from the input POST data.

Azimuth, and elevation angles are in degrees. Ranges are in meters.

{
    "Passes": [   {
        "SSC": 25544,
        "MaximumElevationData":       {
            "Azimuth": 16.25470298003805,
            "Elevation": 15.615625409016445,
            "Range": 1196895.025083329,
            "Time": "2014-08-19T00:24:20.8315314Z"
        },
        "AccessBeginData":       {
            "Azimuth": 336.7369770184381,
            "Elevation": 10.000002090233536,
            "Range": 1494197.1392559265,
            "Time": "2014-08-19T00:22:13.1839797Z"
        },
        "AccessEndData": {
            "Azimuth": 55.762127717318535,
            "Elevation": 10.000002039680753,
            "Range": 1494049.3193905503,
            "Time": "2014-08-19T00:26:28.4329896Z"
        },
        "MaxMagnitude": -2.8940193877474085,
        "AccessStart": "2014-08-19T00:22:13.1839797Z",
        "AccessStop": "2014-08-19T00:26:28.4329896Z",
        "FromObjectPath":       [
            {
                "Position":             {
                    "Latitude": 40.0012,
                    "Longitude": -75.661,
                    "Altitude": 18.999999999161165
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:22:13.1839797Z"
            },
            {
                "Position":             {
                    "Latitude": 40.0012,
                    "Longitude": -75.661,
                    "Altitude": 18.999999999161165
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:24:13.1839797Z"
            },
            {
                "Position":             {
                    "Latitude": 40.0012,
                    "Longitude": -75.661,
                    "Altitude": 18.999999999161165
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:26:13.1839797Z"
            },
            {
                "Position":             {
                    "Latitude": 40.0012,
                    "Longitude": -75.661,
                    "Altitude": 18.999999999161165
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:26:28.4329896Z"
            }
        ],
        "ToObjectPath":       [
            {
                "Position":             {
                    "Latitude": 51.266938490564634,
                    "Longitude": -83.49793779512073,
                    "Altitude": 420829.700468499
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:22:13.1839797Z"
            },
            {
                "Position":             {
                    "Latitude": 49.473533754574646,
                    "Longitude": -72.18163079193627,
                    "Altitude": 420802.75451428536
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:24:13.1839797Z"
            },
            {
                "Position":             {
                    "Latitude": 46.57437361031208,
                    "Longitude": -61.93640695777328,
                    "Altitude": 420547.07117421
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:26:13.1839797Z"
            },
            {
                "Position":             {
                    "Latitude": 46.13719096796,
                    "Longitude": -60.72277203850247,
                    "Altitude": 420500.7261726514
                },
                "SensorStates": [],
                "Time": "2014-08-19T00:26:28.4329896Z"
            }
        ]
    }],
    "CzmlForPasses": "[{\"id\":\"document\",\"name\":\"SatellitePasses\",\"description\":\"Satellite pass data\",\"version\":\"1.0\",\"clock\":{\"interval\":\"20140819T002213.183979654008Z/20140819T01Z\"}},{\"id\":\"33bee15c-5443-4f02-9526-32878385b9aa\",\"name\":\"25544\",\"description\":[{\"interval\":\"00010101T00Z/20140819T002213.183979654008Z\",\"string\":\"25544\"},{\"interval\":\"20140819T002213.183979654008Z/20140819T002628.4329896015333Z\",\"string\":\"[2456888:44568.183979654 TAI (8/19/2014 12:22:13 AM), 2456888:44823.4329896015 TAI (8/19/2014 12:26:28 AM)] - Max Elevation: 15.6, Max Magnitude: -2.89, Start Azimuth: 336.7, Stop Azimuth: 55.8\"},{\"interval\":\"20140819T002628.4329896015333Z/99991231T235959.9999999Z\",\"string\":\"[2456888:44568.183979654 TAI (8/19/2014 12:22:13 AM), 2456888:44823.4329896015 TAI (8/19/2014 12:26:28 AM)] - Max Elevation: 15.6, Max Magnitude: -2.89, Start Azimuth: 336.7, Stop Azimuth: 55.8\"}],\"label\":{\"show\":[{\"interval\":\"00010101T00Z/20140819T002213.183979654008Z\",\"boolean\":false},{\"interval\":\"20140819T002213.183979654008Z/20140819T002628.4329896015333Z\",\"boolean\":true},{\"interval\":\"20140819T002628.4329896015333Z/99991231T235959.9999999Z\",\"boolean\":false}],\"text\":\"25544\",\"scale\":0.5,\"eyeOffset\":{\"cartesian\":[1e3,1e3,0]},\"fillColor\":{\"rgba\":[255,255,255,255]}},\"path\":{\"show\":[{\"interval\":\"00010101T00Z/20140819T002213.183979654008Z\",\"boolean\":false},{\"interval\":\"20140819T002213.183979654008Z/20140819T002628.4329896015333Z\",\"boolean\":true},{\"interval\":\"20140819T002628.4329896015333Z/99991231T235959.9999999Z\",\"boolean\":false}],\"width\":15,\"leadTime\":[{\"interval\":\"00010101T00Z/20140819T002213.183979654008Z\",\"epoch\":\"00010101T00Z\",\"number\":[0,-185330312019431.8,-185330312019431.8,0]},{\"interval\":\"20140819T002213.183979654008Z/20140819T002628.4329896015333Z\",\"epoch\":\"20140819T002213.183979654008Z\",\"number\":[0,255.24900994752534,255.24900994752534,0]},{\"interval\":\"20140819T002628.4329896015333Z/99991231T235959.9999999Z\",\"epoch\":\"20140819T002628.4329896015333Z\",\"number\":[0,185330311932776.56,185330311932776.56,0]}],\"trailTime\":[{\"interval\":\"00010101T00Z/20140819T002213.183979654008Z\",\"epoch\":\"00010101T00Z\",\"number\":[0,0,-185330312019431.8,-185330312019431.8]},{\"interval\":\"20140819T002213.183979654008Z/20140819T002628.4329896015333Z\",\"epoch\":\"20140819T002213.183979654008Z\",\"number\":[0,0,255.24900994752534,255.24900994752534]},{\"interval\":\"20140819T002628.4329896015333Z/99991231T235959.9999999Z\",\"epoch\":\"20140819T002628.4329896015333Z\",\"number\":[0,0,185330311932776.56,185330311932776.56]}],\"material\":{\"polylineGlow\":{\"color\":{\"rgba\":[255,0,255,255]},\"glowPower\":0.12}}},\"point\":{\"pixelSize\":5,\"color\":{\"rgba\":[255,165,0,255]},\"outlineColor\":{\"rgba\":[255,255,255,255]},\"outlineWidth\":1},\"position\":{\"interpolationAlgorithm\":\"LAGRANGE\",\"interpolationDegree\":5,\"epoch\":\"20140819T00Z\",\"cartesian\":[0,-6660143.387078423,-891892.2140120179,984810.210737291,60,-6559687.931609882,-1139779.2638236391,1336784.3662783727,120,-6431428.005903053,-1383462.1533605852,1682610.9224435408,180,-6275906.593846317,-1622068.56244369,2020698.9491480421,240,-6093784.744598343,-1854744.1920447568,2349493.208647502,300,-5885838.607727646,-2080655.7489335784,2667481.457630584,360,-5652955.936500471,-2298993.8445389587,2973201.5259957383,420,-5396132.081932552,-2508975.796831224,3265248.135727583,480,-5116465.503141667,-2709848.325146504,3542279.425851246,540,-4815152.822007042,-2900890.1290522492,3803023.1522426433,600,-4493483.45214018,-3081414.34355768,4046282.5340308286,660,-4152833.833693605,-3250770.8641672656,4270941.72137368,720,-3794661.3065940654,-3408348.5364216496,4475970.862443199,780,-3420497.6554109417,-3553577.2056362657,4660430.750453897,840,-3031942.3593026283,-3685929.6235040873,4823477.034444656,900,-2630655.580378372,-3804923.2090508495,4964363.980227925,960,-2218350.923425398,-3910121.6621045005,5082447.770413473,1020,-1796787.9993859867,-4001136.427943906,5177189.334658421,1080,-1367764.8242283778,-4077628.0121451523,5248156.7033039145,1140,-933110.0840561066,-4139307.1448263247,5295026.879303506,1200,-494675.29665346,-4185935.7935034675,5317587.2248445675,1260,-54326.898786603706,-4217328.023705471,5315736.360401471,1320,386061.71183085814,-4233350.706252045,5289484.575069429,1380,824618.151486024,-4233924.06982254,5238953.748063769,1440,1259479.0141033176,-4219022.097094885,5164376.782221449,1500,1688797.7953639599,-4188672.762374287,5066096.551291805,1560,2110752.748929072,-4142958.1082896227,4944564.363803019,1620,2523554.6460396834,-4082014.158847011,4800337.947393937,1680,2925454.4092823546,-4006030.6659271,4634078.958754714,1740,3314750.590732109,-3915250.686224913,4446550.025762482,1800,3689796.6640770435,-3809969.9856833844,4238611.330056565,1860,4049008.0997479055,-3690536.2686838773,4011216.7401870443,1920,4390869.191598671,-3557348.2296412396,3765409.507589483,1980,4713939.603370725,-3410854.425214396,3502317.5399764646,2040,5016860.603096592,-3251551.9660845557,3223148.2692649984,2100,5298360.953817589,-3079985.0281627327,2929183.1338386238,2160,5557262.429554862,-2896743.184152291,2621771.697725459,2220,5792484.926428277,-2702459.5575870555,2302325.432098346,2280,6003051.14019001,-2497808.8027645634,1972311.187305615,2340,6188090.78324339,-2283504.915364466,1633244.3863528895,2400,6346844.316453245,-2060298.8799477567,1286681.9733058126,2460,6478666.173703839,-1828976.1619367271,934215.152405091,2520,6583027.460196124,-1590354.0530380888,577461.9557119207,2580,6659518.108850851,-1345278.8803572147,218059.6787803909,2640,6707848.482844074,-1094623.0906229387,-142342.77486713577,2700,6727850.416178355,-839282.2219689172,-502092.5988409798,2760,6719477.688213377,-580171.7765732231,-859540.796555078,2820,6682805.932163729,-318224.0081203561,-1213049.859548967,2880,6618031.981637637,-54384.63850569446,-1561001.370099702,2940,6525472.663256582,210390.48155447072,-1901803.4877752026,3e3,6405563.047183926,475138.75331833377,-2233898.2810254428,3060,6258854.170928761,738894.2377061949,-2555768.866736932,3120,6086010.255013445,1000691.0757419422,-2865946.322852164,3180,5887805.431948245,1259566.9081520538,-3163016.3416081057,3240,5665120.012401158,1514566.2812167397,-3445625.5936206286,3300,5418936.314456213,1764744.0267767187,-3712487.775863938,3360,5150334.083409517,2009168.6051869213,-3962389.3194904625,3420,4860485.530655051,2246925.400947072,-4194194.7363434494,3480,4550650.020881804,2477119.9616855867,-4406851.5858592745,3540,4222168.437066851,2698881.1720948727,-4599395.046779902,3600,3876457.252647961,2911364.355277822,-4770952.080644206]}},{\"id\":\"a62b1235-9b8c-497d-a116-e00873e36ac5\",\"name\":\"25544\",\"path\":{\"width\":1,\"leadTime\":2786.946092109482,\"trailTime\":2786.946092109482,\"material\":{\"solidColor\":{\"color\":{\"rgba\":[255,0,255,255]}}}},\"position\":{\"reference\":\"33bee15c-5443-4f02-9526-32878385b9aa#position\"}},{\"id\":\"be4a65ce-0416-45cb-be31-4e7a16daffb5\",\"label\":{\"text\":\"Observer\",\"scale\":0.5,\"eyeOffset\":{\"cartesian\":[1e3,1e3,0]},\"fillColor\":{\"rgba\":[255,255,255,255]}},\"point\":{\"pixelSize\":5,\"color\":{\"rgba\":[255,165,0,255]},\"outlineColor\":{\"rgba\":[255,255,255,255]},\"outlineWidth\":1},\"position\":{\"cartesian\":[1211703.231519745,-4740218.061844451,4078099.853539437]}},{\"id\":\"ae102da1-eda6-47bb-9124-5ccc0c8f06f9\",\"polyline\":{\"show\":[{\"interval\":\"00010101T00Z/20140819T002213.183979654008Z\",\"boolean\":false},{\"interval\":\"20140819T002213.183979654008Z/20140819T002628.4329896015333Z\",\"boolean\":true},{\"interval\":\"20140819T002628.4329896015333Z/99991231T235959.9999999Z\",\"boolean\":false}],\"material\":{\"solidColor\":{\"color\":{\"rgba\":[0,128,0,255]}}},\"followSurface\":false,\"positions\":{\"references\":[\"be4a65ce-0416-45cb-be31-4e7a16daffb5#position\",\"33bee15c-5443-4f02-9526-32878385b9aa#position\"]}}}]"
}