Class JPEGWriter

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

    public class JPEGWriter
    extends BufferedImageBasedWriter
    Outputs JPEG images.

    Valid options are:

    -D (property: debug)
        If set to true, scheme may output additional info to the console.
     
    -file <adams.core.io.PlaceholderFile> (property: file)
        The file to save the image to.
        default: .
     
    -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
     
    -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
     
    -background <java.awt.Color> (property: background)
        The background color.
        default: #ffffff
     
    -type <RGB|GRAY> (property: type)
        The type of image to create.
        default: RGB
     
    -quality <double> (property: quality)
        The JPEG quality (0.0 - 1.0).
        default: 1.0
     


    Based on weka.gui.visualize.JPEGWriter
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Quality

        protected double m_Quality
        the quality of the image.
    • Constructor Detail

      • JPEGWriter

        public JPEGWriter()
    • 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
      • setQuality

        public void setQuality​(double value)
        sets the quality the JPEG is saved in.
        Parameters:
        value - the quality to use
      • getQuality

        public double getQuality()
        returns the quality the JPEG will be stored in.
        Returns:
        the quality
      • qualityTipText

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