Description | Example | Return Message | Group

VO Area

Calculate the area of a model

Syntax

VO <ObjectPath> Area {AreaOption} <Parameters>

Description

The VO Area command allows you to calculate the area of a model for a given direction, over a given time interval, such as an orbit period. Area is computed over time by animating the scenario and periodically counting the pixels corresponding to the model under consideration.

{AreaOption} <Parameters> Description>
Times {TimeInterval} <TimeStep> Specify a {TimeInterval} and a <TimeStep> for area analysis. If you do not set these parameters, they default to those set for the scenario.

For valid {TimeInterval} values see Time Options.

BoundRadius {On | Off} [<Radius>] Use the Bound Radius option to tailor your view to yield the optimal display for visualization and analysis. The field of view for area analysis is defined in terms of a rectangular plane rather than a linear boresight or direction of gaze. You can limit the size of that plane by specifying the <Radius> of a circle centered in the rectangle and touching its long sides; i.e., a circle having a radius equal to one half the length of one of the short sides of the rectangle. This ensures that, once the optimal dimension is set, the satellite remains within view even when rotated. If BoundRadius is On, <Radius> is entered in meters and is between 1.0 and 100000.
ViewDirection "<CrdnDef>" [{X | Y | Z}] Changing the view direction will manipulate the view in the Area window. Use the "<CrdnDef>" parameters to select the reference component from which the object in the Area window is being viewed. If the Type value is set to Axes, you, must set the direction (X, Y, or Z) in which the model area will be computed.
DeleteData N/A Deletes existing area data so that computer memory is restored once analysis is complete.
Compute N/A Calculate the area of the model in the view direction at each time step over the specified time period. Existing area data is automatically deleted whenever area data is computed.

If {AreaOption} is ViewDirection, "<CrdnDef>" can be:

{CrdnDef} <Parameters> Description
Type {Vector | Axes} Indicate whether you are applying the specified parameters to a vector or axes. If Axes, then the direction (X, Y, or Z) must be entered.
Name <NameOfVectorAxes> The name of the vector or axis to which the specified parameters are being applied.
{CBName <NameOfCB> | ObjectPath <ObjectPath>} N/A The keyword CBName and the name of the central body or the keyword ObjectPath and the path of the object to which the specified vector or axis relates.
ToObjectPath <ToObjectPath> The path of the object being pointed at, if the vector is one that points at another object.

Use the Window3D command with the SetRenderMethod option to set off screen rendering. The Area View window must be displayed before setting off screen rendering. The WindowID of the Window3D command must be the ID of the Area View. Use the VO_R MapID command to get the window ID of the Area View.

Example

To set the times to use for calculating area for attSat:

VO */Satellite/attSat Area Times "1 Jan 2001 02:00:00.00" "1 Jan 2001 03:00:00.00" 60.0

To turn on the BoundRadius for calculating the area for attSat, and setting it to 12300.0 m:

VO */Satellite/attSat Area BoundRadius On 12300.0

To compute the area of attSat:

VO */Satellite/attSat Area Compute

To delete the data created as result of a model area compute for attSat:

VO */Satellite/attSat Area DeleteData

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Facilities, Places & Targets

Object Tools

Vehicles

VO

VO Objects

Version

10

STK Programming Interface 11.0.1