TiffBitmapFactory.Options (Android-TiffBitmapFactory 0.9.9.1 API)

java.lang.Object
- org.beyka.tiffbitmapfactory.TiffBitmapFactory.Options

Enclosing class:: TiffBitmapFactory

public static final class TiffBitmapFactory.Options
extends java.lang.Object

Options class to specify decoding parameterMs

Field Summary

Fields
Modifier and Type	Field and Description
`long`	`inAvailableMemory` Number of bytes that may be allocated during the Tiff file operations.
`DecodeArea`	`inDecodeArea` If this field is non-null - Decoder will decode and return only area specified in `DecodeArea` object For decoding not full bitmap, but only part of it - create new `DecodeArea` object and specify: `x`, `y` - left top corner of decoding area `width` - width of decoding area `height` - height of decoding area
`int`	`inDirectoryNumber` Set directory to extract from image.
`boolean`	`inJustDecodeBounds` If set to true, the decoder will return null (no bitmap), but the out... fields will still be set, allowing the caller to query the bitmap without having to allocate the memory for its pixels.
`TiffBitmapFactory.ImageConfig`	`inPreferredConfig` If this is non-null, the decoder will try to decode into this internal configuration.
`int`	`inSampleSize` If set to a value > 1, requests the decoder to subsample the original image, returning a smaller image to save memory.
`boolean`	`inSwapRedBlueColors` If set to true, the decoder will swap red and blue colors.
`boolean`	`inThrowException` If set to true, decoder will throw exceptions if some errors appeared while decoding.
`boolean`	`inUseOrientationTag` If set to true decoder will rotate and flip image according to TIFFTAG_ORIENTATION.
`java.lang.String`	`outAuthor` Author of file.
`int`	`outBitsPerSample` Number of bits per component.
`CompressionScheme`	`outCompressionScheme` This parameter returns compression scheme of decoded image For storing compression mode uses `CompressionScheme` enum This parameter is link to TIFFTAG_COMPRESSION tag
`java.lang.String`	`outCopyright` Copyright of file This parameter is link to TIFFTAG_COPYRIGHT tag
`int`	`outCurDirectoryNumber` The number of current directory.
`java.lang.String`	`outDatetime` Date and time of image creation.
`int`	`outDirectoryCount` The count of directory in image file.
`FillOrder`	`outFillOrder` The logical order of bits within a byte.
`int`	`outHeight` The resulting height of the bitmap.
`java.lang.String`	`outHostComputer` The computer and/or operating system in use at the time of image creation.
`java.lang.String`	`outImageDescription` A string that describes the subject of the image.
`Orientation`	`outImageOrientation` This parameter returns orientation of decoded image For storing orientation uses `ImageOrientation` enum If image wasn't decoded successful this parameter will be equal to `Orientation.UNAVAILABLE` This parameter is link to TIFFTAG_ORIENTATION tag
`int`	`outNumberOfStrips` Number of strips in the image.
`Photometric`	`outPhotometric` The color space of the image data.
`PlanarConfig`	`outPlanarConfig` How the components of each pixel are stored.
`ResolutionUnit`	`outResolutionUnit` The unit of measurement for XResolution and YResolution.
`int`	`outRowPerStrip` The number of rows per strip.
`int`	`outSamplePerPixel` The number of components per pixel.
`java.lang.String`	`outSoftware` Name and version number of the software package(s) used to create the image.
`int`	`outStripSize` Size for a strip of data in bytes.
`int`	`outTileHeight` The tile height in pixels.
`int`	`outTileWidth` The tile width in pixels.
`int`	`outWidth` The resulting width of the bitmap.
`float`	`outXResolution` The number of pixels per `outResolutionUnit` in the ImageWidth direction.
`float`	`outYResolution` The number of pixels per `outResolutionUnit` in the ImageHeight direction.

Constructor Summary

Constructors
Constructor and Description

Options()
Create a default Options object, which if left unchanged will give the same result from the decoder as if null were passed.

Constructors
Constructor and Description
`Options()` Create a default Options object, which if left unchanged will give the same result from the decoder as if null were passed.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type Method and Description

void stop()
Deprecated.
As of release 0.9.8.4, replaced by Thread.interrupt()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`stop()` Deprecated. As of release 0.9.8.4, replaced by `Thread.interrupt()`

- Field Detail
  - inUseOrientationTag
```
public boolean inUseOrientationTag
```
    If set to true decoder will rotate and flip image according to TIFFTAG_ORIENTATION. Otherwise image will be returned as it decoded.
    The specification considers this a baseline tag, but does add that support for orientations other than 1 is not a Baseline TIFF requirement.
    So for almost all cases this variable may be false.
    Default value is false
  - inThrowException
```
public boolean inThrowException
```
    If set to true, decoder will throw exceptions if some errors appeared while decoding. Otherwise decoder will just return null. Default value is false
  - inSwapRedBlueColors
```
public boolean inSwapRedBlueColors
```
    If set to true, the decoder will swap red and blue colors.
    Note: If you use this option then your image has wrong encoding
    
    Default value is false
  - inJustDecodeBounds
```
public boolean inJustDecodeBounds
```
    If set to true, the decoder will return null (no bitmap), but the out... fields will still be set, allowing the caller to query the bitmap without having to allocate the memory for its pixels.
  - inSampleSize
```
public int inSampleSize
```
    If set to a value > 1, requests the decoder to subsample the original image, returning a smaller image to save memory. The sample size is the number of pixels in either dimension that correspond to a single pixel in the decoded bitmap. For example, inSampleSize == 4 returns an image that is 1/4 the width/height of the original, and 1/16 the number of pixels. Any value <= 1 is treated the same as 1. Note: the decoder uses a final value based on powers of 2, any other value will be rounded down to the nearest power of 2.
  - inDirectoryNumber
```
public int inDirectoryNumber
```
    Set directory to extract from image. Default value is 0. To get number of directories in file see outDirectoryCount
  - inAvailableMemory
```
public long inAvailableMemory
```
    Number of bytes that may be allocated during the Tiff file operations.
    -1 means memory is unlimited.
    
    Default value is 244Mb
  - inPreferredConfig
```
public TiffBitmapFactory.ImageConfig inPreferredConfig
```
    If this is non-null, the decoder will try to decode into this internal configuration. If it is null, or the request cannot be met, the decoder will use TiffBitmapFactory.ImageConfig.ARGB_8888 configuration.
    Numeration starts with 0
    
    Image are loaded with the TiffBitmapFactory.ImageConfig.ARGB_8888 config by default.
    
    In current version supported are TiffBitmapFactory.ImageConfig.ARGB_8888, TiffBitmapFactory.ImageConfig.ALPHA_8 and TiffBitmapFactory.ImageConfig.RGB_565
  - inDecodeArea
```
public DecodeArea inDecodeArea
```
    If this field is non-null - Decoder will decode and return only area specified in DecodeArea object For decoding not full bitmap, but only part of it - create new DecodeArea object and specify:
    x, y - left top corner of decoding area
    
    width - width of decoding area
    
    height - height of decoding area
  - outWidth
```
public int outWidth
```
    The resulting width of the bitmap. If inJustDecodeBounds is set to false, this will be width of the output bitmap after any scaling is applied. If true, it will be the width of the input image without any accounting for scaling.
    outWidth will be set to -1 if there is an error trying to decode.
  - outHeight
```
public int outHeight
```
    The resulting height of the bitmap. If inJustDecodeBounds is set to false, this will be height of the output bitmap after any scaling is applied. If true, it will be the height of the input image without any accounting for scaling.
    outHeight will be set to -1 if there is an error trying to decode.
  - outCurDirectoryNumber
```
public int outCurDirectoryNumber
```
    The number of current directory.
    curDirectoryNumber will be set to -1 if there is an error trying to decode.
  - outDirectoryCount
```
public int outDirectoryCount
```
    The count of directory in image file.
    outDirectoryCount will be set to -1 if there is an error trying to decode.
  - outImageOrientation
```
public Orientation outImageOrientation
```
    This parameter returns orientation of decoded image
    For storing orientation uses ImageOrientation enum
    
    If image wasn't decoded successful this parameter will be equal to Orientation.UNAVAILABLE
    
    This parameter is link to TIFFTAG_ORIENTATION tag
  - outCompressionScheme
```
public CompressionScheme outCompressionScheme
```
    This parameter returns compression scheme of decoded image
    For storing compression mode uses CompressionScheme enum
    
    This parameter is link to TIFFTAG_COMPRESSION tag
  - outPlanarConfig
```
public PlanarConfig outPlanarConfig
```
    How the components of each pixel are stored.
    The specification defines these values:
    - 1 = Chunky format. The component values for each pixel are stored contiguously. For example, for RGB data, the data is stored as RGBRGBRGB
    - 2 = Planar format. The components are stored in separate component planes. For example, RGB data is stored with the Red components in one component plane, the Green in another, and the Blue in another.
    This parameter is link to TIFFTAG_PLANARCONFIG tag
  - outSamplePerPixel
```
public int outSamplePerPixel
```
    The number of components per pixel.
    SamplesPerPixel is usually 1 for bilevel, grayscale, and palette-color images. SamplesPerPixel is usually 3 for RGB images. If this value is higher, ExtraSamples should give an indication of the meaning of the additional channels.
  - outBitsPerSample
```
public int outBitsPerSample
```
    Number of bits per component.
  - outXResolution
```
public float outXResolution
```
    The number of pixels per outResolutionUnit in the ImageWidth direction.
  - outYResolution
```
public float outYResolution
```
    The number of pixels per outResolutionUnit in the ImageHeight direction.
  - outResolutionUnit
```
public ResolutionUnit outResolutionUnit
```
    The unit of measurement for XResolution and YResolution.
    The specification defines these values:
    - RESUNIT_NONE
    - RESUNIT_INCH
    - RESUNIT_CENTIMETER
    This parameter is link to TIFFTAG_RESOLUTIONUNIT tag
  - outTileWidth
```
public int outTileWidth
```
    The tile width in pixels. This is the number of columns in each tile.
  - outTileHeight
```
public int outTileHeight
```
    The tile height in pixels. This is the number of rows in each tile.
  - outRowPerStrip
```
public int outRowPerStrip
```
    The number of rows per strip.
    RowsPerStrip and ImageLength together tell us the number of strips in the entire image.
  - outStripSize
```
public int outStripSize
```
    Size for a strip of data in bytes.
  - outNumberOfStrips
```
public int outNumberOfStrips
```
    Number of strips in the image.
  - outPhotometric
```
public Photometric outPhotometric
```
    The color space of the image data.
    This parameter is link to TIFFTAG_PHOTOMETRIC tag
  - outFillOrder
```
public FillOrder outFillOrder
```
    The logical order of bits within a byte.
    The specification defines these values:
    - 1 = Pixels with lower column values are stored in the higher-order bits of the byte.
    - 2 = Pixels with lower column values are stored in the lower-order bits of the byte.
    This parameter is link to TIFFTAG_PLANARCONFIG tag
  - outAuthor
```
public java.lang.String outAuthor
```
    Author of file.
    This parameter is link to TIFFTAG_ARTIST tag
  - outCopyright
```
public java.lang.String outCopyright
```
    Copyright of file
    This parameter is link to TIFFTAG_COPYRIGHT tag
  - outImageDescription
```
public java.lang.String outImageDescription
```
    A string that describes the subject of the image.
    This parameter is link to TIFFTAG_IMAGEDESCRIPTION tag
  - outSoftware
```
public java.lang.String outSoftware
```
    Name and version number of the software package(s) used to create the image.
    This parameter is link to TIFFTAG_SOFTWARE tag
  - outDatetime
```
public java.lang.String outDatetime
```
    Date and time of image creation. The format is: "YYYY:MM:DD HH:MM:SS", with hours like those on a 24-hour clock.
    This parameter is link to TIFFTAG_DATETIME tag
  - outHostComputer
```
public java.lang.String outHostComputer
```
    The computer and/or operating system in use at the time of image creation.
    This parameter is link to TIFFTAG_HOSTCOMPUTER tag
- Constructor Detail
  - Options
```
public Options()
```
    Create a default Options object, which if left unchanged will give the same result from the decoder as if null were passed.
- Method Detail
  - stop
```
public void stop()
```
    Deprecated. As of release 0.9.8.4, replaced by Thread.interrupt()
    
    Stop native decoding thread If decoding is started in any thread except main, calling of this method will cause force stop of decoding and returning of null object.

Class TiffBitmapFactory.Options

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inUseOrientationTag

inThrowException

inSwapRedBlueColors

inJustDecodeBounds

inSampleSize

inDirectoryNumber

inAvailableMemory

inPreferredConfig

inDecodeArea

outWidth

outHeight

outCurDirectoryNumber

outDirectoryCount

outImageOrientation

outCompressionScheme

outPlanarConfig

outSamplePerPixel

outBitsPerSample

outXResolution

outYResolution

outResolutionUnit

outTileWidth

outTileHeight

outRowPerStrip

outStripSize

outNumberOfStrips

outPhotometric

outFillOrder

outAuthor

outCopyright

outImageDescription

outSoftware

outDatetime

outHostComputer

Constructor Detail

Options

Method Detail

stop