InitialState
The InitialState Connect command enables you to import or export initial state data (i.e., epoch, position, velocity) for satellites and missiles.
Syntax
InitialState <ObjectPath> {Import | Export} {Source} ["<FilePath>"] [{Options}]
Description
- Import
- Export
The initial state may be obtained from a vehicle's ephemeris (when Source is STKEphem), from an STK file (when Source is STKFile), or from one of several types of initial state files (when Source is one of the other valid values). See the Initial State Tool in the STK Desktop Help. If the vehicle uses the HPOP propagator, then any mass, drag, or solar radiation parameters contained as part of the initial state message will be loaded into the vehicle as well, replacing any existing values. If the Source is CCSDS_OPM and that message contains position-velocity covariance, then it too will be loaded into the vehicle replacing any current values. Note that the other HPOP Force Model settings will be preserved.
One or more initial states may be exported into an external file, formatted per the Source setting as specified by the corresponding authoritative organization. [These are not AGI-designed formats.] When the vehicle uses the HPOP or LOP propagator and the Source is EPV or CCSDS_OPM, then the vehicle's mass, drag, and solar radiation parameters will be output in the file as part of the initial state message. Similarly, if the HPOP vehicle contains covariance, it will be output as part of the CCSDS_OPM message.
The format used will depend on the whether Import or Export is specified. Formats are outlined below.
Generic Parameters
Valid values for {Source} are described in the table below.
The "<FilePath>" parameter includes the full path and name of the file to be imported or exported.
The "<FilePath>" parameter is required for both Import and Export unless the {Source} is STKEphem.
"<FilePath>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information.
{Source} | Description |
---|---|
STKFile | Read the initial state data from an STK satellite file (.sa) or ephemeris file (.e). If the satellite has not yet been propagated the propagator will be set to TwoBody.
HPOP must propagate from the orbit epoch to the start time, so use caution when selecting a satellite or ephemeris file. (i.e. check the epoch time in the file) This {Source} is valid for Import only. |
STKEphem | Read the initial state data from the satellite's ephemeris. The ephemeris is obtained from the vehicle specified by the <ObjectPath> parameter. The satellite must already be propagated to use this option. Do not include the "<FilePath>" parameter in the command.
This {Source} is valid for Import only. |
IIRV | Read or output data in Improved Interrange Vector (IIRV) format. |
IIRV1 | Read or output data in IIRV Type 1 format. |
IIRV9 | Read or output data in IIRV Type 9 format. |
EPV | Read or output data in Extended Precision Vector (EPV) format. |
NASAIIRV | Read or output data in NASA Flight Dynamics Facility IIRV format.
In order to be successfully imported into STK, the name of the NASA IIRV file must include the year, starting at the 8th character, for example: ephmxxxYYYYddd. |
CCSDS_OPM | Read or output data in CCSDS OPM Format, version 2.0 |
Import Options
A Satellite must be using one of the following propagators: TwoBody, J2Perturbation, J4Perturbation, HPOP, LOP or Astrogator. If the Satellite has not been propagated then the propagator will be set to TwoBody.
When the satellite is a TwoBody satellite, the spacecraft parameters for mass, drag (Cd and area-to-mass ratio), and SRP (Cr and area-to-mass ratio) and the position-velocity covariance as read from the Initial State file are used. When Interpolate is used for for epoch selection, the parameters are obtained as if ClosestPoint was chosen while the initial state is found through interpolation.
A Missile must be using the TwoBody or HPOP propagator. If the Missile has not been propagated then the propagator will be set to TwoBody.
The ephemeris step size for the Satellite or Missile will be set to 60.0 seconds, unless the propagator is LOP, in which case the step size will be set to 1 day.
HPOP must propagate from the orbit epoch to the start time, so use caution when selecting a satellite or ephemeris file. (i.e. check the epoch time in the file)
The following table describes the Import {Options}.
{Option} | <Parameter> | Description |
---|---|---|
EpochSelect | Interpolate | Calculates a point precisely at the Target Epoch to select the initial state. Interpolate is the default value. |
ClosestPoint | Uses the data point closest to the Target Epoch to select the initial state. | |
ClosestPrevious | Uses the closest data point preceding the Target Epoch to select the initial state. | |
ClosestFollowing | Uses the closest data point following the Target Epoch to select the initial state. | |
FirstPoint | Uses the first ephemeris point to select the initial state. | |
LastPoint | Uses the last ephemeris point to select the initial state. | |
Epoch | {TimeEpoch} | If EpochSelect is Interpolate, ClosestPoint, ClosestPrevious or ClosestFollowing, enter the Epoch {TimeEpoch} to be used as a starting point for initial state. If the {TimeEpoch} lies outside the span of the available ephemeris, the closest ephemeris point is used.
For valid {TimeEpoch} values see Time Options. If no time is specified, the vehicle's orbit epoch is used, unless it falls outside the vehicle's ephemeris. When it does fall outside, either the start time or end time is used (whichever is closer to the orbit epoch). |
InterpOrder | <InterpOrder> | If the EpochSelect is Interpolate, set the order of interpolation by specifying an integer between 1 and 22. The default value is 5. |
GatorPath | "<Path>" | Enter the path of the satellite's Initial State segment. If no GatorPath is included the first InitialState segment will be used.
This option is valid only for satellite's whose propagator has been set to Astrogator. |
Import Deprecated Format
The format for the InitialState Import options was changed in STK 9. The following describes the format in previous versions of STK. This format should no longer be used but is included for backward compatibility.
InitialState <ObjectPath> Import {Source} "<FilePath>" [{EpochSelect} "<TgtEpoch>" <InterpOrder>]
Export Options
If you are exporting an initial state file, valid command format is:
InitialState <ObjectPath> Export {Source} "<FilePath>" {CrdnSystem} [{ExportOption} <Value> [{ExportOption} <Value>...]]
If you are exporting an initial state file, valid values for {CrdnSystem} will depend on the {Source} specified.
{Source} | {CrdnSystem} |
---|---|
EPV | If {Source} is EPV, {CrdnSystem} can be:
Deprecated values for {CrdnSystem}, in order, are: Fixed, B1950, TrueOfDate and J2000. The above values should be used in place of the deprecated values. |
IIRV | If {Source} is IIRV, {CrdnSystem} can be:
Deprecated values for the first two {CrdnSystem} values, in order, are: Fixed and B1950. The above values should be used in place of the deprecated values. |
IIRV1 | If {Source} is IIRV1, {CrdnSystem} can be:
Deprecated values for {CrdnSystem}, in order, are: Fixed and B1950. The above values should be used in place of the deprecated values. |
IIRV9 | If {Source} is IIRV9, {CrdnSystem} can be:
Deprecated values for {CrdnSystem}, in order, are: Fixed and B1950. The above values should be used in place of the deprecated values. |
NASAIIRV | If {Source} is NASAIIRV, {CrdnSystem} can be:
For NASAIIRV Export the "<FilePath>" should include the output directory only. The exported NASAIIRV file name is automatically constructed as follows: ephmxxxyyyyddd, where xxx is the MissionID, yyyy is the year and ddd is the day of year. The deprecated value for {CrdnSystem} is Fixed. The above value should be used in place of the deprecated value. |
CCSDS_OPM | Any coordinate system supported by the vehicle's central body. |
If {Source} is IIRV, valid {ExportOption} <Value> combinations are:
{ExportOption} | <Value> | Description |
---|---|---|
MessageID | <IDNum> | <IDNum> is an integer between 0 and 9999999. |
MessageClass | Nominal | Specify the message class identifier that will be used. |
Inflight | ||
MessageOrigin | GSFC | Select the originating facility. |
ETR | ||
WTR | ||
PMR | ||
KMR | ||
WLP | ||
JPL | ||
JSC | ||
CSTC | ||
CNES | ||
Destination | <cccc> | Enter a 4 character string representing the site for which the message was generated. Enter MANY if generating a message for more than one site. |
VectorType | FreeFlight | Specify the vector type identifier. |
Forced | ||
Spare3 | ||
Ignition | ||
CutOff | ||
Reentry | ||
Powered | ||
Stationary | ||
Spare9 | ||
VectorSource | Nominal | Enter the vector source identifier. |
RealTime | ||
Offline | ||
OfflineMean | ||
CounterStart | <Counter> | Enter an integer between 1 and 1000. |
VehicleID | <VehIDValue> | Enter an integer between 1 and 99. |
SolarRef | <SRPCoeff> | Enter a number between -10.0 and 10.0 that will be used as the solar radiation pressure coefficient. |
Drag | <DragCoeff> | Enter a number between -10.0 and 10.0 that will be used as the drag coefficient. |
Area | <AreaValue> | Enter a number between -1000.0 and 1000.0 for the cross sectional area. |
RoutingMessage | <cccc> | Enter a 4 character string representing the site for which the message was generated. Enter MANY if generating a message for more than one site. |
SupportID | <SupportIDValue> | Enter an integer between 0 and 9999. |
UseStartStop | {TimeInterval} | Enter the time period used to create the file. For valid {TimeInterval} values see Time Options.Only the part of this interval that overlaps with the vehicle's time period will actually be used. If this option is not entered, the vehicle's orbit epoch will be used if it occurs on the vehicle's time period; otherwise, the start or stop time of the vehicle's time period will be used (the time closest to the orbit epoch). |
Stepsize | <TimeDuration> | If UseStartStop is provided, the stepsize at which to report states over that interval. <TimeDuration> is given in Connect time units. Default value is 1 hr. |
If {Source} is IIRV1, valid {ExportOption} <Value> combinations are:
{ExportOption} | <Value> | Description |
---|---|---|
Destination | <cccc> | Enter a 4 character string representing the site for which the message was generated. Enter MANY if generating a message for more than one site. |
VectorType | Routine | Specify the vector type identifier. |
ForcedSpecial | ||
ForcedNoBurn | ||
Ignition | ||
CutOff | ||
Reentry | ||
Powered | ||
VectorSource | Nominal | Enter the vector source identifier. |
RealTime | ||
OffLine | ||
OffLineMean | ||
CounterStart | <Counter> | Enter an integer between 1 and 1000. |
VehicleID | <VehIDValue> | Enter 5 or 6. |
Drag | <DragCoeff> | Enter a number between -10.0 and 10.0 that will be used as the drag coefficient. |
Area | <AreaValue> | Enter a number between -1000.0 and 1000.0 for the cross sectional area. |
RoutingMessage | <cccc> | Enter a 4 character string representing the site for which the message was generated. Enter MANY if generating a message for more than one site. |
SupportID | <SupportIDValue> | Enter an integer between 0 and 9999. |
UseStartStop | {TimeInterval} | Enter the time period used to create the file. For valid {TimeInterval} values see Time Options. Only the part of this interval that overlaps with the vehicle's time period will actually be used. If this option is not entered, the vehicle's orbit epoch will be used if it occurs on the vehicle's time period; otherwise, the start or stop time of the vehicle's time period will be used (the time closest to the orbit epoch). |
Stepsize | <TimeDuration> | If UseStartStop is provided, the stepsize at which to report states over that interval. <TimeDuration> is given in Connect time units. Default value is 1 hr. |
If {Source} is IIRV9, valid {ExportOption} <Value> combinations are:
{ExportOption} | <Value> | Description |
---|---|---|
IRON | <IRONID> | Enter a number between 0 and 99999 representing the object identifier. |
SRP | <SRPCoeff> | Enter a number between -10.0 and 10.0 that will be used as the solar radiation pressure coefficient. This will set the PerturbationCoeff type to Solar Radiation. |
Drag | <DragCoeff> | Enter a number between -10.0 and 10.0 that will be used as the drag coefficient. This will set the Perturbation Coefficient type to Drag. |
UseStartStop | {TimeInterval} | Enter the time period used to create the file. For valid {TimeInterval} values see Time Options. Only the part of this interval that overlaps with the vehicle's time period will actually be used. If this option is not entered, the vehicle's orbit epoch will be used if it occurs on the vehicle's time period; otherwise, the start or stop time of the vehicle's time period will be used (the time closest to the orbit epoch). |
Stepsize | <TimeDuration> | If UseStartStop is provided, the stepsize at which to report states over that interval. <TimeDuration> is given in Connect time units. Default value is 1 hr. |
If {Source} is EPV, valid {ExportOption} <Value> combinations are:
{ExportOption} | <Value> | Description |
---|---|---|
MessageID | <IDNum> | <IDNum> is an integer between 0 and 9999999. |
MessageClass | Routine | Specify the message class identifier that will be used. |
Maneuver | ||
MessageOrigin | GSFC | Select the originating facility. |
ETR | ||
WTR | ||
PMR | ||
KMR | ||
WLP | ||
JPL | ||
JSC | ||
CSTC | ||
CNES | ||
Destination | <cccc> | Enter a 4 character string representing the site for which the message was generated. Enter MANY if generating a message for more than one site. |
VectorType | FreeFlight | Specify the vector type identifier. |
Forced | ||
Spare3 | ||
Ignition | ||
CutOff | ||
Reentry | ||
Powered | ||
Stationary | ||
Spare9 | ||
VectorSource {SrcOption} | Nominal | Enter the vector source identifier. |
RealTime | ||
VehicleID | <VehIDValue> | Enter an integer between 1 and 99. |
SupportID | <SupportIDValue> | Enter an integer between 0 and 9999. |
UserText | <TextNum> "<String>" | <TextNum> is 1, 2 or 3; "<String>" can be up to 60 characters enclosed in quotes. |
UseStartStop | {TimeInterval} | Enter the time period used to create the file. For valid {TimeInterval} values see Time Options. Only the part of this interval that overlaps with the vehicle's time period will actually be used. If this option is not entered, the vehicle's orbit epoch will be used if it occurs on the vehicle's time period; otherwise, the start or stop time of the vehicle's time period will be used (the time closest to the orbit epoch). |
Stepsize | <TimeDuration> | If UseStartStop is provided, the stepsize at which to report states over that interval. <TimeDuration> is given in Connect time units. Default value is 1 hr. |
If {Source} is NASAIIRV, valid {ExportOption} <Value> combinations are:
{ExportOption} | <Value> | Description |
---|---|---|
MissionID | <ccc> | <ccc> must be 3 characters. This option is required. |
MessageID | <IDNum> | <IDNum> is an integer between 0 and 9999999. |
MessageClass | Nominal | Specify the message class identifier that will be used. |
Inflight | ||
RoutingIndicator | <cccc> | <cccc> must be 1-4 characters; if additional characters are entered, the value will be truncated. |
VectorType | FreeFlight | Specify the vector type identifier. |
Forced | ||
Spare3 | ||
Ignition | ||
CutOff | ||
Reentry | ||
Powered | ||
Stationary | ||
VectorSource | Nominal | Enter the vector source identifier. |
RealTime | ||
OffLine | ||
SolarRef | <Value> | <Value> is between -9.999999999 and 9.999999999 for the solar reflectivity coeeficient. |
Drag | <Value> | <Value> is between 0.0 and 10.0 for the drag coefficient. |
Area | <AreaValue> | Enter a number between -1000.0 and 1000.0 for the cross sectional area. |
OriginatorRoutingInd | {GCQU | GAQD} | Specify the originator routing indicator. |
UseStartStop | {TimeInterval} | Enter the time period used to create the file. For valid {TimeInterval} values see Time Options. Only the part of this interval that overlaps with the vehicle's time period will actually be used. If this option is not entered, the vehicle's orbit epoch will be used if it occurs on the vehicle's time period; otherwise, the start or stop time of the vehicle's time period will be used (the time closest to the orbit epoch). |
Stepsize | <TimeDuration> | If UseStartStop is provided, the stepsize at which to report states over that interval. <TimeDuration> is given in Connect time units. Default value is 1 hr. |
If {Source} is CCSDS_OPM, valid {ExportOption} <Value> combinations are:
{ExportOption} | <Value> | Description |
---|---|---|
ObjectName | <StringValue> | Text indicating the object's name. If not specified, "UNKNOWN" will be used. |
ObjectID | <StringValue> | Text indicating the object's identifier. The spec suggests that the international deisgnator be used, but any text will be accepted. If not specified, "UNKNOWN" will be used. |
CoordSystemEpoch | <Date> | The date in Connect Date units to be used when the {CrdnSystem} specified is an OfEpoch coordinate system (i.e., MeanOfEpoch, TrueOfEpoch, TEMEOfEpoch). Not needed when using other coordinate systems. |
CovCoordSystem | <Name> | The name of the coordinate system to export the covariance information, if the vehicle has covariance information. This can be any coordinate system supported by the vehicle's central body or a local frame: RIC, RTN (another name for RIC), RSW (another name for RIC), TNW (aligned with velocity and crosstrack). See the Initial State Tool in the STK Desktop Help where it explains this notation. |
Format | <Type> | OPM file type: XML or KVN (Keyword Value Notation). If more than 1 state is output, the XML format produces a CCSDS NDM message containing OPM elements; otherwise it produces an OPM element by itself. |
UseStartStop | {TimeInterval} | Enter the time period used to create the file. For valid {TimeInterval} values see Time Options. Only the part of this interval that overlaps with the vehicle's time period will actually be used. If this option is not entered, the vehicle's orbit epoch will be used if it occurs on the vehicle's time period; otherwise, the start or stop time of the vehicle's time period will be used (the time closest to the orbit epoch). |
Stepsize | <TimeDuration> | If UseStartStop is provided, the stepsize at which to report states over that interval. <TimeDuration> is given in Connect time units. Default value is 1 hr. |
Examples
Propagate Satellite2 using an external EPV file:
To propagate Satellite2 using the iirvIPC3.iirv file:
Propagate TestSat2 using the last ephemeris point from the file Satellite1.e:
The following series of commands will create a satellite with Astrogator propagator and set the Initial State for the satellite:
Use the closest data point, in the file Satellite1.e, following the Epoch to set the initial state:
Use the closest data point to the Epoch, from the ephemeris of TestSat1, to set the initial state:
Examples
Create an IIRV T9 file from Satellite SunSync, with an SRP of 1.234 and a defined start and stop time:
Create an IIRV file from Satellite Sat1, setting various parameters:
Create an IIRV T1 file from Missile Missile1:
Export an initial state file in NASA IIRV format, the following file will be created, ephmTc12009143:
Export an initial state file in EPV format:
Return message
Group membership
This command belongs to the following group(s):
Version
12.1