OrbPro2 a Cesium distribution

Analysis

engine/Source/Core/Analysis.js 41

Methods

static Cesium.Analysis.addAccessLines(viewer, from, to, id, material, options) → string
engine/Source/Core/Analysis.js 3903

Name Type Default Description
viewer Object The viewer instance.
from Entity | Array.<Entity> The starting entity or array of starting entities.
to Entity | Array.<Entity> The ending entity or array of ending entities.
id string Date.now().toString() optional The id for the group of lines.
material Material optional An optional custom material. Defaults to lime green if not provided.
options object optional Options for sensor-aware access.
Name Type Default Description
sensor Sensor optional If provided, use sensor FOV + body occlusion.
terrainOcclusion boolean false optional Include terrain occlusion check.
Returns:
- The id of the created access line group.

static Cesium.Analysis.addCoverageLayer(viewer, coverageResult, options) → object
engine/Source/Core/Analysis.js 6140

Adds an analytical coverage overlay to a viewer.
Name Type Description
viewer Viewer Viewer that will own the imagery layer.
coverageResult object Result returned by `computeAnalyticalCoverage()`.
options object optional Overlay styling options.
Returns:
Overlay controller.

static Cesium.Analysis.addReferenceGridLayer(viewer, options) → ImageryLayer
engine/Source/Core/Analysis.js 5627

Adds a generated reference-grid imagery layer to a viewer.
Name Type Description
viewer Viewer The viewer that will own the grid layer.
options ReferenceGridImageryProvider | ReferenceGridImageryProvider.ConstructorOptions optional Either an existing provider instance or constructor options.
Returns:
The added imagery layer.

static Cesium.Analysis.addSwathEntity(target, swathOrCallback, options) → Entity
engine/Source/Core/Analysis.js 5833

Adds a swath polygon entity to a viewer or entity collection.
Name Type Description
target Viewer | EntityCollection Viewer or entity collection that will own the entity.
swathOrCallback object | Array.<object> | function Swath result, segment array, or callback returning one.
options object optional Entity options.
Returns:
The added entity.

static Cesium.Analysis.azEl2RaDec(azDeg, elDeg, latDeg, lonDeg, julianDate, useNoonEpoch) → Object
engine/Source/Core/Analysis.js 3757

Name Type Default Description
azDeg number Azimuth (clockwise from north) [degrees].
elDeg number Elevation above horizon [degrees].
latDeg number WGS84 latitude [degrees].
lonDeg number WGS84 longitude [degrees], east positive.
julianDate Object UT1-based Julian Date object.
useNoonEpoch boolean true optional Use Vallado's noon-based GMST offsets if true.
Returns:
Right ascension and declination [degrees].

static Cesium.Analysis.azimuthElevationMaskToSensorDirections(mask) → Array.<Spherical>
engine/Source/Core/Analysis.js 6704

Name Type Description
mask object The published mask.
Name Type Default Description
minimumAzimuth number Azimuth of the first boundary, degrees clockwise from north.
maximumAzimuth number Azimuth of the last boundary, degrees clockwise from north.
minimumElevation number Lower elevation edge, degrees above the horizon.
maximumElevation number Upper elevation edge, degrees above the horizon.
azimuthStep number 2.0 optional Sampling step along the azimuth edges, degrees.
Returns:
Boundary directions for `customSensor.directions`.
Example:
// Cape Cod's PAVE PAWS: two faces, 347 through north to 227, 3 to 85 up.
const directions = Cesium.Analysis.azimuthElevationMaskToSensorDirections({
  minimumAzimuth: 347,
  maximumAzimuth: 227,
  minimumElevation: 3,
  maximumElevation: 85,
});

static Cesium.Analysis.buildBoundingBoxCandidateSql(bbox, options) → string
engine/Source/Core/Analysis.js 2381

Name Type Description
bbox Rectangle Bounding rectangle in RADIANS (Analysis convention).
options object Options.
Name Type Default Description
table string Catalog table name (required).
mode string 'rtree' optional `'rtree'` | `'bboxColumns'`.
units string 'degrees' optional Output coordinate units.
minLatColumn string optional bbox mode: min-latitude column.
maxLatColumn string optional bbox mode: max-latitude column.
minLonColumn string optional bbox mode: min-longitude column.
maxLonColumn string optional bbox mode: max-longitude column.
heightColumns object optional `{ floorColumn, ceilingColumn }` — optional height-overlap predicates (the R-Tree shadow table has no height dimension).
heightRange object optional `{ minHeight, maxHeight }` — resolved vertical extent (see Analysis.resolveRegionHeightRange); only applied when `heightColumns` is given.
Returns:
Candidate-selecting SELECT statement.

static Cesium.Analysis.buildSwathPolygonHierarchy(swath, options) → PolygonHierarchy|Array.<PolygonHierarchy>
engine/Source/Core/Analysis.js 5817

Alias for `createSwathPolygonHierarchy()` for callers that prefer an explicit builder-style name.
Name Type Description
swath object | Array.<object> Swath result returned by `computeSwath()` or a raw segment array.
options object optional Optional hierarchy options.
Returns:
Polygon hierarchy describing the swath boundary.

static Cesium.Analysis.calculateAccess(fromEntity, toEntity, timestamp, ellipsoid) → boolean
engine/Source/Core/Analysis.js 3512

Name Type Default Description
fromEntity Object The source entity with a position property.
toEntity Object The target entity with a position property.
timestamp JulianDate The time at which to compute access.
ellipsoid Ellipsoid Ellipsoid.WGS84 optional The ellipsoid to use for occlusion calculations.
Returns:
- True if the entities have line-of-sight access, false otherwise.

static Cesium.Analysis.calculateItuLinkBudget(options) → object
engine/Source/Core/Analysis.js 6491

Evaluates a pluggable ITU propagation provider and passes its named loss terms to a CommsPlugin link-budget port. No RF equation executes here. The provider must expose synchronous `calculateLossTerms(request, context)`. Its return value is merged into `linkBudgetRequest.lossTerms`, with the provider taking precedence over same-named caller placeholders. The CommsPlugin consumer owns interpretation and the rf-link-budget WASM kernel owns numeric composition.
Name Type Description
options object Consumer wiring options.
Name Type Description
comms object CommsPlugin-compatible link-budget port.
lossProvider object Pluggable closed-kernel provider.
propagationRequest object optional Provider inputs.
linkBudgetRequest object optional Base CommsPlugin request.
context object optional Optional host geometry/epoch context.
Returns:
CommsPlugin link-budget result.

static Cesium.Analysis.calculateSensorAccess(sensor, targetEntity, time, options) → boolean
engine/Source/Core/Analysis.js 4134

Name Type Description
sensor Sensor The sensor primitive (or any object with containsPoint/hasAccess).
targetEntity Entity The target entity with a position property.
time JulianDate The time to evaluate.
options object optional Options.
Name Type Default Description
bodyOcclusion boolean true optional Check Earth body occlusion.
terrainOcclusion boolean false optional Check terrain occlusion (expensive).
ellipsoid Ellipsoid Ellipsoid.WGS84 optional Ellipsoid for body occlusion.
Returns:
True if the sensor has access to the target.

static Cesium.Analysis.classifyPointsInRegions(regions, packedPositions, context) → object
engine/Source/Core/Analysis.js 2294

Name Type Description
regions Array.<object> Region descriptors.
packedPositions Float64Array | Array.<number> Packed XYZ triples in ECEF.
context object optional Evaluation context (sensor access, etc.).
Returns:
`{ flags, perRegionCounts, insideCount }`.

static Cesium.Analysis.classifyRegionIntersection(leftRegion, rightRegion, context) → object
engine/Source/Core/Analysis.js 1905

Name Type Description
leftRegion object Left region descriptor.
rightRegion object Right region descriptor.
context object optional Evaluation context.
Returns:
Intersection classification.

static Cesium.Analysis.computeAnalyticalCoverage(options) → Promise.<object>
engine/Source/Core/Analysis.js 6633

Runs one-shot analytical ground coverage from explicit footprint polygons.
Name Type Description
options object Analytical coverage request.
Name Type Default Description
grid object Coverage grid configuration.
footprints Array.<object> optional Explicit footprint polygons to accumulate.
states Array.<object> optional Optional ordered state vectors for swath-driven accumulation.
sensorConfig object optional Optional swath sensor configuration used with `states`.
fomType string optional Optional FOM name to compute.
heatmap object optional Optional heatmap request `{ fomType, colorMap, width, height, minValue, maxValue }`.
union object optional Optional union request `{ sensorIds }`.
minimumSensorSet object | boolean optional Optional greedy set-cover request. When truthy, computes a selected sensor subset for the accumulated grid.
includeGridData boolean false optional Whether to return raw cell records.
pluginOptions object optional Coverage plugin load options.
swathOptions object optional Optional options forwarded to `accumulateSwath`.
Returns:
Coverage grid info plus optional statistics, cells, FOM, heatmap, and union outputs.

static Cesium.Analysis.computeGMST(julianDate, unit, useNoonEpoch) → number
engine/Source/Core/Analysis.js 3644

Name Type Default Description
julianDate Object An object with two properties:
unit string 'seconds' optional The unit for the returned GMST. Valid options: - `"seconds"`: Returns GMST in [0, 86400). - `"degrees"`: Returns GMST in [0, 360).
useNoonEpoch boolean false optional Whether to use the noon-based epoch.
Returns:
GMST in the specified unit.
Properties:
Name Type Description
dayNumber number The integer Julian day (often at midnight).
secondsOfDay number The number of seconds past `dayNumber`.

static Cesium.Analysis.computeGroundStationAccessGeometry(options) → Promise.<object>
engine/Source/Core/Analysis.js 6528

Computes instantaneous ground-station access geometry for one sampled state.
Name Type Description
options object Access request `{ state, groundStations, stationId?, accessOptions?, pluginOptions? }`.
Returns:
Access geometry for the requested station.

static Cesium.Analysis.computeGroundStationAccessWindows(options) → Promise.<object>
engine/Source/Core/Analysis.js 6502

Computes ground-station access windows from sampled state vectors.
Name Type Description
options object Access request `{ states, groundStations, stationId?, stationIds?, accessOptions?, pluginOptions? }`.
Returns:
Access windows plus equivalent `TimeInterval` records.

static Cesium.Analysis.computeLST(julianDate, longitudeDegrees, unit, useNoonEpoch) → number
engine/Source/Core/Analysis.js 3709

Name Type Default Description
julianDate Object An object with two properties:
longitudeDegrees number The observer's longitude in degrees (east positive).
unit string 'seconds' optional The unit of measure for the returned LST. Valid options: - `"seconds"`: Returns LST in the range [0, 86400). - `"degrees"`: Returns LST in the range [0, 360).
useNoonEpoch boolean false optional Whether to use the noon-based epoch for GMST calculations.
Returns:
LST in the specified unit.
Properties:
Name Type Description
dayNumber number The integer Julian day (often at midnight).
secondsOfDay number The number of seconds past `dayNumber`.

static Cesium.Analysis.computeRegionCrossings(regions, positionProvider, options) → object
engine/Source/Core/Analysis.js 3338

Name Type Description
regions object | Array.<object> Region descriptor(s).
positionProvider function | object `(JulianDate) => Cartesian3` or `{ getValue(JulianDate) => Cartesian3 }`.
options object optional Options.
Name Type Default Description
start JulianDate Timeline start (required).
stop JulianDate Timeline stop (required).
stepSeconds number 10 optional Sampling step.
hysteresisSamples number 3 optional Consecutive samples required to confirm a state flip; sub-threshold dips are ignored.
bisectionIterations number 24 optional Max bisection steps per crossing (step `(stop-start)/(2^n)` seconds).
toleranceSeconds number 1e-3 optional Bisection convergence.
batchSize number 256 optional Samples per WASM classify batch.
context object optional Evaluation context passed through.
Returns:
`{ events, perRegion }` — `events` sorted by time with `kind: 'entry'|'exit'`, `regionIndex`, `time`; `perRegion` carries `entries`, `exits` (JulianDate arrays) and `intervals` (TimeInterval[]).

static Cesium.Analysis.computeRfAnalysisChain(options) → Promise.<object>
engine/Source/Core/Analysis.js 4651

Evaluates a time-ordered RF analysis chain. The caller supplies geometry and link requests for each epoch; all RF and interference physics are routed through the injected communications port.
Name Type Description
options object Chain options accepted by RfInterferenceAnalysis#analyzeChainAsync plus `comms`.
Returns:
Ordered epoch results.

static Cesium.Analysis.computeRfCoverage(options) → Promise.<object>
engine/Source/Core/Analysis.js 4569

Name Type Description
options object Analysis options passed to RfTerrainAnalysis.
Returns:
Coverage result.

static Cesium.Analysis.computeRfDownlinkFootprint(options) → object
engine/Source/Core/Analysis.js 4601

Name Type Description
options object Options passed to RfDownlinkFootprint.compute.
Returns:
Coverage result, shaped like Analysis.computeRfCoverage's so the same footprint projector consumes it.

static Cesium.Analysis.computeRfDownlinkFootprintAsync(options) → Promise.<object>
engine/Source/Core/Analysis.js 4615

Computes an orbital RF footprint without monopolizing the main thread. Completed rasters are returned atomically and may carry an opaque generation token so a renderer can discard superseded solves.
Name Type Description
options object Options passed to RfDownlinkFootprint.computeAsync.
Returns:
Completed coverage result.

static Cesium.Analysis.computeRfHorizon(options) → object
engine/Source/Core/Analysis.js 4668

Name Type Description
options object Options passed to RfDownlinkFootprint.computeHorizon.
Returns:
The horizon geometry.

static Cesium.Analysis.computeRfHorizonRing(options) → Array.<Cartesian3>
engine/Source/Core/Analysis.js 4683

Name Type Description
options object Options passed to RfDownlinkFootprint.horizonRingPositions.
Returns:
Positions on the ellipsoid surface, closed.

static Cesium.Analysis.computeRfLinkMatrix(options) → object
engine/Source/Core/Analysis.js 4628

Computes the full emitter x receiver link matrix, including co-channel interference and SINR at each receiver.
Name Type Description
options object Options accepted by RfInterferenceAnalysis#analyzeConstellation plus `comms`.
Returns:
Per-link and receiver/channel-grouped results.

static Cesium.Analysis.computeRfLinkMatrixAsync()
engine/Source/Core/Analysis.js 4635

Non-blocking, cancellable form of Analysis.computeRfLinkMatrix.

static Cesium.Analysis.computeRfPathProfile(options) → Promise.<object>
engine/Source/Core/Analysis.js 4696

Name Type Description
options object Analysis options passed to RfTerrainAnalysis.
Returns:
Path profile result.

static Cesium.Analysis.computeSwath(states, sensorConfig, options) → Promise.<object>
engine/Source/Core/Analysis.js 5925

Computes time-varying swath geometry from an ordered list of state vectors.
Name Type Description
states Array.<object> Ordered state vectors.
sensorConfig object Swath sensor configuration.
options object optional Plugin load options.
Returns:
Swath result from the swath analyzer.

static Cesium.Analysis.computeSwathAccessGeometry(state, sensorConfig, target, options) → Promise.<object>
engine/Source/Core/Analysis.js 6028

Computes instantaneous target access geometry for a swath sensor.
Name Type Description
state object The ECEF state vector `{ position, velocity, julianDate }`.
sensorConfig object Swath sensor configuration.
target object Cartographic target `{ longitude, latitude, altitude }` in radians/meters.
options object optional Plugin load options.
Returns:
Access-geometry result.

static Cesium.Analysis.computeSwathFootprint(state, sensorConfig, options) → Promise.<object>
engine/Source/Core/Analysis.js 5884

Computes a single-epoch sensor footprint using the swath plugin.
Name Type Description
state object The ECEF state vector `{ position, velocity, julianDate }`.
sensorConfig object Swath sensor configuration.
options object optional Plugin load options.
Returns:
Footprint result from the swath analyzer.

static Cesium.Analysis.computeSwathGroundTrack(states, options) → Promise.<Array.<object>>
engine/Source/Core/Analysis.js 5904

Computes a ground track from an ordered list of state vectors.
Name Type Description
states Array.<object> Ordered state vectors.
options object optional Plugin load options.
Returns:
Ground-track points.

static Cesium.Analysis.computeTerrainAwareSwath(states, sensorConfig, terrainProvider, options) → Promise.<object>
engine/Source/Core/Analysis.js 5984

Computes a terrain-draped swath across an ordered state sequence.
Name Type Description
states Array.<object> Ordered state vectors.
sensorConfig object Swath sensor configuration.
terrainProvider TerrainProvider Terrain provider used for draping.
options object optional Swath options plus terrain sampling flags.
Returns:
Swath result with terrain-updated segment vertices.

static Cesium.Analysis.computeTerrainAwareSwathFootprint(state, sensorConfig, terrainProvider, options) → Promise.<object>
engine/Source/Core/Analysis.js 5951

Computes a terrain-draped single-epoch swath footprint by sampling terrain beneath each footprint vertex.
Name Type Description
state object The ECEF state vector `{ position, velocity, julianDate }`.
sensorConfig object Swath sensor configuration.
terrainProvider TerrainProvider Terrain provider used for draping.
options object optional Plugin load options and terrain sampling flags.
Returns:
Footprint result with terrain-updated vertex altitudes.

static Cesium.Analysis.computeTUt1(julianDate) → number
engine/Source/Core/Analysis.js 3614

Name Type Description
julianDate JulianDate An object with two properties:
Returns:
T_UT1, the number of Julian centuries since J2000.0 (UT1 basis).
Properties:
Name Type Description
dayNumber number The integer Julian day (often at midnight).
secondsOfDay number The number of seconds past `dayNumber`.

static Cesium.Analysis.createAccessAnalyzer(options) → Promise.<object>
engine/Source/Core/Analysis.js 6467

Creates a ground-station access-analysis plugin instance.
Name Type Description
options object optional Plugin load options.
Returns:
The access analyzer instance.

static Cesium.Analysis.createBoundingSphereRegion(sphereOrCenter, radius) → object
engine/Source/Core/Analysis.js 1438

Name Type Description
sphereOrCenter BoundingSphere | Cartesian3 Bounding sphere or center.
radius number optional Radius in meters when passing a center.
Returns:
Region descriptor.

static Cesium.Analysis.createCartesianBoxRegion(options, maximum) → object
engine/Source/Core/Analysis.js 1465

Name Type Description
options object | Cartesian3 Options or minimum corner.
maximum Cartesian3 optional Maximum corner when passing minimum directly.
Returns:
Region descriptor.

static Cesium.Analysis.createCartographicPolygonRegion(positions, options) → object
engine/Source/Core/Analysis.js 1531

Name Type Description
positions Array.<Cartographic> | Array.<Cartesian3> Polygon positions.
options object optional Optional height/ellipsoid constraints.
Returns:
Region descriptor.

static Cesium.Analysis.createCartographicRectangleRegion(rectangle, options) → object
engine/Source/Core/Analysis.js 1507

Name Type Description
rectangle Rectangle Rectangle in radians.
options object optional Optional height/ellipsoid constraints.
Returns:
Region descriptor.

static Cesium.Analysis.createCoverageAnalyzer(options) → Promise.<object>
engine/Source/Core/Analysis.js 6203

Creates an analytical coverage plugin instance.
Name Type Description
options object optional Plugin load options.
Returns:
The coverage analyzer instance.

static Cesium.Analysis.createCoverageGridOverlay(coverageResult, options) → object
engine/Source/Core/Analysis.js 6053

Creates a dynamic analytical-coverage overlay backed by generated reference-grid tiles.
Name Type Description
coverageResult object Result returned by `computeAnalyticalCoverage()`.
options object optional Overlay styling options.
Returns:
Overlay controller with provider/layer/update/export helpers.

static Cesium.Analysis.createCoverageLegend(coverageOrOverlay, options) → object
engine/Source/Core/Analysis.js 6154

Builds a structured legend for an analytical coverage overlay or result.
Name Type Description
coverageOrOverlay object Analytical coverage result or overlay controller.
options object optional Legend options.
Returns:
Legend descriptor with value stops and optional canvas.

static Cesium.Analysis.createCoverageOverlay(coverageResult, options) → object
engine/Source/Core/Analysis.js 6127

Alias for `createCoverageGridOverlay()` using the shorter overlay name.
Name Type Description
coverageResult object Result returned by `computeAnalyticalCoverage()`.
options object optional Overlay styling options.
Returns:
Overlay controller with provider/layer/update/export helpers.

static Cesium.Analysis.createPackedRegionMaskQuery(block, jobs, options) → Analysis.PackedRegionMaskQuery
engine/Source/Core/Analysis.js 2994

Name Type Description
block PackedEntityBlock The block to query.
jobs Array.<object> One {region, bbox} per polygon part. A lasso or a rectangle is one job; a country is one job per part.
options object optional Options.
Name Type Description
attributeRanges object optional e.g. {PROVIDER: [2, 2]}.
context object optional Containment evaluation context.
Returns:
The resumable query.

static Cesium.Analysis.createReferenceGridProvider(options) → ReferenceGridImageryProvider
engine/Source/Core/Analysis.js 5615

Creates a generated reference-grid imagery provider for latitude/longitude, H3, or MGRS overlays.
Name Type Description
options ReferenceGridImageryProvider.ConstructorOptions optional Grid provider options.
Returns:
The generated grid imagery provider.

static Cesium.Analysis.createSwathAnalyzer(options) → Promise.<object>
engine/Source/Core/Analysis.js 5870

Creates a swath-analysis plugin instance.
Name Type Description
options object optional Plugin load options.
Returns:
The swath analyzer instance.

static Cesium.Analysis.createSwathPolygonHierarchies(swath, options) → Array.<PolygonHierarchy>
engine/Source/Core/Analysis.js 5802

Convenience alias for per-segment swath polygon hierarchies.
Name Type Description
swath object | Array.<object> Swath result returned by `computeSwath()` or a raw segment array.
options object optional Hierarchy options.
Returns:
One hierarchy per swath segment.

static Cesium.Analysis.createSwathPolygonHierarchy(swath, options) → PolygonHierarchy|Array.<PolygonHierarchy>
engine/Source/Core/Analysis.js 5790

Converts computed swath segments into a Cesium polygon hierarchy.
Name Type Description
swath object | Array.<object> Swath result returned by `computeSwath()` or a raw segment array.
options object optional Hierarchy options. Set `perSegment: true` to return one hierarchy per segment.
Returns:
Polygon hierarchy describing the swath boundary.

static Cesium.Analysis.ensureWasmOcclusionReady() → Promise.<boolean>
engine/Source/Core/Analysis.js 4109

Returns:
True if WASM occlusion is ready.

static Cesium.Analysis.evaluateRegionSignedDistance(region, point, context) → number
engine/Source/Core/Analysis.js 1644

Name Type Description
region object Region descriptor.
point Cartesian3 | Cartographic Point to evaluate.
context object optional Evaluation context.
Returns:
Signed distance-like value. Negative is inside.

static Cesium.Analysis.exportAnalyticalCoverage(coverageResult, options) → object
engine/Source/Core/Analysis.js 6611

Exports an analytical coverage result to GeoJSON or JSON.
Name Type Description
coverageResult object Result returned by `computeAnalyticalCoverage()`.
options object optional Export options.
Returns:
Exported coverage object.

static Cesium.Analysis.exportCoverageGeoJson(coverageResult, options) → object
engine/Source/Core/Analysis.js 6174

Exports an analytical coverage result to GeoJSON.
Name Type Description
coverageResult object Result returned by `computeAnalyticalCoverage()`.
options object optional Export options.
Returns:
GeoJSON feature collection.

static Cesium.Analysis.exportCoverageJson(coverageResult, options) → object
engine/Source/Core/Analysis.js 6189

Exports an analytical coverage result to plain JSON.
Name Type Description
coverageResult object Result returned by `computeAnalyticalCoverage()`.
options object optional Export options.
Returns:
JSON export payload.

static Cesium.Analysis.exportRfRaster(options) → Promise.<object>
engine/Source/Core/Analysis.js 4732

Name Type Description
options object Analysis options passed to RfTerrainAnalysis.
Returns:
Raster export result.

static Cesium.Analysis.filterPositionsInRegion(region, packedPositions, context) → object
engine/Source/Core/Analysis.js 1782

Name Type Description
region object Region descriptor.
packedPositions Float64Array | Array.<number> Packed XYZ triples.
context object optional Evaluation context. For sensor-like regions, set `context.sensorAccess = true` to evaluate `hasAccess()` for each point.
Returns:
Filter results with `indices`, `mask`, and `insideCount`.

static Cesium.Analysis.findOptimalRfSensorPlacement(options) → Promise.<object>
engine/Source/Core/Analysis.js 4714

Name Type Description
options object Analysis options passed to RfTerrainAnalysis.
Returns:
Placement search result.

static Cesium.Analysis.footprintToSensorDirections(boundary, spacecraftPosition, options) → Array.<Spherical>
engine/Source/Core/Analysis.js 6785

Name Type Description
boundary Array.<Cartesian3> Footprint boundary positions, in order, in the fixed frame. One closed ring.
spacecraftPosition Cartesian3 Spacecraft position in the fixed frame.
options object optional Conversion options.
Name Type Description
sensorFrame Matrix4 optional Spacecraft-to-fixed transform whose z axis is the boresight; defaults to the east-north-up frame at the spacecraft's sub-point, giving a nadir boresight.
Returns:
Boundary directions for `customSensor.directions`.

static Cesium.Analysis.getAccesses(fromEntity, toEntity, startDate, endDate, stepSize, highResolution) → Promise.<Array.<TimeInterval>>
engine/Source/Core/Analysis.js 3538

Name Type Default Description
fromEntity Object The source entity with a position property.
toEntity Object The target entity with a position property.
startDate JulianDate The start date of the access computation.
endDate JulianDate The end date of the access computation.
stepSize number The time step (in seconds) between each access computation.
highResolution boolean false optional If true, uses a higher resolution computation.
Returns:
- A promise that resolves to an array of `TimeInterval` objects representing the access windows.

static Cesium.Analysis.getAltitudeCrossings(entity, altitudeMeters, start, stop, stepSeconds, options) → TimeIntervalCollection
engine/Source/Core/Analysis.js 4965

Name Type Default Description
entity Entity Entity with a position property.
altitudeMeters number Altitude threshold in meters.
start JulianDate Start of analysis window.
stop JulianDate End of analysis window.
stepSeconds number 60 optional Scan step in seconds.
options Object optional Options.
Name Type Default Description
tolerance number 0.1 optional Bisection tolerance in seconds.
Returns:
Intervals where the entity is above the altitude.

static Cesium.Analysis.getApsides(entity, start, stop, stepSeconds) → Object
engine/Source/Core/Analysis.js 4856

Name Type Default Description
entity Entity Entity with a position property.
start JulianDate Start of analysis window.
stop JulianDate End of analysis window.
stepSeconds number 60 optional Scan step in seconds.
Returns:

static Cesium.Analysis.getAzElRange(point1, point2) → Object
engine/Source/Core/Analysis.js 3559

Name Type Description
point1 Cartesian3
point2 Cartesian3
Returns:

static Cesium.Analysis.getConstellationAccesses(sensors, targets, startDate, endDate, options) → Promise.<object>
engine/Source/Core/Analysis.js 4444

Name Type Description
sensors Array.<Sensor> Array of sensors.
targets Array.<Entity> Array of target entities.
startDate JulianDate Start of analysis window.
endDate JulianDate End of analysis window.
options object optional Options (same as getSensorAccesses, plus:)
Name Type Default Description
aggregate boolean false optional If true, also compute aggregate metrics.
maxConcurrent number 4 optional Maximum parallel analysis pairs.
onPairComplete function optional Callback(sensorIndex, targetIndex, intervals) => void.
Returns:
Results object.

static Cesium.Analysis.getCoverageArea(sensor, options) → object|undefined
engine/Source/Core/Analysis.js 4553

Name Type Description
sensor Sensor A sensor with viewshed enabled.
options object optional Options.
Name Type Default Description
resolution number 512 optional Offscreen framebuffer size.
Returns:
Area statistics, or undefined if viewshed not available.

static Cesium.Analysis.getCoverageStatistics(sensor) → object|undefined
engine/Source/Core/Analysis.js 4534

Name Type Description
sensor Sensor A sensor with viewshed enabled.
Returns:
Coverage statistics, or undefined if viewshed not available.

static Cesium.Analysis.getEclipses(entity, start, stop, stepSeconds, options) → TimeIntervalCollection
engine/Source/Core/Analysis.js 4819

Name Type Default Description
entity Entity Entity with a position property (PropagatedPositionProperty or SampledPositionProperty).
start JulianDate Start of analysis window.
stop JulianDate End of analysis window.
stepSeconds number 30 optional Coarse scan step in seconds (default 30s).
options Object optional Options.
Name Type Default Description
tolerance number 0.1 optional Bisection tolerance in seconds.
Returns:
Eclipse intervals. Each interval's data is not set; the interval itself represents a period where the entity is in shadow (umbra or penumbra).

static Cesium.Analysis.getNodeCrossings(entity, start, stop, stepSeconds, options) → TimeIntervalCollection
engine/Source/Core/Analysis.js 5007

Name Type Default Description
entity Entity Entity with a position property.
start JulianDate Start of analysis window.
stop JulianDate End of analysis window.
stepSeconds number 60 optional Scan step in seconds.
options Object optional Options.
Name Type Default Description
tolerance number 0.1 optional Bisection tolerance in seconds.
Returns:
Intervals where the entity is in the northern hemisphere. Start boundaries of each interval are ascending node times.

static Cesium.Analysis.getSensorAccesses(sensor, targetEntity, startDate, endDate, options) → Promise.<Array.<TimeInterval>>
engine/Source/Core/Analysis.js 4228

Name Type Description
sensor Sensor The sensor (or any object with containsPoint/hasAccess).
targetEntity Entity The target entity.
startDate JulianDate Start of analysis window.
endDate JulianDate End of analysis window.
options object optional Options.
Name Type Default Description
stepSize number 60 optional Time step in seconds for coarse sweep.
highResolution boolean false optional Use binary search refinement at boundaries.
bodyOcclusion boolean true optional Include body occlusion checks.
terrainOcclusion boolean false optional Include terrain occlusion checks (expensive).
ellipsoid Ellipsoid Ellipsoid.WGS84 optional Ellipsoid for body occlusion.
Returns:
Access windows.

static Cesium.Analysis.getVisibleEntities(sensor, entities, time, options) → Array.<Entity>
engine/Source/Core/Analysis.js 4756

Name Type Description
sensor Sensor The sensor.
entities EntityCollection | Array.<Entity> Entities to check.
time JulianDate Time to evaluate.
options object optional Options.
Name Type Default Description
bodyOcclusion boolean true optional Check body occlusion.
terrainOcclusion boolean false optional Check terrain occlusion (requires viewshed).
Returns:
Visible entities.

static Cesium.Analysis.intersectRegions(regions) → object
engine/Source/Core/Analysis.js 1603

Name Type Description
regions object repeatable Child regions.
Returns:
Composite region descriptor.

static Cesium.Analysis.predictGroundStationAosLos(options) → Promise.<object>
engine/Source/Core/Analysis.js 6550

Predicts the next AOS/LOS pair for a ground station from sampled states.
Name Type Description
options object Access request `{ states, groundStations, stationId, accessOptions?, pluginOptions? }`.
Returns:
AOS/LOS summary.

static Cesium.Analysis.queryEntitiesInRegion(entityCollection, region, time, context) → object
engine/Source/Core/Analysis.js 1843

Name Type Description
entityCollection EntityCollection | Array.<Entity> | Array.<object> Entity collection or array.
region object Region descriptor.
time JulianDate Time to evaluate positions.
context object optional Evaluation context. For sensor-like regions, set `context.sensorAccess = true` to query by `hasAccess()` instead of pure containment.
Returns:
Query results with `entities`, `indices`, and `mask`.

static Cesium.Analysis.queryRegionCandidates(entityQuery, region, options) → object
engine/Source/Core/Analysis.js 2540

Name Type Description
entityQuery function | object Executor surface (injected).
region object Region descriptor (its bounding rectangle drives the query) — or pass `options.bbox` explicitly.
options object optional Options.
Name Type Default Description
table string optional Catalog table name (required for `rtree` mode; `'auto'` requires `table` + the bbox column set).
mode string 'auto' optional `'rtree'` | `'bboxColumns'` | `'auto'`.
bbox Rectangle optional Explicit bbox override (radians).
maxRows number optional Row cap passed to the executor.
minHeight number optional Absolute floor (radians-resolved), else resolved via Analysis.resolveRegionHeightRange.
terrainHeightProvider function optional Pluggable terrain sampler for AGL floors/ceilings (see resolveRegionHeightRange).
Returns:
`{ rows, columns, sql, mode, error }`. `rows` is always an ARRAY of rows - an executor that returns FlatSQL's `{columns, rows}` envelope is unwrapped here - and `columns` names their lanes when the executor reported them.

static Cesium.Analysis.raDec2AzEl(raDeg, decDeg, latDeg, lonDeg, julianDate, useNoonEpoch) → Object
engine/Source/Core/Analysis.js 3825

Converts right ascension/declination to azimuth/elevation, matching Vallado's "algorithm 28": LHA = LST - RA el = asin( sin(lat)*sin(dec) + cos(lat)*cos(dec)*cos(LHA) ) az = atan2( -sin(LHA)*cos(dec)/cos(el), ( sin(dec)-sin(el)*sin(lat) ) / (cos(el)*cos(lat)) )
Name Type Default Description
raDeg number Right ascension [degrees].
decDeg number Declination [degrees].
latDeg number WGS84 latitude [degrees].
lonDeg number WGS84 longitude [degrees], east positive.
julianDate Object UT1-based Julian Date object.
useNoonEpoch boolean true optional Use Vallado's noon-based GMST offsets if true.
Returns:
Azimuth [0..360), Elevation [−90..90].

static Cesium.Analysis.refinePackedCandidates(catalog, ranges, region, options) → object
engine/Source/Core/Analysis.js 2705

Name Type Description
catalog PackedEntityCatalog The catalog the ranges came from.
ranges Uint32Array Flat `[firstRow, rowCount, ...]` pairs.
region object Region descriptor, or undefined to accept every candidate.
options object optional Options.
Name Type Description
attributeRanges object optional Per-attribute `[low, high]` ranges refined exactly against the site's own value.
maxRows number optional Cap on the number of rows returned.
context object optional Region evaluation context.
Returns:
`{rowIds, slots, candidateCount}`.

static Cesium.Analysis.regionBoundingRectangle(region) → Rectangle|undefined
engine/Source/Core/Analysis.js 2167

Name Type Description
region object Region descriptor.
Returns:
Bounding rectangle in radians.

static Cesium.Analysis.registerAccessPlugin(plugin)
engine/Source/Core/Analysis.js 4095

Name Type Description
plugin object Object implementing computeAccesses(sensor, targetEntity, start, end, options).

static Cesium.Analysis.removeAccessLines(viewer, id) → void
engine/Source/Core/Analysis.js 4012

Name Type Description
viewer Object The viewer instance.
id string The id of the access line group to remove.
Returns:

static Cesium.Analysis.resolveRegionHeightRange(region, options) → object
engine/Source/Core/Analysis.js 2219

Name Type Description
region object Region descriptor with `minHeight`/`maxHeight`.
options object optional Options.
Name Type Description
terrainHeightProvider function optional `(longitudeRadians, latitudeRadians) => terrainHeightMetres | undefined`. Unavailable samples are skipped; when no sample succeeds the original absolute range is returned unchanged.
Returns:
`{ minHeight, maxHeight, resolvedToTerrain, terrainSamples }`.

static Cesium.Analysis.scheduleGroundStationContacts(options) → Promise.<object>
engine/Source/Core/Analysis.js 6580

Runs deterministic greedy ground-station contact scheduling.
Name Type Description
options object Scheduling request `{ windows?, states?, groundStations, stationId?, stationIds?, accessOptions?, pluginOptions? }`.
Returns:
Scheduled contacts plus equivalent `TimeInterval` records.

static Cesium.Analysis.scoreTrajectoryExposure(positions, sensors, times, options) → Object
engine/Source/Core/Analysis.js 5042

Name Type Description
positions Array.<Cartesian3> Trajectory positions in ECI (meters).
sensors Array.<Sensor> Array of sensors to check against.
times Array.<JulianDate> Corresponding times for each position.
options Object optional Options.
Name Type Default Description
bodyOcclusion boolean true optional Check Earth body occlusion.
terrainOcclusion boolean false optional Check terrain occlusion.
Returns:
Exposure score with totalTimeInFOV, totalPoints, exposureFraction, maxContinuousExposure, and exposureWindows.

static Cesium.Analysis.subtractRegions(left, right) → object
engine/Source/Core/Analysis.js 1624

Name Type Description
left object Base region.
right object Region to subtract from the base.
Returns:
Composite region descriptor.

static Cesium.Analysis.testPointInRegion(region, point, context) → boolean
engine/Source/Core/Analysis.js 1733

Name Type Description
region object Region descriptor.
point Cartesian3 | Cartographic Point to test.
context object optional Evaluation context. For sensor-like regions, set `context.sensorAccess = true` to use `hasAccess()` instead of pure geometric containment.
Returns:
True if the point is inside the region.

static Cesium.Analysis.testRegionsIntersect(leftRegion, rightRegion, context) → boolean
engine/Source/Core/Analysis.js 1957

Name Type Description
leftRegion object Left region descriptor.
rightRegion object Right region descriptor.
context object optional Evaluation context.
Returns:
True if the regions intersect.

static Cesium.Analysis.unionRegions(regions) → object
engine/Source/Core/Analysis.js 1583

Name Type Description
regions object repeatable Child regions.
Returns:
Composite region descriptor.

Type Definitions

Cesium.Analysis.PackedRegionMaskQuery
engine/Source/Core/Analysis.js 3100

A resumable packed region query. See Analysis.createPackedRegionMaskQuery.
Properties:
Name Type Description
mask Uint8Array One byte per slot: 1 inside, 0 outside.
done boolean Whether the answer is complete.
step function Advance by a millisecond budget.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets