Packages

 

com.aspose.cad.imageoptions

Class TiffOptions



  • public class TiffOptions
    extends ImageOptionsBase

    The tiff file format options. Note that width and height tags will get overwritten on image creation by width and height parameters so there is no need to specify them directly. Note that many options return a default value but that does not mean that this option is set explicitly as a tag value. To verify the tag is present use Tags property or the corresponding IsTagPresent method.

    <developer_tip> WARNING! never modify tiff options during save since this may cause side effects and hard to find bugs. The following line was specially left commented since it caused incorrect determination of data beginning. The passed options did not contain spp (although the options are not correct in such case but still this scenario causes errors) and the next line caused +spp tag +bpp tag added and when options were written after data completely written they have overwritten the data beginning for uncompressed codec!!! See TiffUncompressedCodec.Encode. this.Options.SamplesPerPixel = 3; </developer_tip>
    • Constructor Detail

      • TiffOptions

        public TiffOptions(int expectedFormat,
                           int byteOrder)

        Initializes a new instance of the TiffOptions class.

        Parameters:
        expectedFormat - The expected tiff file format.
        byteOrder - The tiff file format byte order to use.
      • TiffOptions

        public TiffOptions(int expectedFormat)

        Initializes a new instance of the TiffOptions class. By default little endian convention is used.

        Parameters:
        expectedFormat - The expected tiff file format.
      • TiffOptions

        public TiffOptions(TiffOptions options)

        Initializes a new instance of the TiffOptions class.

        Parameters:
        options - The options to copy from.
      • TiffOptions

        public TiffOptions(TiffDataType[] tags)

        Initializes a new instance of the TiffOptions class.

        Parameters:
        tags - The tags to initialize options with.
    • Method Detail

      • isValid

        public boolean isValid()

        Gets a value indicating whether the TiffOptions have been properly configured. Use Validate method as to find the failure reason.

        Returns:
        true if TiffOptions are properly configured; otherwise, false.
      • getArtist

        public String getArtist()

        Gets the artist.

        Returns:
        The artist.
      • setArtist

        public void setArtist(String value)

        Sets the artist.

        Parameters:
        value - The artist.
      • isTagPresent

        public boolean isTagPresent(int tag)

        Determines whether tag is present in the options or not.

        Parameters:
        tag - The tag id to check.
        Returns:
        true if tag is present; otherwise, false.
      • getByteOrder

        public int getByteOrder()

        Gets a value indicating the tiff byte order.

        Returns:
        A value indicating the tiff byte order.
        See Also:
        TiffByteOrder
      • setByteOrder

        public void setByteOrder(int value)

        Sets a value indicating the tiff byte order.

        Parameters:
        value - A value indicating the tiff byte order.
        See Also:
        TiffByteOrder
      • getIccProfile

        public byte[] getIccProfile()

        Gets the icc profile stream.

        Returns:
        The icc profile.
      • getIccProfileInternal_internalized

        public com.aspose.ms.System.IO.MemoryStream getIccProfileInternal_internalized()
      • getBitsPerSample

        public int[] getBitsPerSample()

        Gets the bits per sample.

        Returns:
        The bits per sample value.

        When setting this value keep in mind that it will also set SamplesPerPixel value to array length. These 2 properties are very tightly coupled so may be set alltogether only.

      • setBitsPerSample

        public void setBitsPerSample(int[] value)

        Sets the bits per sample.

        Parameters:
        value - The bits per sample value.

        When setting this value keep in mind that it will also set SamplesPerPixel value to array length. These 2 properties are very tightly coupled so may be set alltogether only.

      • getCompression

        public int getCompression()

        Gets the compression.

        Returns:
        The compression.
      • setCompression

        public void setCompression(int value)

        Sets the compression.

        Parameters:
        value - The compression.
      • getCopyright

        public String getCopyright()

        Gets the copyright.

        Returns:
        The copyright.
      • setCopyright

        public void setCopyright(String value)

        Sets the copyright.

        Parameters:
        value - The copyright.
      • getColorMap

        public int[] getColorMap()

        Gets the color map.

        Returns:
        The color map.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value is null
        TiffImageException - The color map may be defined for samples per pixel equal to 1 only. or The bits per sample are not defined.
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the followign formula: 3 * (2**BitsPerSample).
      • setColorMap

        public void setColorMap(int[] value)

        Sets the color map.

        Parameters:
        value - The color map.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value is null
        TiffImageException - The color map may be defined for samples per pixel equal to 1 only. or The bits per sample are not defined.
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the followign formula: 3 * (2**BitsPerSample).
      • getDateTime

        public String getDateTime()

        Gets the date and time.

        Returns:
        The date and time.
      • setDateTime

        public void setDateTime(String value)

        Sets the date and time.

        Parameters:
        value - The date and time.
      • getDocumentName

        public String getDocumentName()

        Gets the name of the document.

        Returns:
        The name of the document.
      • setDocumentName

        public void setDocumentName(String value)

        Sets the name of the document.

        Parameters:
        value - The name of the document.
      • getAlphaStorage

        public int getAlphaStorage()

        Gets the alpha storage option. Options other than TiffAlphaStorage.Unspecified are used when there are more than 3 SamplesPerPixel defined.

        Returns:
        The alpha storage option.
      • setAlphaStorage

        public void setAlphaStorage(int value)

        Sets the alpha storage option. Options other than TiffAlphaStorage.Unspecified are used when there are more than 3 SamplesPerPixel defined.

        Parameters:
        value - The alpha storage option.
      • isExtraSamplesPresent

        public boolean isExtraSamplesPresent()

        Gets a value indicating whether the extra samples is present.

        Returns:
        true if the extra samples is present; otherwise, false.
      • getFillOrder

        public int getFillOrder()

        Gets the byte bits fill order.

        Returns:
        The byte bits fill order.
      • setFillOrder

        public void setFillOrder(int value)

        Sets the byte bits fill order.

        Parameters:
        value - The byte bits fill order.
      • getHalfToneHints

        public int[] getHalfToneHints()

        Gets the halftone hints.

        Returns:
        The halftone hints.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;Halftone hints array length must be equal to 2.
      • setHalfToneHints

        public void setHalfToneHints(int[] value)

        Sets the halftone hints.

        Parameters:
        value - The halftone hints.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;Halftone hints array length must be equal to 2.
      • getImageDescription

        public String getImageDescription()

        Gets the image description.

        Returns:
        The image description.
      • setImageDescription

        public void setImageDescription(String value)

        Sets the image description.

        Parameters:
        value - The image description.
      • getInkNames

        public String getInkNames()

        Gets the ink names.

        Returns:
        The ink names.
      • setInkNames

        public void setInkNames(String value)

        Sets the ink names.

        Parameters:
        value - The ink names.
      • getScannerManufacturer

        public String getScannerManufacturer()

        Gets the scanner manufacturer.

        Returns:
        The scanner manufacturer.
      • setScannerManufacturer

        public void setScannerManufacturer(String value)

        Sets the scanner manufacturer.

        Parameters:
        value - The scanner manufacturer.
      • getMaxSampleValue

        public int[] getMaxSampleValue()

        Gets the max sample value.

        Returns:
        The max sample value.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.
      • setMaxSampleValue

        public void setMaxSampleValue(int[] value)

        Sets the max sample value.

        Parameters:
        value - The max sample value.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.
      • getMinSampleValue

        public int[] getMinSampleValue()

        Gets the min sample value.

        Returns:
        The min sample value.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.
      • setMinSampleValue

        public void setMinSampleValue(int[] value)

        Sets the min sample value.

        Parameters:
        value - The min sample value.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.
      • getScannerModel

        public String getScannerModel()

        Gets the scanner model.

        Returns:
        The scanner model.
      • setScannerModel

        public void setScannerModel(String value)

        Sets the scanner model.

        Parameters:
        value - The scanner model.
      • getOrientation

        public int getOrientation()

        Gets the orientation.

        Returns:
        The orientation.
      • setOrientation

        public void setOrientation(int value)

        Sets the orientation.

        Parameters:
        value - The orientation.
      • getPageName

        public String getPageName()

        Gets the page name.

        Returns:
        The page name.
      • setPageName

        public void setPageName(String value)

        Sets the page name.

        Parameters:
        value - The page name.
      • getPageNumber

        public int[] getPageNumber()

        Gets the page number tag.

        Returns:
        The page number tag.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;Expected 2 values in the array: PageNumber[0] is the page number and PageNumber[1] is the total number of pages in the document.
      • setPageNumber

        public void setPageNumber(int[] value)

        Sets the page number tag.

        Parameters:
        value - The page number tag.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;Expected 2 values in the array: PageNumber[0] is the page number and PageNumber[1] is the total number of pages in the document.
      • getPhotometric

        public int getPhotometric()

        Gets the photometric.

        Returns:
        The photometric.
      • setPhotometric

        public void setPhotometric(int value)

        Sets the photometric.

        Parameters:
        value - The photometric.
      • getPlanarConfiguration

        public int getPlanarConfiguration()

        Gets the planar configuration.

        Returns:
        The planar configuration.
      • setPlanarConfiguration

        public void setPlanarConfiguration(int value)

        Sets the planar configuration.

        Parameters:
        value - The planar configuration.
      • getResolutionUnit

        public int getResolutionUnit()

        Gets the resolution unit.

        Returns:
        The resolution unit.
      • setResolutionUnit

        public void setResolutionUnit(int value)

        Sets the resolution unit.

        Parameters:
        value - The resolution unit.
      • getRowsPerStrip

        public long getRowsPerStrip()

        Gets the rows per strip.

        Returns:
        The rows per strip.
      • setRowsPerStrip

        public void setRowsPerStrip(long value)

        Sets the rows per strip.

        Parameters:
        value - The rows per strip.
      • getSampleFormat

        public int[] getSampleFormat()

        Gets the sample format.

        Returns:
        The sample format.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.
      • setSampleFormat

        public void setSampleFormat(int[] value)

        Sets the sample format.

        Parameters:
        value - The sample format.
        Throws:
        com.aspose.ms.System.ArgumentNullException - value is null
        com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.
      • getSamplesPerPixel

        public int getSamplesPerPixel()

        Gets the samples per pixel. To change this property value use the BitsPerSample property setter.

        Returns:
        The samples per pixel.
      • getSmaxSampleValue

        public long[] getSmaxSampleValue()

        Gets the max sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

        Returns:
        The max sample value.
      • setSmaxSampleValue

        public void setSmaxSampleValue(long[] value)

        Sets the max sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

        Parameters:
        value - The max sample value.
      • getSminSampleValue

        public long[] getSminSampleValue()

        Gets the min sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

        Returns:
        The min sample value.
      • setSminSampleValue

        public void setSminSampleValue(long[] value)

        Sets the min sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

        Parameters:
        value - The min sample value.
      • getSoftwareType

        public String getSoftwareType()

        Gets the software type.

        Returns:
        The software type.
      • setSoftwareType

        public void setSoftwareType(String value)

        Sets the software type.

        Parameters:
        value - The software type.
      • getStripByteCounts

        public long[] getStripByteCounts()

        Gets the strip byte counts.

        Returns:
        The strip byte counts.
      • setStripByteCounts

        public void setStripByteCounts(long[] value)

        Sets the strip byte counts.

        Parameters:
        value - The strip byte counts.
      • getStripOffsets

        public long[] getStripOffsets()

        Gets the strip offsets.

        Returns:
        The strip offsets.
      • setStripOffsets

        public void setStripOffsets(long[] value)

        Sets the strip offsets.

        Parameters:
        value - The strip offsets.
      • getSubFileType

        public long getSubFileType()

        Gets a general indication of the kind of data contained in this subfile.

        Returns:
        The general indication of the kind of data contained in this subfile.
      • setSubFileType

        public void setSubFileType(long value)

        Sets a general indication of the kind of data contained in this subfile.

        Parameters:
        value - The general indication of the kind of data contained in this subfile.
      • getTargetPrinter

        public String getTargetPrinter()

        Gets the target printer.

        Returns:
        The target printer.
      • setTargetPrinter

        public void setTargetPrinter(String value)

        Sets the target printer.

        Parameters:
        value - The target printer.
      • getThreshholding

        public int getThreshholding()

        Gets the threshholding.

        Returns:
        The threshholding.
      • setThreshholding

        public void setThreshholding(int value)

        Sets the threshholding.

        Parameters:
        value - The threshholding.
      • getTotalPages

        public int getTotalPages()

        Gets the total pages.

        Returns:
        The total pages.
      • getXposition

        public TiffRational getXposition()

        Gets the x position.

        Returns:
        The x position.
      • setXposition

        public void setXposition(TiffRational value)

        Sets the x position.

        Parameters:
        value - The x position.
      • getXresolution

        public TiffRational getXresolution()

        Gets the x resolution.

        Returns:
        The x resolution.
      • setXresolution

        public void setXresolution(TiffRational value)

        Sets the x resolution.

        Parameters:
        value - The x resolution.
      • getYposition

        public TiffRational getYposition()

        Gets the y position.

        Returns:
        The y position.
      • setYposition

        public void setYposition(TiffRational value)

        Sets the y position.

        Parameters:
        value - The y position.
      • getYresolution

        public TiffRational getYresolution()

        Gets the y resolution.

        Returns:
        The y resolution.
      • setYresolution

        public void setYresolution(TiffRational value)

        Sets the y resolution.

        Parameters:
        value - The y resolution.
      • getFaxT4Options

        public long getFaxT4Options()

        Gets the fax t4 options.

        Returns:
        The fax t4 options.
      • setFaxT4Options

        public void setFaxT4Options(long value)

        Sets the fax t4 options.

        Parameters:
        value - The fax t4 options.
      • getPredictor

        public int getPredictor()

        Gets the predictor for LZW compression.

        Returns:
        The predictor type.
      • setPredictor

        public void setPredictor(int value)

        Sets the predictor for LZW compression.

        Parameters:
        value - The predictor type.
      • getImageLength

        public long getImageLength()

        Gets the image length.

        Returns:
        The image length.
      • setImageLength

        public void setImageLength(long value)

        Sets the image length.

        Parameters:
        value - The image length.
      • getImageWidth

        public long getImageWidth()

        Gets the image width.

        Returns:
        The image width.
      • setImageWidth

        public void setImageWidth(long value)

        Sets the image width.

        Parameters:
        value - The image width.
      • getTags

        public TiffDataType[] getTags()

        Gets the tags.

        Returns:
        The tags.
      • setTags

        public void setTags(TiffDataType[] value)

        Sets the tags.

        Parameters:
        value - The tags.
      • getValidTagCount

        public int getValidTagCount()

        Gets the valid tag count. This is not the total tags count but the number of tags which may be preserved.

        Returns:
        The valid tag count.
      • getBitsPerPixel

        public int getBitsPerPixel()

        Gets the bits per pixel.

        Returns:
        The bits per pixel.
      • getValidTagsCount

        public static int getValidTagsCount(TiffDataType[] tags)

        Gets the valid tags count.

        Parameters:
        tags - The tags to validate.
        Returns:
        The valid tags count.
      • removeTag

        public boolean removeTag(int tag)

        Removes the tag.

        Parameters:
        tag - The tag to remove.
        Returns:
        true if successfully removed
      • validate

        public void validate()

        Validates if options have valid combination of tags

      • addTags

        public void addTags(TiffDataType[] tagsToAdd)

        Adds the tags.

        Parameters:
        tagsToAdd - The tags to add.
      • addTag

        public void addTag(TiffDataType tagToAdd)

        Adds a new tag.

        Parameters:
        tagToAdd - The tag to add.
      • getTagByType

        public TiffDataType getTagByType(int tagKey)

        Gets the instance of the tag by type.

        Parameters:
        tagKey - The tag key.
        Returns:
        Instance of the tag if exists or null otherwise.
      • createOptionsValidator_internalized

        public static com.aspose.cad_internal.imageoptions.validators.tiff.IPhotometricValidator createOptionsValidator_internalized(TiffOptions options)

        Creates the options validator.

        Parameters:
        options - The TIFF options.
        Returns:
        TIFF image options validator.