StarField Object

Description

The StarField object stores an ordered list of records containing star data and makes available the stars’ geocentric inertial (GCI) positions and magnitudes. The star data stored in a StarField object can either be specified directly or read from a formatted star catalog. See also Stars in the Interplanetary Analysis Guide.

Inheritance Hierarchy: Object->List<Object>->List<Star>->StarField

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
CatalogFilename	The name of the star catalog file. To load stars from a catalog, the Get command must be used. This property will be set when the Get command is called.	Type: String Access: Read-Only
CatalogType	The type of star catalog, when the input source is from a file. To load stars from a catalog, the Get command must be used. This property will be set when the Get command is called.	Type: Variable Access: Read-Only
Count	The number of stars in the StarField. The Count will always equal the StarField.NumberOfPoints property.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
InputSource	The source for defining the location and data for the stars. To load stars from a catalog, the Get command must be used. This property will be set when the Get command is called.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
StarColor	The color of the stars.	Type: Array Access: Read/Write
StarDeclination	The declination of the stars in the ICRF.	Type: Array Access: Read/Write Units: deg
StarID	The identification number of the stars.	Type: Array Access: Read/Write
StarMagnitude	The magnitude of the stars.	Type: Array Access: Read/Write
StarName	The name of the stars.	Type: StringArray Access: Read/Write
StarRightAscension	The right ascension of the stars in the ICRF.	Type: Array Access: Read/Write Units: deg
StarX	The X-components of the vectors pointing toward each star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.	Type: Array Access: Read/Write
StarY	The Y-components of the vectors pointing toward each star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.	Type: Array Access: Read/Write
StarZ	The Z-components of the vectors pointing toward each star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.	Type: Array Access: Read/Write