STK Graphics Primitives	Send comments on this topic.
WriteExtentString Method (IAgStkGraphicsJpeg2000WriterInitializer)
See Also

ImageUri: The image filename to be converted. Only file URIs are supported.

Extent: An array representing the Cartographic Extent of the image. The elements should be provided in the order west longitude, south latitude, east longitude, north latitude. The extent can be null if the image defines the extent as with a GeoTIFF image.

CompressionProfile: The compression profile.

CompressionRate: A higher compression rate results in smaller JPEG 2000 files. Use 1 for no compression. Valid values are 1 to 65535.

Jpeg2000Uri: The JPEG 2000 filename. Only file URIs are supported.

OverwriteExistingFile: If true and the JPEG 2000 file already exists, the file will be overwritten during the conversion.

Description

Converts an image, such as a BMP, to a GeoJP2 file that can be used as an image globe overlay. The extent of the image can be defined as an input parameter if necessary.

Syntax

[Visual Basic .NET]
Public Sub WriteExtentString( _ ByVal ImageUri As String, _ ByVal Extent As System.Array, _ ByVal CompressionProfile As AgEStkGraphicsJpeg2000CompressionProfile, _ ByVal CompressionRate As Integer, _ ByVal Jpeg2000Uri As String, _ ByVal OverwriteExistingFile As Boolean _ )

[Visual Basic .NET]

Public Sub WriteExtentString( _
    ByVal ImageUri As String, _
    ByVal Extent As System.Array, _
    ByVal CompressionProfile As AgEStkGraphicsJpeg2000CompressionProfile, _
    ByVal CompressionRate As Integer, _
    ByVal Jpeg2000Uri As String, _
    ByVal OverwriteExistingFile As Boolean _
)

[C#]
public void WriteExtentString( string ImageUri, System.Array Extent, AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile, int CompressionRate, string Jpeg2000Uri, bool OverwriteExistingFile );

[C#]

public void WriteExtentString(
    string ImageUri,
    System.Array Extent,
    AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile,
    int CompressionRate,
    string Jpeg2000Uri,
    bool OverwriteExistingFile
);

[Managed C++]
public: void WriteExtentString( String __gc ^ ImageUri, System::Array ^ Extent, AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile, int CompressionRate, String __gc ^ Jpeg2000Uri, bool OverwriteExistingFile );

[Managed C++]

public: void WriteExtentString(
    String __gc ^ ImageUri,
    System::Array ^ Extent,
    AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile,
    int CompressionRate,
    String __gc ^ Jpeg2000Uri,
    bool OverwriteExistingFile
);

[Unmanaged C++]
public: HRESULT WriteExtentString( BSTR ImageUri, SAFEARRAY * * Extent, AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile, int CompressionRate, BSTR Jpeg2000Uri, VARIANT_BOOL OverwriteExistingFile );

[Unmanaged C++]

public: HRESULT WriteExtentString(
    BSTR ImageUri,
    SAFEARRAY * * Extent,
    AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile,
    int CompressionRate,
    BSTR Jpeg2000Uri,
    VARIANT_BOOL OverwriteExistingFile
);

[Java]
public void writeExtentString( String ImageUri, AgSafeArray Extent, AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile, Integer CompressionRate, String Jpeg2000Uri, bool OverwriteExistingFile );

[Java]

public void writeExtentString(
    String ImageUri,
    AgSafeArray Extent,
    AgEStkGraphicsJpeg2000CompressionProfile CompressionProfile,
    Integer CompressionRate,
    String Jpeg2000Uri,
    bool OverwriteExistingFile
);

[Python - STK API ]
def WriteExtentString(self, ImageUri:str, Extent:list, CompressionProfile:"AgEStkGraphicsJpeg2000CompressionProfile", CompressionRate:int, Jpeg2000Uri:str, OverwriteExistingFile:bool) -> None:

[Python - STK API

]

def WriteExtentString(self, ImageUri:str, Extent:list, CompressionProfile:"AgEStkGraphicsJpeg2000CompressionProfile", CompressionRate:int, Jpeg2000Uri:str, OverwriteExistingFile:bool) -> None:

Parameters

ImageUri: The image filename to be converted. Only file URIs are supported.
Extent: An array representing the Cartographic Extent of the image. The elements should be provided in the order west longitude, south latitude, east longitude, north latitude. The extent can be null if the image defines the extent as with a GeoTIFF image.
CompressionProfile: The compression profile.
CompressionRate: A higher compression rate results in smaller JPEG 2000 files. Use 1 for no compression. Valid values are 1 to 65535.
Jpeg2000Uri: The JPEG 2000 filename. Only file URIs are supported.
OverwriteExistingFile: If true and the JPEG 2000 file already exists, the file will be overwritten during the conversion.

Example

Shows the format of the Extent and SubExtent parameters when writing using a Jpeg 2000 Writer.