Package adams.data.io.output.jaiwriter
Class BMPWriter
- 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.BMPWriter
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,Serializable
public class BMPWriter extends AbstractJAIWriter
Manages writing BMP images.- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
m_TopDown
whether to write the data in top-down order.-
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 BMPWriter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.String[]
getFormatExtensions()
Returns the extension(s) of the format.ImageWriteParam
getParameters()
Returns the parameters for the writer.boolean
getTopDown()
Returns whether to write the data in top-down order.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
setTopDown(boolean value)
Sets whether to write the data in top-down order.String
topDownTipText()
Returns the tip text for this property.-
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
-
setTopDown
public void setTopDown(boolean value)
Sets whether to write the data in top-down order.- Parameters:
value
- true if top-down
-
getTopDown
public boolean getTopDown()
Returns whether to write the data in top-down order.- Returns:
- true if top-down
-
topDownTipText
public String topDownTipText()
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
-
-