Collection
Create and set the features of a Satellite Collection object.
Syntax
Collection <objPath> {Define|Interval|Metadata|Promote|Reference|Subset} <Parameters>
Description
The Collection Connect command enables you to create a Satellite Collection object and set its features. The command has six unique action options (Define|Interval|Metadata|Promote|Reference|Subset) associated with it. For a description of the Define action option for creating a satellite collection, see Collection Define. This topic page provides descriptions and examples of the other five action options that set the features of an existing satellite collection.
Interval
The Interval action option has the following format:
Interval <value1> [<value2>]
It sets the analysis interval for the satellite collection. You can use <value1> as a start time (in Connect units), a Time Instant time component, or a Time Interval time component. If <value1> is not a Time Interval Component, then <value2> is the stop time (in Connect units), a Time Instant time component, or a duration represented as a time increment.
Metadata
The Metadata action option has the following format:
Metadata {[Specify <"filename"> | CreateEmptyFile <"filename"> | Remove | Reload]}
The following table describes the Metadata optional parameters:
Optional Parameters | Description |
---|---|
Specify <"filename"> | This sets the supplemental metadata file and reads the data into the satellite collection. |
CreateEmptyFile <"filename"> | This creates a template metadata file with the specified filename using the current satellite collection entry names. |
Remove | This removes any supplemental metadata file and its data from use in the satellite collection. |
Reload | This reloads the data from the currently specified metadata file of the satellite collection. |
Promote
The Promote action option has the following format:
Promote {[Entry <name> | PromotedName <name> | Subset <name> | All]}
The following table describes the Promote optional parameters:
Optional Parameters | Description |
---|---|
Entry <name> | This promotes the specified satellite collection entry as an STK object. It uses <name> as the name unless you use PromotedName to set the name of the promoted object. |
PromotedName <name> | This sets the name of the promoted object when specifying an entry using Entry. |
Subset <name> | This promotes all satellite collection entries belonging to the specified Subset as an STK object. The name of each promoted object will be the same as the entry name in the Subset. |
All | This promotes all satellite collection entries as an STK object. The name of each promoted object will be the same as the entry name in the Subset. CAUTION: The whole point of using a satellite collection is to avoid the creation of individual STK objects. This "All" option is best used when the number of entries in the satellite collection is small, at most a few hundred. |
CreateConstellation <name> | This promotes a satellite collection subset as an STK Constellation object, with the name you specify. The subset becoming a constellation is identified in the Subset parameter. |
If you provide more than one action (Entry, Subset, All), STK will only act on the last action, unless the last action is All and Subset <name> appears earlier. In that case, STK will act on Subset.
Reference
The Reference action option has the following format:
Reference {[Specify {Default | Subset <"subsetName">} ReferenceObject <"objectPath"> | Remove {Default | Subset <"subsetName">} ]}
The following table describes the Reference optional parameters:
Optional Parameters | Description |
---|---|
Specify Default ReferenceObject <"objectPath"> | This sets the default Reference object. |
Specify Subset <"subsetName"> ReferenceObject <"objectPath"> | This sets the Reference object for the specified Subset. |
Remove Default | This removes the default Reference object. |
Remove Subset <"subsetName"> | This removes the Reference object for the specified Subset. |
Subset
The Subset action option has the following format:
Subset {[ AutoGeneration {Yes|On|True|No|Off|False} | Remove <"subsetName"> | Modify <"subsetName"> (params) | Specify <"subsetName"> (params)]}
The following table describes the Subset optional parameters:
Optional Parameters | Description |
---|---|
Remove <"subsetName"> | This removes the existing specified Subset of the satellite collection. |
Modify <"subsetName"> {[ObjectType <typeName>] [QueryExpression <expression>]} | This modifies the subset of the specified name of the satellite collection. The typeName is Satellite or the class name of a valid subobject for a satellite. If set, the ObjectType sets the type of object that Subset represents; otherwise, the type will be Satellite. If you provide <expression>, then the satellite entries belonging to the subset will be those for which the query expression is true. See below for formatting a valid query expression. |
Specify <"subsetName"> {[ObjectType <typeName>] [QueryExpression <expression>]} | This creates a Subset of the specified name in the satellite collection. The typeName is Satellite or the class name of a valid subObject for a Satellite. If set, the ObjectType sets the type of object that Subset represents; otherwise, the type will be Satellite. If you provide <expression>, then the satellite entries belonging to the subset will be those for which the query expression is true. See below for formatting a valid query expression. |
QueryExpression
A query expression is a boolean expression comprised of metadata criteria and the standard boolean operators (AND, OR, NOT).
The metadata criteria require the values of metadata, and supplemental metadata if you provide any, to meet certain specified objectives.
A criterion's objectives depend on the value type of a particular metadata item. Here is a list of possibilities:
Value Type | Data Type | Criteria | Example |
---|---|---|---|
Bool | Bool | Eq <val>, where <val> = {True, Yes, On, 1, False, No, Off, 0} | Decayed Eq False, Targeted Eq Yes |
Integer | Integer | Eq <val>
Min <minVal> Max <maxVal> Min <minVal> Max <maxVal> | Count Eq 6
Index Min -2 NumElsets Max 4 NumElsets Min 3 Max 10 |
String | String | Eq <val>
Contains <val> Matches <val> Note: Use quotes when <val> contains spaces (e.g., "Block II"). You can use wilcard charcaters for Matches: * matches 0 or more characters; ? matches 1 character. | Name Eq "Block II"
Name Contains Block Name Matches GPS-??, CommonName Matches STARLINK* |
Epoch | String | Eq <val> [<format>]
Min <minVal> [<format>] Max <maxVal> [<format>] Min <minVal> Max <maxVal> [<format>] Note: If you do not specify a format, STK assumes the default format ISO-YMD. | StartTime Eq 2023-02-14T12:30:00
LaunchDate Min "14 Feb 2023 12:30:00" UTCG LaunchDate Max "15 Mar 2023 16:00:00.00" GPSG LaunchDate Min "2023/02/14 00:00:00" Max "2023/02/28 12:00:00" YYYY/MM/DD |
Enumeration | String | IN <val1>|<val2>|...|<valN>
Note: Use quotes when <val> contains spaces (e.g., "Block II"). | FreqBand IN C|Ka|Ku|S|X, Color IN Red|Blue|"Light Green"|Purple |
Real | Real | Eq <val>
Min <minVal> Max <maxVal> Min <minVal> Max <maxVal> | Rcs Eq 3.1
Rcs Min 1.5 Rcs Max 7.9 Offset Min -2.5 Max 2.5 |
Quantity | String | Eq <val> [<units>]
Min <minVal> [<units>] Max <maxVal> [<units>] Min <minVal> Max <maxVal> [<units>] Note: The units must be applicable for the dimension of the metadata item, as reported from the Satellite Collection's Configuration report. If you do not specify units, STK assumes the default is as reported from that same report. | Size Eq 100.5 m
Speed Min 6.25 m/sec Altitude Max 125.0 m Inclination Min 45.0 Max 75.0 deg |
Criteria may appear as arguments to boolean operators, as shown in the following table:
Operator | Expression | Examples |
---|---|---|
NOT | NOT(criterion) | NOT(NumElsets Min 3 Max 10), NOT(FreqBand IN Ka|Ku), NOT(Inclination Min 45.0 Max 75.0 deg) |
AND | AND(crit1, crit2, crit3, .. critN) | AND(Decayed Eq False, LaunchDate Min "14 Feb 2023 12:30:00" UTCG, Rcs Min 1.5) |
OR | OR(crit1, crit2, crit3, .. critN) | OR(Name Contains NAVSTAR, Name Contains GPS, Period Min 11.5 hr Max 12.5 hr) |
Expressions may also contain nested operators, for example AND(crit1, NOT(crit2), OR(crit3, crit4)), OR(AND(crit1, crit2), AND(crit3, NOT(crit4)), etc.
However, the Satellite Collection Subset user interface is restricted in its ability to display complicated boolean expressions. Here are examples of things you can and cannot do:
- You can use enumerations allowing multiple values using an OR operator. For example, "Name IN val1|val2" is displayed as "OR(Name is val1, Name is val2)".
- You can use negated enumerations using an AND operator. For example, "NOT(Name IN val1|val2)" is displayed as "AND(Name is not val1),Name is not val2)".
- STK supports Min/Max queries in the user interface using an AND operator. For example, "Name Min minVal Max maxVal" is displayed as "AND(Name >= minVal, Name <= maxVal)".
- You can use negated Min/Max queries using an OR operator. For example, "NOT(Name Min minVal Max maxVal)" is displayed as "OR(Name <= minVal),Name >= maxVal))".
- NOT can only be a criterion argument, not an operator expression. For example, you cannot use NOT(AND(crit1, crit2)), but you can use its equivalent OR(NOT(crit1), NOT(crit2)).
Caution: The Subset user interface doesn't strictly implement NOT. For example, while the criterion "Name Min 4" is displayed as "Name >= 4", "NOT(Name Min 4)" is displayed as "Name <= 4", which is not the equivalent for an entry with a value of exactly 4.
- AND supports any number of criteria as arguments and one OR argument that itself does not contains only criteria and not any OR and AND subexpressions.
- AND supports only two arguments when each is an AND or OR expression. Examples are AND(OR(criteria), OR(criteria)), AND(AND(criteria), OR(criteria)), and AND(AND(criteria), AND(criteria)).
- OR supports any number of criteria as arguments and one OR argument that itself does not contains only criteria and not any OR and AND subexpressions.
- OR supports only two arguments when each is an AND or OR expression. Examples are OR(AND(criteria), AND(criteria)), OR(OR(criteria), AND(criteria)), and OR(OR(criteria), OR(criteria)).
Examples
Analysis interval sets the interval over which the Satellite Collection is valid
Supplemental Metadata
Reference object association
Subset Creation and Removal; examples assume Walker was used to create entries with "Plane" metadata
Object Promotion
Query Expressions
Return message
Group membership
This command belongs to the following group(s):
Version
12.8