Description | Example | Return message | Group

EOIR_R PropertyMapData

Return information about EOIR texture maps.

Syntax

EOIR_R <ScenarioPath> PropertyMapData {Option} <CentralBodyName> [<Parameter>]

Description

Use the EOIR_R PropertyMapData command to retrieve texture map information from an EOIR configuration.

The following table describes the valid values for {Option} and associated parameters.

{Option} Description
GetNumberOfMaps <CentralBodyName>Returns the number of texture maps in an EOIR configuration.

<CentralBodyName> is the name of the central body for the scenario.

GetMapLabel <CentralBodyName> <MapIndex>Returns all the texture map names for an EOIR configuration.

<CentralBodyName> is the name of the central body for the scenario.

<MapIndex> is the list of names of the texture maps.

GetFile <CentralBodyName> <MapLabel>Returns the data file for a specific a texture map that has an array of values across the map.

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

GetCoordinateP{1-4}Lat <CentralBodyName> <MapLabel>Retrieves the latitude of one of the four corners of the texture map: P1 for northwest, P2 for northeast, P3 for southwest, and P4 for southeast. The latitude will be in degrees (-90 to 90).

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

GetCoordinateP{1-4}Lon <CentralBodyName> <MapLabel>Retrieves the longitude of one of the four corners of the texture map: P1 for northwest, P2 for northeast, P3 for southwest, and P4 for southeast. The longitude will be in degrees (-180 to 180).

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

GetMapType <CentralBodyName> <MapLabel>Retrieves the type of texture map associated with a <CentralBodyName> for the map named in <MapLabel>.

The possible types are:

  • Emissivity
  • Radiance
  • Reflectance
  • Temperature
GetConstantValue <CentralBodyName> <MapLabel> <ConstantValue>Retrieves the constant value associated with a texture map. The units are as follows:
  • Emissivity: a percentage
  • Radiance: W/(m2 sr um) or W/(cm2 sr um)
  • Reflectance: a percentage
  • Temperature: degrees Kelvin

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

GetWavelengthStart <CentralBodyName> <MapLabel>Retrieves the wavelength lower limit applied to a specific texture map. The unit for wavelength is um. These are not valid for SetMapType = Temperature.

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

GetWavelengthStop <CentralBodyName> <MapLabel>Retrieves the wavelength upper limit applied to a specific texture map. The unit for wavelength is um. These are not valid when GetMapType = Temperature.

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

GetShowMap <CentralBodyName> <MapLabel>Retrieves the setting of On or Off, showing whether or not the map is effective for the current EOIR configuration.

<CentralBodyName> is the name of the central body for the scenario.

<MapLabel> is the name of the texture map.

Examples

To retrieve a texture map name list

EOIR_R */ PropertyMapData GetNumberOfMaps Earth

To get the longitude for the northeast corner point of the texture map

EOIR_R */ PropertyMapData GetCoordinateP2Lon Earth AreaReflect1

To get the type of a specific texture map

EOIR_R */ PropertyMapData GetMapType Earth AreaReflect1

To get a texture map CSV file

EOIR_R */ PropertyMapData GetFile Earth AreaReflect1

To get the wavelength upper limit for a texture map

EOIR_R */ PropertyMapData GetWavelengthStop Earth AreaReflect1

To retrieve whether or not a texture map is turned on the EOIR configuration

EOIR_R */ PropertyMapData GetShowMap Earth AreaReflect1

Return message

Group membership

This command belongs to the following group(s):

Scenarios

Version

12.5