Skip to content

Documentation / @interstellar-tools/equations / GalactocentricPositionOptionsInterface

Interface: GalactocentricPositionOptionsInterface ​

Defined in: galactic/galactocentric-position.ts:18

Options for galactocentricPosition.

Properties ​

sunDistance? ​

ts
sunDistance?: DistanceInterface;

Defined in: galactic/galactocentric-position.ts:25

The Sun's distance from the Milky Way's centre, R0. Defaults to SUN_GALACTOCENTRIC_DISTANCE, 8275.9 pc.


sunHeight? ​

ts
sunHeight?: DistanceInterface;

Defined in: galactic/galactocentric-position.ts:30

The Sun's height above the Milky Way's plane, z⊙. Defaults to SUN_HEIGHT_ABOVE_GALACTIC_PLANE, 20.8 pc.


unit? ​

ts
unit?:
  | "m"
  | "meter"
  | "meters"
  | "metre"
  | "metres"
  | "kilometer"
  | "kilometers"
  | "kilometre"
  | "kilometres"
  | "AU"
  | "Au"
  | "astronomical-unit"
  | "astronomical-units"
  | "astronomical unit"
  | "astronomical units"
  | "lightyear"
  | "lightyears"
  | "light-year"
  | "light-years"
  | "kilolightyear"
  | "kilolightyears"
  | "kly"
  | "megalightyear"
  | "megalightyears"
  | "Mly"
  | "gigalightyear"
  | "gigalightyears"
  | "Gly"
  | "parsec"
  | "parsecs"
  | "kiloparsec"
  | "kiloparsecs"
  | "kpc"
  | "megaparsec"
  | "megaparsecs"
  | "Mpc"
  | "gigaparsec"
  | "gigaparsecs"
  | "Gpc"
  | "km"
  | "au"
  | "ly"
  | "pc";

Defined in: galactic/galactocentric-position.ts:20

The unit of the position. Defaults to the unit of distance.