Satellite - Zudokakikuto/OreCZML GitHub Wiki

This page describes the content of a CZML document. Please read Get Started for an explanation of how a CZML document is put together.

Satellite

Implements : CzmlPrimaryObject

Extends : AbstractPrimaryObject

Example :

{
    "id":"Keplerian parameters: {a: 6928000.0; e: 0.0; i: 60.00000000000001; pa: 0.0; raan: 90.0; v: 90.0;}",
    "name":"Keplerian parameters: {a: 6928000.0; e: 0.0; i: 60.00000000000001; pa: 0.0; raan: 90.0; v: 90.0;}",
    "availability":"2022-01-17T12:00:00Z/2022-01-17T13:00:00Z",
    "model":{
      "gltf":"ISSModel",
      "maximumScale":50,
      "minimumPixelSize":1000
    },
    "path":{
      "leadTime":5738.822587839273,
      "trailTime":0,
      "show":{
        "interval":"2022-01-17T12:00:00Z/2022-01-17T13:00:00Z",
        "boolean":true
      }
    },
    "position":{
      "referenceFrame":"INERTIAL",
      "interpolationAlgorithm":"LAGRANGE",
      "interpolationDegree":5,
      "epoch":"2022-01-17T11:59:23Z",
      "cartesian":[
        0,-3463999.999999999,6.363264768369647E-10,5999823.997418592,
        59.99999642372131,-3456556.6110589514,-454783.7843238465,5986896.223534279,
        119.99999284744263,-3434258.2503375425,-907613.0553118477,5948168.3067708695,
        179.99998927116394,-3397200.2463129726,-1356541.546323172,5883806.280417567,
        239.99998569488525,-3345541.0803698357,-1799639.4862701523,5794086.156107276,
        299.99998211860657,-3279501.48286487,-2235001.311321466,5679392.357118379,
        360.0000187754631,-3199364.3599400264,-2660755.28975776,5540217.574809867,
        420.0000151991844,-3105473.0938697974,-3075070.690747029,5377159.817215904,
        480.00001162290573,-2998228.7656856813,-3476163.073247136,5190917.600664611,
        540.000008046627,-2878090.4159922292,-3862305.367341485,4982290.357338924,
        600.0000044703484,-2745573.7373189074,-4231836.334130604,4752176.132118416,
        660.0000008940697,-2601248.4969098005,-4583166.919310921,4501567.085146425,
        719.999997317791,-2445735.195655377,-4914785.395180958,4231543.672372354,
        779.9999937415123,-2279701.468870889,-5225262.185814307,3943268.3763197497,
        839.9999901652336,-2103858.734625649,-5513255.270139358,3637979.8593301484,
        899.9999865889549,-1918959.5953276078,-5777517.057665825,3316988.411532888,
        959.9999830126762,-1725796.4982677016,-6016903.631597228,2981673.5657913694,
        1020.0000196695328,-1525202.1608281932,-6230387.254069935,2633484.751875626,
        1080.000016093254,-1318047.1873022772,-6417061.864060664,2273937.125864904,
        1140.0000125169754,-1105219.2229949944,-6576116.125619398,1904575.6103173683,
        1200.0000089406967,-887633.649847874,-6706865.376658259,1526993.2181149346,
        1260.000005364418,-666227.2297174472,-6808745.019758189,1142820.037262523,
        1320.0000017881393,-441953.14440657484,-6881317.368148394,753714.5714144624,
        1379.9999982118607,-215776.7633945657,-6924275.485016568,361356.3434465053,
        1439.999994635582,11328.565540709405,-6937443.414012461,-32561.452282619484,
        1499.9999910593033,238385.725297091,-6920774.175169542,-426339.29145938455,
        1559.9999874830246,464418.0605073841,-6874346.900469502,-818278.6976130626,
        1619.999983906746,688453.6531719184,-6798364.483274397,-1206689.698661745,
        1679.9999803304672,909529.6653528904,-6693153.115851097,-1589898.4046863173,
        1740.0000169873238,1126696.771419073,-6559165.089212914,-1966254.7494119718,
        1800.000013411045,1339023.7023291306,-6396986.2295030365,-2334140.4378761835,
        1860.0000098347664,1545601.6635249786,-6207346.339894716,-2691976.6812753743,
        1920.0000062584877,1745545.4364589127,-5991068.647391364,-3038225.9725290244,
        1980.000002682209,1938000.286614801,-5749085.38833288,-3371404.145378838,
        2039.9999991059303,2122142.9094918114,-5482443.458171181,-3690082.1131983344,
        2099.9999955296516,2297186.311500172,-5192294.57854129,-3992894.3122195746,
        2159.999991953373,2462384.420959475,-4879892.495694187,-4278546.700849375,
        2219.9999883770943,2617035.132578389,-4546587.349799374,-4545822.043167083,
        2279.9999848008156,2760482.308768364,-4193818.1707796366,-4793583.383404223,
        2339.999981224537,2892117.261144135,-3823104.456340149,-5020776.618206656,
        2400.0000178813934,3011380.2355634435,-3436037.7878548163,-5226433.073479299,
        2460.0000143051147,3117762.4240588117,-3034274.439771822,-5409672.992614204,
        2520.000010728836,3210809.0270139435,-2619529.9382010554,-5569710.842902124,
        2580.0000071525574,3290123.8889374477,-2193576.524345698,-5705863.346928192,
        2640.0000035762787,3355376.231186432,-1758244.4784405536,-5817561.145752002,
        2700,3406298.572581554,-1315410.9625863053,-5904345.206205499,
        2759.9999964237213,3442669.7729331525,-866958.3509757448,-5965837.504928482,
        2819.9999928474426,3464335.966638904,-414802.1772992195,-6001777.23116278,
        2879.999989271164,3471204.0378082786,39125.58017907634,-6012009.455101907,
        2939.9999856948853,3463244.3645685646,492885.9996080406,-5996489.874942439,
        2999.9999821186066,3440491.68335029,944541.4277068141,-5955286.284851932,
        3060.000018775463,3403044.300433584,1392163.1815874027,-5888577.163988474,
        3120.0000151991844,3351062.324190827,1833838.977062287,-5796648.55984117,
        3180.0000116229057,3284765.5914608994,2267680.320257103,-5679890.439160748,
        3240.000008046627,3204431.961490398,2691830.0993474913,-5538793.679749699,
        3300.0000044703484,3110396.6508771013,3104470.613240448,-5373948.876381026,
        3360.0000008940697,3003053.2829510155,3503832.274019645,-5186048.134115027,
        3419.999997317791,2882857.3250283934,3888203.2199742994,-4975891.022283279,
        3479.9999937415123,2750330.771994138,4255939.214680321,-4744392.701319578,
        3539.9999901652336,2606035.097401363,4605458.759616099,-4492536.776757894,
        3599.999986588955,2450579.6474478683,4935255.937448852,-4221389.865898903
      ]
    }

Properties

id - String : Identification of the satellite

name - String : Name of the satellite, default : "Satellite".

availability - TimeInterval : Time interval when the satellite is displayed.

description - String : An optional description of the satellite, default : "A satellite".

model - CzmlModel : An optional 3D model of the satellite, default : A 2D image representing a satellite will be used.

Intrinsinc arguments

These arguments can be used to build a satellite object :

Ephemeris - List of TimeStampedPVCoordinates : Lines of ephemerides from an oem file.

Frame - Frame : An Orekit frame

SpacecraftStateListInput - List of SpacecraftState : An orekit list of SpacecraftState

Other parameters

period - double : The period of the satellite in its orbit.

timePosition - TimePosition : An object specified for the satellite that contains for example the reference frame used or the position in time of the satellite in the given frame.

timeList - List of Double : This list contains all the double that separate the initial julian date to the current date.

absoluteDateList - List of AbsoluteDate : This list contains all the Orekit absoluteDate objects that represents the different instants when the simulations takes place.

Orientation - Orientation** : The orientation object, defines the orientation in time of the satellite.

cartesianArraylist - List of Cartesian : This list contains all the Cartesian objects that defines the position in time of the satellite in the ITRF.

orbits - List of Orbit : This list contains all the orbits computed of the satellite, for the duration of the simulation.

Billboard - Billboard : A 2D object that allows to display a given image to represents the satellite. default : A 2D image representing a satellite will be used.

positionList - List of Position : The list of all the position packet objects, they defined the position of the satellite in time, this object is used for writing in the czml file.

(To be deleted) boundedPropagator - BoundedPropagator : The bounded propagator object of the satellite used for the propagation.

propagator - Propagator : The propagator used for the propagation of the satellite.

attitudes - List of Attitude : The list of all the Orekit Attitude objects. They represents the orientation in the local orbital frame of the satellite.

SatelliteReferenceSystem - [SatelliteReferenceSystem] : The primary object defining the reference system of the satellite, it loads a 3D model for display.

allSpaceCraftStates - List of SpacecraftState : This list contains all the SpacecraftState computed during the propagation.

color - Color : The color of the orbit.

Build

The satellite object can be build with :

Satellite satellite = new Satellite(file, color);
  • An Oem, a path to a 3D model (String) :
Satellite satellite = new Satellite(file, model3DPath);
  • An Oem, a path to a 3D model (String), a Color :
Satellite satellite = new Satellite(file, model3DPath, color);

Satellite satellite = new Satellite(tle);

Satellite satellite = new Satellite(tle, color);
  • A TLE, a path to a 3D model (String):
Satellite satellite = new Satellite(tle, model3DPath);
  • A TLE, a path to a 3D model (String), a Color :
Satellite satellite = new Satellite(tle, model3DPath, color);

Satellite satellite = new Satellite(availability, ephemeris, frame);

Satellite satellite = new Satellite(name, availability, description, ephemeris, frame);

Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, color);

Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, model3DPath);

Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, model3DPath, color);

Satellite satellite = new Satellite(orbit);

Satellite satellite = new Satellite(orbit, color);
  • An Orbit, a path to a 3D model (String):
Satellite satellite = new Satellite(orbit, model3DPath);
  • An Orbit, a path to a 3D model (String), a Color :
Satellite satellite = new Satellite(orbit, model3DPath, color);

Satellite satellite = new Satellite(spacecraftStateList);

Satellite satellite = new Satellite(spacecraftStateList, color);

Satellite satellite = new Satellite(spacecraftStateList, model3DPath);

Satellite satellite = new Satellite(spacecraftStateList, model3DPath, color);

Satellite satellite = new Satellite(propagator, finalDate, color);

Satellite satellite = new Satellite(propagator, finalDate, model3DPath);

Satellite satellite = new Satellite(propagator, finalDate, model3DPath, color);

Functions

displayOnlyOnePeriod() - void : Displays only one period of the satellite at a time during the simulation, for a clearer visual.

displaySatelliteAttitude - void : Displays the attitude of the satellite in time.

displaySatelliteReferenceSystem - void : Displays the orbital reference system of the satellite.