Class TIFFWriter

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

    public class TIFFWriter
    extends BufferedImageBasedWriter
    Outputs TIFF images.

    Valid options are:

    -D <int> (property: debugLevel)
        The greater the number the more additional info the scheme may output to 
        the console (0 = off).
        default: 0
        minimum: 0
     
    -file <adams.core.io.PlaceholderFile> (property: file)
        The file to save the image to.
        default: ${CWD}
     
    -custom-dimensions (property: useCustomDimensions)
        Whether to use custom dimensions or use the component's ones.
     
    -custom-width <int> (property: customWidth)
        The custom width.
        default: -1
     
    -custom-height <int> (property: customHeight)
        The custom height.
        default: -1
     
    -scaling (property: scalingEnabled)
        If set to true, then scaling will be used.
     
    -scale-x <double> (property: XScale)
        The scaling factor for the X-axis.
        default: 1.0
     
    -scale-y <double> (property: YScale)
        The scaling factor for the Y axis.
        default: 1.0
     
    -background <java.awt.Color> (property: background)
        The background color.
        default: #ffffff
     
    -type <RGB|GRAY> (property: type)
        The type of image to create.
        default: RGB
     
    -compress (property: compress)
        If set to true, the image will be compressed (LZW).
     
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Compress

        protected boolean m_Compress
        whether to compress the image.
    • Constructor Detail

      • TIFFWriter

        public TIFFWriter()
    • Method Detail

      • getDescription

        public String getDescription()
        returns the name of the writer, to display in the FileChooser.
        Specified by:
        getDescription in class JComponentWriter
        Returns:
        the name of the writer
      • getExtensions

        public String[] getExtensions()
        returns the extensions (incl. ".") of the output format, to use in the FileChooser.
        Specified by:
        getExtensions in class JComponentWriter
        Returns:
        the file extensions
      • setCompress

        public void setCompress​(boolean value)
        Sets whether to compress the image.
        Parameters:
        value - if true then the image will be compressed
      • getCompress

        public boolean getCompress()
        Returns whether to compress the image.
        Returns:
        true if the image gets compressed
      • compressTipText

        public String compressTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.