Package loci.formats.out

Class DicomWriter

java.lang.Object
loci.formats.FormatHandler
loci.formats.FormatWriter
loci.formats.out.DicomWriter
All Implemented Interfaces:
Closeable, AutoCloseable, loci.formats.ICompressedTileWriter, loci.formats.IFormatHandler, loci.formats.IFormatWriter, loci.formats.IMetadataConfigurable, loci.formats.IPyramidHandler, IExtraMetadataWriter
public class DicomWriter extends loci.formats.FormatWriter implements IExtraMetadataWriter
DicomWriter is the file format writer for DICOM files. This is designed for whole slide images, and may not produce schema-compliant files for other modalities.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TIFF_KEY
    Option for turning off TIFF metadata.
    static final String
    UID_DEFAULT_ROOT
     
    static final String
    UID_ROOT_KEY
    Option for setting the organization root for UIDs.

    Fields inherited from class loci.formats.FormatWriter

    cm, compression, compressionTypes, fps, initialized, interleaved, metadataRetrieve, options, out, resolution, resolutionData, sequential, series, validBits

    Fields inherited from class loci.formats.FormatHandler

    COMPRESSION_SUFFIXES, currentId, format, LOGGER, metadataOptions, suffixes

  • Constructor Summary

    Constructors
    Constructor
    Description
    DicomWriter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canDoStacks()
     
    void
    close()
     
    static String
    formatFixedWidth(double v, int width)
    Format the given double as a string with no more than width characters.
    loci.formats.codec.Codec
    getCodec()
     
    int[]
    getPixelTypes(String codec)
     
    int
    getTileSizeX()
     
    int
    getTileSizeY()
     
    String
    getUIDRoot()
     
    void
    saveBytes(int no, byte[] buf, int x, int y, int w, int h)
     
    void
    saveCompressedBytes(int no, byte[] buf, int x, int y, int w, int h)
     
    void
    setBigTiff(boolean bigTiff)
    Sets whether or not BigTIFF files should be written.
    void
    setExtraMetadata(String tagSource)
    Provide additional metadata that should be written as part of this dataset.
    void
    setId(String id)
     
    void
    setResolution(int r)
     
    void
    setSeries(int s)
     
    int
    setTileSizeX(int tileSize)
     
    int
    setTileSizeY(int tileSize)
     
    protected Slf4JStopWatch
    stopWatch()
     
    boolean
    writeDualPersonality()
    Checks the writer's associated MetadataOptions to see if dual personality writing has been explicitly enabled or disabled.

    Methods inherited from class loci.formats.FormatWriter

    changeOutputFile, checkParams, createOutputStream, getCodecOptions, getColorModel, getCompression, getCompressionTypes, getFramesPerSecond, getMetadataRetrieve, getPixelTypes, getPlaneCount, getPlaneCount, getResolution, getResolutionCount, getResolutions, getSamplesPerPixel, getSamplesPerPixel, getSeries, getSizeX, getSizeY, hasResolutions, isFullPlane, isInterleaved, isSupportedType, saveBytes, saveBytes, savePlane, savePlane, savePlane, seekToPlaneOffset, setCodecOptions, setColorModel, setCompression, setFramesPerSecond, setInterleaved, setMetadataRetrieve, setResolutions, setValidBitsPerPixel, setWriteSequentially

    Methods inherited from class loci.formats.FormatHandler

    checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, isThisType, setMetadataOptions

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface loci.formats.IFormatHandler

    getFormat, getNativeDataType, getSuffixes, isThisType

    Methods inherited from interface loci.formats.IMetadataConfigurable

    getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions