Description | Example | Return Message | Group

InitialState

Import initial state data to a vehicle or export initial state data to a file

Syntax

InitialState <ObjectPath> {Import | Export} {Source} ["<FilePath>"] [{Options}]

Description

The InitialState Connect command allows you to import a previously created STK Satellite, STK Ephemeris, IIRV, Type 9 IIRV, EPV file or NASA Flight Dynamics Facility IIRV file containing initial state data for a satellite or missile.

With this command you can also export initial state data from a satellite or missile as a IIRV, IIRV Type9, EPV file or NASA Flight Dynamics Facility IIRV.

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.

Note: The "<FilePath>" parameter is required for both Import and Export unless the {Source} is STKEphem.

{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 HPOP.

Note: 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)

Note: 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.

Note: 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.

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 HPOP.

A Missile must be using the TwoBody or HPOP propagator. If the Missile has not been propagated then the propagator will be set to HPOP.

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.

Note: 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.

The default value is the vehicle's 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.

Note: 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:
  • GreenwichTODRotating
  • MeanB1950
  • TODJ2000
  • MeanJ2000

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:
  • GeocentricTODRotating
  • GeocentricMeanB1950
  • HeliocentricB1950
  • GeocentricMeanJ2000
  • HeliocentricJ2000

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:
  • GeocentricTODRotating
  • GeocentricMeanB1950

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:
  • GeocentricTODRotating
  • GeocentricMeanB1950

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:
  • GeocentricTODRotating

Note: 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.

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. If this option is not entered, the vehicle time period is used. For valid {TimeInterval} values see Time Options.

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. If this option is not entered, the vehicle time period is used. For valid {TimeInterval} values see Time Options.

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. If this option is not entered, the vehicle time period is used. For valid {TimeInterval} values see Time Options.

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. If this option is not entered, the vehicle time period is used. For valid {TimeInterval} values see Time Options.

If {Source} is NASAIIRV, valid {ExportOption} <Value> combinations are:

{ExportOption} <Value> Description
MissionID <ccc> <ccc> must be 3 characters.

Note: 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. If this option is not entered, the vehicle time period is used. For valid {TimeInterval} values see Time Options.

Example

Propagate Satellite2 using an external EPV file:

InitialState */Satellite/Satellite2 Import EPV "c:\stkdb\epvC1.epv"

To propagate Satellite2 using the iirvIPC3.iirv file:

InitialState */Satellite/Satellite2 Import IIRV "C:\stkdb\iirvIPC3.iirv"

Propagate TestSat2 using the last ephemeris point from the file Satellite1.e:

InitialState */Satellite/TestSat2 Import STKFile "C:\STKUser\TestScen\Satellite1.e" EpochSelect LastPoint

The following series of commands will create a satellite with Astrogator propagator and set the Initial State for the satellite:

New / */Satellite AstroSat2

Astrogator */Satellite/AstroSat2 SetProp

InitialState */Satellite/AstroSat2 Import STKFile "C:\STKUser\Satellite2.e" GatorPath "MainSEQUENCE.SegmentList.Initial_State"

Use the closest data point, in the file Satellite1.e, following the Epoch to set the initial state:

InitialState */Satellite/TestSat2 Import STKFile "C:\STKUser\TestScen\Satellite1.e" Epoch "1 Jul 2006 14:00:00.00" EpochSelect ClosestFollowing

Use the closest data point to the Epoch, from the ephemeris of TestSat1, to set the initial state:

InitialState */Satellite/TestSat1 Import STKEphem EpochSelect ClosestPoint Epoch "Scenario/FieldTestSc AnalysisStartTime"

Example

Create an IIRV T9 file from Satellite SunSync, with an SRP of 1.234 and a defined start and stop time:

InitialState */Satellite/SunSync Export IIRV9 "c:\stkdb\iirvIPC1.iirv9" GeocentricTODRotating SRP 1.234 UseStartStop "1 Jun 2002 12:00:00.00" "1 Jun 2002 18:00:00.00"

Create an IIRV file from Satellite Sat1, setting various parameters:

InitialState */Satellite/Sat1 Export IIRV "c:\stkdb\iirvIPC2.iirv" GeocentricTODRotating Destination SAE1 VectorType Cutoff VectorSource realtime SupportID 678 VehicleID 34 CounterStart 765

Create an IIRV T1 file from Missile Missile1:

InitialState */Missile/Missile1 Export IIRV1 "C:\Temp\InitialState\Missile1.iirv1" GeocentricTODRotating Drag 1.234 UseStartStop "1 Jul 2006 12:00:00.000" "1 Jul 2006 12:20:00.000"

Export an initial state file in NASA IIRV format, the following file will be created, ephmTc12009143:

InitialState */Satellite/Satellite1 Export NASAIIRV "C:\STKUser\IIRVFiles" GeocentricTODRotating MissionID Tc1

Export an initial state file in EPV format:

InitialState */Satellite/Satellite2 Export EPV "C:\STKUser\IIRVFiles\epvIPC1.epv" TODJ2000 MessageID 123 MessageOrigin KMR VehicleID 34 UseStartStop "Satellite/Satellite1 EphemerisTimeSpan Interval" SupportID 56

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Vehicles

Version

10

STK Programming Interface 11.0.1