org.dcm4che.imageio.plugins
Class DcmImageWriteParam

java.lang.Object
  extended by javax.imageio.IIOParam
      extended by javax.imageio.ImageWriteParam
          extended by org.dcm4che.imageio.plugins.DcmImageWriteParam

public abstract class DcmImageWriteParam
extends javax.imageio.ImageWriteParam

A class describing how a DICOM stream shold be encoded.

Version:
2002.06.16
Author:
Thomas Hacklaender

Field Summary
 
Fields inherited from class javax.imageio.ImageWriteParam
canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, compressionMode, compressionQuality, compressionType, compressionTypes, locale, MODE_COPY_FROM_METADATA, MODE_DEFAULT, MODE_DISABLED, MODE_EXPLICIT, preferredTileSizes, progressiveMode, tileGridXOffset, tileGridYOffset, tileHeight, tileWidth, tilingMode, tilingSet
 
Fields inherited from class javax.imageio.IIOParam
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset
 
Constructor Summary
DcmImageWriteParam()
          Constructs an empty ImageWriteParam.
DcmImageWriteParam(java.util.Locale locale)
          Constructs an ImageWriteParam set to use a given Locale.
 
Method Summary
abstract  DcmEncodeParam getDcmEncodeParameters()
           
abstract  boolean isMONOCHROME2()
          Returns the property monochrome2.
abstract  boolean isWriteAlwaysRGB()
          Returns the property writeAlwaysRGB.
abstract  boolean isWriteFMI()
          Returns the property writeFMI.
abstract  boolean isWriteIndexedAsRGB()
          Returns the property writeIndexedAsRGB.
abstract  void setDcmEncodeParameters(DcmEncodeParam dcmEncodeParams)
           
abstract  void setMONOCHROME2(boolean monochrome2)
          Set the property monochrome2.
abstract  void setWriteAlwaysRGB(boolean writeAlwaysRGB)
          Set the property writeAlwaysRGB.
abstract  void setWriteFMI(boolean writeFMI)
          Set the property writeFMI.
abstract  void setWriteIndexedAsRGB(boolean writeIndexedAsRGB)
          Set the property writeIndexedAsRGB.
 
Methods inherited from class javax.imageio.ImageWriteParam
canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, getBitRate, getCompressionMode, getCompressionQuality, getCompressionQualityDescriptions, getCompressionQualityValues, getCompressionType, getCompressionTypes, getLocale, getLocalizedCompressionTypeName, getPreferredTileSizes, getProgressiveMode, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getTilingMode, isCompressionLossless, setCompressionMode, setCompressionQuality, setCompressionType, setProgressiveMode, setTiling, setTilingMode, unsetCompression, unsetTiling
 
Methods inherited from class javax.imageio.IIOParam
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DcmImageWriteParam

public DcmImageWriteParam()
Constructs an empty ImageWriteParam. It is up to the subclass to set up the instance variables properly.


DcmImageWriteParam

public DcmImageWriteParam(java.util.Locale locale)
Constructs an ImageWriteParam set to use a given Locale.

Parameters:
locale - a Locale to be used to localize compression type names and quality descriptions, or null.
Method Detail

setWriteFMI

public abstract void setWriteFMI(boolean writeFMI)
Set the property writeFMI.

Parameters:
writeFMI - true, if the file-meta-information block (Part 10) should be written.

isWriteFMI

public abstract boolean isWriteFMI()
Returns the property writeFMI.

Returns:
true, if the file-meta-information block (Part 10) should be written. The default value is true.

setDcmEncodeParameters

public abstract void setDcmEncodeParameters(DcmEncodeParam dcmEncodeParams)

getDcmEncodeParameters

public abstract DcmEncodeParam getDcmEncodeParameters()

setMONOCHROME2

public abstract void setMONOCHROME2(boolean monochrome2)
Set the property monochrome2.

Parameters:
monochrome2 - true, if the Photometric Interpretation should be MONOCHROME2. Otherwise it will be set to MONOCHROME1.

isMONOCHROME2

public abstract boolean isMONOCHROME2()
Returns the property monochrome2.

Returns:
true, if the Photometric Interpretation should be MONOCHROME2. The default value is true.

setWriteAlwaysRGB

public abstract void setWriteAlwaysRGB(boolean writeAlwaysRGB)
Set the property writeAlwaysRGB.

Parameters:
writeAlwaysRGB - true, if all images should be written with Photometric Interpretation RGB.

isWriteAlwaysRGB

public abstract boolean isWriteAlwaysRGB()
Returns the property writeAlwaysRGB.

Returns:
true, if all images should be written with the Photometric Interpretation RGB. The default value is false.

setWriteIndexedAsRGB

public abstract void setWriteIndexedAsRGB(boolean writeIndexedAsRGB)
Set the property writeIndexedAsRGB.

Parameters:
writeIndexedAsRGB - true, if BufferedImages of type TYPE_BYTE_INDEXED should be written with the Photometric Interpretation RGB.

isWriteIndexedAsRGB

public abstract boolean isWriteIndexedAsRGB()
Returns the property writeIndexedAsRGB.

Returns:
true, if BufferedImages of type TYPE_BYTE_INDEXED should be written with the Photometric Interpretation RGB. The default value is true.