Jpeg2000WriterInitializer#

class ansys.stk.core.graphics.Jpeg2000WriterInitializer#

Convert an image, such as a BMP, to a GeoJP2 file that can be used as an image globe overlay.

Overview#

write_string

Convert an image, such as a BMP, to a GeoJP2 file that can be used as an image globe overlay. The extent of the image must be in the image, as in a GeoTIFF.

write_extent_string

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

write_extent_and_sub_extent_string

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

write_extent_and_sub_extent_transparent_color_string

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

write_extent_and_sub_extent_transparent_color_string_central_body

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

Import detail#

from ansys.stk.core.graphics import Jpeg2000WriterInitializer

Method detail#

Jpeg2000WriterInitializer.write_string(self, image_uri: str, compression_profile: Jpeg2000CompressionProfile, compression_rate: int, jpeg2000_uri: str, overwrite_existing_file: bool) None#

Convert an image, such as a BMP, to a GeoJP2 file that can be used as an image globe overlay. The extent of the image must be in the image, as in a GeoTIFF.

Parameters:

image_uri : str

compression_profile : Jpeg2000CompressionProfile

compression_rate : int

jpeg2000_uri : str

overwrite_existing_file : bool

Returns:

None

Jpeg2000WriterInitializer.write_extent_string(self, image_uri: str, extent: list, compression_profile: Jpeg2000CompressionProfile, compression_rate: int, jpeg2000_uri: str, overwrite_existing_file: bool) None#

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

Parameters:

image_uri : str

extent : list

compression_profile : Jpeg2000CompressionProfile

compression_rate : int

jpeg2000_uri : str

overwrite_existing_file : bool

Returns:

None

Jpeg2000WriterInitializer.write_extent_and_sub_extent_string(self, image_uri: str, extent: list, sub_extent: list, compression_profile: Jpeg2000CompressionProfile, compression_rate: int, jpeg2000_uri: str, overwrite_existing_file: bool) None#

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

Parameters:

image_uri : str

extent : list

sub_extent : list

compression_profile : Jpeg2000CompressionProfile

compression_rate : int

jpeg2000_uri : str

overwrite_existing_file : bool

Returns:

None

Jpeg2000WriterInitializer.write_extent_and_sub_extent_transparent_color_string(self, image_uri: str, extent: list, sub_extent: list, compression_profile: Jpeg2000CompressionProfile, compression_rate: int, jpeg2000_uri: str, overwrite_existing_file: bool, transparent_color: agcolor.Color) None#

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

Parameters:

image_uri : str

extent : list

sub_extent : list

compression_profile : Jpeg2000CompressionProfile

compression_rate : int

jpeg2000_uri : str

overwrite_existing_file : bool

transparent_color : Color

Returns:

None

Jpeg2000WriterInitializer.write_extent_and_sub_extent_transparent_color_string_central_body(self, image_uri: str, extent: list, sub_extent: list, compression_profile: Jpeg2000CompressionProfile, compression_rate: int, jpeg2000_uri: str, overwrite_existing_file: bool, transparent_color: agcolor.Color, central_body_name: str) None#

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

Parameters:

image_uri : str

extent : list

sub_extent : list

compression_profile : Jpeg2000CompressionProfile

compression_rate : int

jpeg2000_uri : str

overwrite_existing_file : bool

transparent_color : Color

central_body_name : str

Returns:

None