Package adams.data.io.output.jaiwriter
Class PNGWriter
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.io.output.jaiwriter.AbstractJAIWriter
-
- adams.data.io.output.jaiwriter.PNGWriter
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,Serializable
public class PNGWriter extends AbstractJAIWriter
Manages writing PNG images.- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected float
m_Compression
the compression (0=none to 1=high).-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description PNGWriter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
compressionTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.float
getCompression()
Returns the compression to use.String[]
getFormatExtensions()
Returns the extension(s) of the format.ImageWriteParam
getParameters()
Returns the parameters for the writer.ImageWriter
getWriter()
Returns the configured writer.String
globalInfo()
Returns a string describing the object.boolean
removeAlphaChannel()
Returns whether the alpha channel must be removed.void
setCompression(float value)
Sets the compression to use.-
Methods inherited from class adams.data.io.output.jaiwriter.AbstractJAIWriter
write, write
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
setCompression
public void setCompression(float value)
Sets the compression to use.- Parameters:
value
- the compression (0=none to 1=high)
-
getCompression
public float getCompression()
Returns the compression to use.- Returns:
- the compression (0=none to 1=high)
-
compressionTipText
public String compressionTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getFormatExtensions
public String[] getFormatExtensions()
Returns the extension(s) of the format.- Specified by:
getFormatExtensions
in classAbstractJAIWriter
- Returns:
- the extension(s) (without the dot!)
-
getWriter
public ImageWriter getWriter() throws Exception
Returns the configured writer.- Specified by:
getWriter
in classAbstractJAIWriter
- Returns:
- the configured writer
- Throws:
Exception
- if determining of writer fails
-
getParameters
public ImageWriteParam getParameters() throws Exception
Returns the parameters for the writer.- Specified by:
getParameters
in classAbstractJAIWriter
- Returns:
- the parameters
- Throws:
Exception
- if determining of writer or setting of parameters fails
-
removeAlphaChannel
public boolean removeAlphaChannel()
Returns whether the alpha channel must be removed.- Specified by:
removeAlphaChannel
in classAbstractJAIWriter
- Returns:
- true if to remove
-
-