Класс BigTiffOptions
Summary: The API for BigTIFF raster image format creation is specifically designed
to serve to the unique requirements of applications utilizing large-scale
imaging data from scanners. This API facilitates the seamless generation
of BigTIFF format, which combines multiple TIFF images into a single,
comprehensive image. It ensures efficient processing of extensive image
data, providing developers with a powerful tool for creating and
manipulating high-resolution, multi-image formats.
Module: aspose.imaging.imageoptions
Full Name: aspose.imaging.imageoptions.BigTiffOptions
Inheritance: IMetadataContainer, IHasExifData, IHasMetadata, IHasXmpData, TiffOptions
Constructors
| Name | Description |
|---|---|
| BigTiffOptions(expected_format) | Создаёт новый экземпляр класса BigTiffOptions. По умолчанию используется порядок байтов little endian. |
| BigTiffOptions(expected_format, byte_order) | Создаёт новый экземпляр класса BigTiffOptions. |
| BigTiffOptions(options) | Создаёт новый экземпляр класса BigTiffOptions. |
| BigTiffOptions(tags) | Создаёт новый экземпляр класса BigTiffOptions. |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| alpha_storage | TiffAlphaStorage | r/w | Получает или задает параметр хранения альфа-канала. Параметры, отличные от TiffAlphaStorage.UNSPECIFIED используются, когда определено более 3 TiffOptions.samples_per_pixel. |
| artist | string | r/w | Получает или задает исполнителя. |
| bits_per_pixel | int | r | Получает количество бит на пиксель. |
| bits_per_sample | int[] | r/w | Получает или задает количество бит на образец. |
| buffer_size_hint | int | r/w | Получает или задает подсказку о размере буфера, определяющую максимальный допустимый размер для всех внутренних буферов. |
| byte_order | TiffByteOrder | r/w | Получает или задает значение, указывающее порядок байтов TIFF. |
| color_map | int[] | r/w | Получает или задает карту цветов. |
| compressed_quality | int | r/w | Получает или задает качество сжатого изображения. Используется с компрессией JPEG. |
| compression | TiffCompressions | r/w | Получает или задает сжатие. |
| авторские права | string | r/w | Получает или задает авторские права. |
| дата_время | string | r/w | Получает или задает дату и время. |
| default_memory_allocation_limit | int | r/w | Получает или задает предельный объём памяти по умолчанию. |
| disable_icc_export | bool | r/w | Получает или задает значение, указывающее, отключён ли экспорт ICC‑профиля (ICC‑профиль применяется к исходным пикселям заранее). |
| disposed | bool | r | Получает значение, указывающее, удалён ли этот экземпляр. |
| document_name | string | r/w | Получает или задает имя документа. |
| exif_data | ExifData | r/w | Получает или задает данные Exif. |
| exif_ifd | TiffExifIfd | r | Получает или задает указатель на EXIF IFD. |
| extra_samples | int[] | r | Получает значения дополнительных образцов. |
| fax_t4_options | Group3Options | r/w | Получает или задает параметры fax t4. |
| file_standard | TiffFileStandards | r/w | Получает или задает стандарт файла TIFF. |
| fill_order | TiffFillOrders | r/w | Получает или задает порядок заполнения битов байта. |
| full_frame | bool | r/w | Получает или задает значение, указывающее, включен ли [full frame]. |
| half_tone_hints | int[] | r/w | Получает или задает подсказки полутонов. |
| описание_изображения | string | r/w | Получает или задает описание изображения. |
| длина_изображения | int | r/w | Получает или задает длину изображения. |
| ширина_изображения | int | r/w | Получает или задает ширину изображения. |
| ink_names | string | r/w | Получает или задает названия чернил. |
| is_extra_samples_present | bool | r | Получает значение, указывающее, присутствуют ли дополнительные образцы. |
| is_tiled | bool | r | Получает значение, указывающее, разбито ли изображение на плитки. |
| is_valid | bool | r | Получает значение, указывающее, правильно ли настроены TiffOptions. Используйте метод Validate, чтобы найти причину ошибки. |
| keep_metadata | bool | r/w | Получает значение, указывающее, сохранять ли оригинальные метаданные изображения при экспорте. |
| max_sample_value | int[] | r/w | Получает или задает максимальное значение образца. |
| min_sample_value | int[] | r/w | Получает или задает минимальное значение образца. |
| multi_page_options | MultiPageOptions | r/w | Параметры multipage |
| orientation | TiffOrientations | r/w | Получает или задает ориентацию. |
| page_name | string | r/w | Получает или задает имя страницы. |
| page_number | int[] | r/w | Получает или задает тег номера страницы. |
| palette | IColorPalette | r/w | Получает или задает цветовую палитру. |
| photometric | TiffPhotometrics | r/w | Получает или задает фотометрический параметр. |
| planar_configuration | TiffPlanarConfigs | r/w | Получает или задает планарную конфигурацию. |
| predictor | TiffPredictor | r/w | Получает или задает предсказатель для сжатия LZW. |
| premultiply_components | bool | r/w | Получает или задает значение, указывающее, должны ли компоненты быть предварительно умножены. |
| resolution_settings | ResolutionSetting | r/w | Получает или задает параметры разрешения. |
| resolution_unit | TiffResolutionUnits | r/w | Получает или задает единицу разрешения. |
| rows_per_strip | int | r/w | Получает или задает количество строк в полосе. |
| sample_format | TiffSampleFormats[] | r/w | Получает или задает формат образца. |
| samples_per_pixel | int | r | Получает количество образцов на пиксель. Чтобы изменить значение этого свойства, используйте сеттер свойства TiffOptions.bits_per_sample. |
| scanner_manufacturer | string | r/w | Получает или задает производителя сканера. |
| scanner_model | string | r/w | Получает или задает модель сканера. |
| smax_sample_value | int[] | r/w | Получает или задает максимальное значение образца. Значение имеет тип поля, который лучше всего соответствует данным образца (тип Byte, Short или Long). |
| smin_sample_value | int[] | r/w | Получает или задает минимальное значение образца. Значение имеет тип поля, который лучше всего соответствует данным образца (тип Byte, Short или Long). |
| software_type | string | r/w | Получает или задает тип программного обеспечения. |
| source | Source | r/w | Получает или задает источник, в котором создаётся изображение. |
| strip_byte_counts | int[] | r/w | Получает или задает количество байтов в полосе. |
| strip_offsets | int[] | r/w | Получает или задает смещения полос. |
| sub_file_type | TiffNewSubFileTypes | r/w | Получает или задает общее указание типа данных, содержащихся в этом подпфайле. |
| tag_count | int | r | Получает количество тегов. |
| tags | TiffDataType[] | r/w | Получает или задает теги. |
| target_printer | string | r/w | Получает или задает целевой принтер. |
| threshholding | TiffThresholds | r/w | Получает или задает пороговое значение. |
| tile_byte_counts | int[] | r/w | Получает или задает количество байтов в плитке. |
| tile_length | int | r/w | Получает или задает длину плитки. |
| tile_offsets | int[] | r/w | Получает или задает смещения плитки. |
| tile_width | int | r/w | Получает или задает ширину плитки. |
| total_pages | int | r | Получает общее количество страниц. |
| valid_tag_count | int | r | Получает количество действительных тегов. Это не общее количество тегов, а число тегов, которые могут быть сохранены. |
| vector_rasterization_options | VectorRasterizationOptions | r/w | Получает или задает параметры растеризации вектора. |
| xmp_data | XmpPacketWrapper | r/w | Получает или задает данные Xmp. |
| xp_author | string | r/w | Получает или задает автора изображения, который используется в Windows Explorer. |
| xp_comment | string | r/w | Получает или задает комментарий к изображению, который используется в Windows Explorer. |
| xp_keywords | string | r/w | Получает или задает тему изображения, которая используется в Windows Explorer. |
| xp_subject | string | r/w | Получает или задает информацию об изображении, которая используется в Windows Explorer. |
| xp_title | string | r/w | Получает или задает информацию об изображении, которая используется в Windows Explorer. |
| xposition | TiffRational | r/w | Получает или задает позицию по оси X. |
| xresolution | TiffRational | r/w | Получает или задает разрешение по оси X. |
| y_cb_cr_coefficients | TiffRational[] | r/w | Получает или задает коэффициенты YCbCr. |
| y_cb_cr_subsampling | int[] | r/w | Получает или задает коэффициенты субдискретизации для фотометрии YCbCr. |
| yposition | TiffRational | r/w | Получает или задает позицию по оси Y. |
| yresolution | TiffRational | r/w | Получает или задает разрешение по оси y. |
Methods
| Name | Description |
|---|---|
| add_tag(tag_to_add) | Добавляет новый тег. |
| add_tags(tags_to_add) | Добавляет теги. |
| clone() | Создаёт клон этого экземпляра. |
| create_with_format(expected_format) | Создаёт новый экземпляр класса BigTiffOptions. По умолчанию используется порядок байтов little endian. |
| create_with_options(options) | Создаёт новый экземпляр класса BigTiffOptions. |
| create_with_tags(tags) | Создаёт новый экземпляр класса BigTiffOptions. |
| get_tag_by_type(tag_key) | Получает экземпляр тега по типу. |
| get_valid_tags_count(tags) | Получает количество действительных тегов. |
| is_tag_present(tag) | Определяет, присутствует ли тег в параметрах или нет. |
| remove_tag(tag) | Удаляет тег. |
| remove_tags(tags) | Удаляет теги. |
| try_set_metadata(metadata) | Пытается установить экземпляр metadata, если этот экземпляр Image поддерживает и реализует экземпляр IImageMetadataFormat. |
| validate() | Проверяет, имеет ли параметры допустимую комбинацию тегов |
Constructor: BigTiffOptions(expected_format)
BigTiffOptions(expected_format)
Создаёт новый экземпляр класса BigTiffOptions. По умолчанию используется порядок байтов little endian.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| expected_format | TiffExpectedFormat | Ожидаемый формат файла Tiff. |
Constructor: BigTiffOptions(expected_format, byte_order)
BigTiffOptions(expected_format, byte_order)
Создаёт новый экземпляр класса BigTiffOptions.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| expected_format | TiffExpectedFormat | Ожидаемый формат файла Tiff. |
| byte_order | TiffByteOrder | Порядок байтов формата файла tiff, который следует использовать. |
Constructor: BigTiffOptions(options)
BigTiffOptions(options)
Создаёт новый экземпляр класса BigTiffOptions.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| options | TiffOptions | Источник параметров. |
Constructor: BigTiffOptions(tags)
BigTiffOptions(tags)
Создаёт новый экземпляр класса BigTiffOptions.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tags | TiffDataType[] | Теги для инициализации параметров. |
Method: add_tag(tag_to_add)
add_tag(tag_to_add)
Добавляет новый тег.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tag_to_add | TiffDataType | Тег для добавления. |
Method: add_tags(tags_to_add)
add_tags(tags_to_add)
Добавляет теги.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tags_to_add | TiffDataType[] | Теги для добавления. |
Method: clone()
clone()
Создаёт клон этого экземпляра.
Returns
| Тип | Описание |
|---|---|
| ImageOptionsBase | Возвращает глубокую копию. |
Method: create_with_format(expected_format) [static]
create_with_format(expected_format)
Создаёт новый экземпляр класса BigTiffOptions. По умолчанию используется порядок байтов little endian.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| expected_format | TiffExpectedFormat | Ожидаемый формат файла Tiff. |
Returns
| Тип | Описание |
|---|---|
| BigTiffOptions | Новый объект BigTiffOptions. |
Method: create_with_options(options) [static]
create_with_options(options)
Создаёт новый экземпляр класса BigTiffOptions.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| options | TiffOptions | Источник параметров. |
Returns
| Тип | Описание |
|---|---|
| BigTiffOptions | Копия параметров. |
Method: create_with_tags(tags) [static]
create_with_tags(tags)
Создаёт новый экземпляр класса BigTiffOptions.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tags | TiffDataType[] | Теги для инициализации параметров. |
Returns
| Тип | Описание |
|---|---|
| BigTiffOptions | Новый объект BigTiffOptions с тегами. |
Method: get_tag_by_type(tag_key)
get_tag_by_type(tag_key)
Получает экземпляр тега по типу.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tag_key | TiffTags | Ключ тега. |
Returns
| Тип | Описание |
|---|---|
| TiffDataType | Экземпляр тега, если он существует, иначе null. |
Method: get_valid_tags_count(tags) [static]
get_valid_tags_count(tags)
Получает количество действительных тегов.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tags | TiffDataType[] | Теги для проверки. |
Returns
| Тип | Описание |
|---|---|
| int | Количество допустимых тегов. |
Method: is_tag_present(tag)
is_tag_present(tag)
Определяет, присутствует ли тег в параметрах или нет.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tag | TiffTags | Идентификатор тега для проверки. |
Returns
| Тип | Описание |
|---|---|
| bool |
Method: remove_tag(tag)
remove_tag(tag)
Удаляет тег.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tag | TiffTags | Тег для удаления. |
Returns
| Тип | Описание |
|---|---|
| bool | true если успешно удалён |
Method: remove_tags(tags)
remove_tags(tags)
Удаляет теги.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| tags | TiffTags[] | Теги для удаления. |
Returns
| Тип | Описание |
|---|---|
| bool | True если размер коллекции тегов изменился. |
Method: try_set_metadata(metadata)
try_set_metadata(metadata)
Пытается установить экземпляр metadata, если этот экземпляр Image поддерживает и реализует экземпляр IImageMetadataFormat.
Parameters:
| Параметр | Тип | Описание |
|---|---|---|
| metadata | IImageMetadataFormat | Метаданные. |
Returns
| Тип | Описание |
|---|---|
| bool | Истина, если metadata не равно null и экземпляр IMetadataContainer поддерживает и/или реализует экземпляр IImageMetadataFormat; в противном случае — ложь. |