Skip to content

Documentation / @interstellar-tools/types / VelocityInterface

Interface: VelocityInterface ​

Defined in: positions.ts:100

A velocity in 3D, in a named frame, in km/s: the Sun's motion around the Milky Way's centre, for example, or a galaxy's, from its ObservedMotionInterface.

Example ​

ts
// The Sun's motion around the Milky Way's centre
const sun: VelocityInterface = {
  frame: 'galactocentric',
  x: 12.9,
  y: 251.51,
  z: 8.56
};

Properties ​

frame ​

ts
frame: 'galactocentric';

Defined in: positions.ts:102

The frame the components are in.


x ​

ts
x: number;

Defined in: positions.ts:104

Velocity along x, in km/s.


y ​

ts
y: number;

Defined in: positions.ts:106

Velocity along y, in km/s.


z ​

ts
z: number;

Defined in: positions.ts:108

Velocity along z, in km/s.