ImageInputStream (bus-image 6.2.9 API)

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - org.aoju.bus.image.galaxy.io.ImageInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, BulkDataCreator, ImageInputHandler
```
public class ImageInputStream
extends FilterInputStream
implements ImageInputHandler, BulkDataCreator
```
Since:

JDK 1.8+

Version:

6.2.9

Author:

Kimi Liu

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImageInputStream.IncludeBulkData

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImageInputStream.IncludeBulkData`

Field Summary
- Fields inherited from class java.io.FilterInputStream
  in

Constructor Summary

Constructors
Constructor and Description

ImageInputStream(File file)

ImageInputStream(InputStream in)

ImageInputStream(InputStream in, String tsuid)

Constructors
Constructor and Description
`ImageInputStream(File file)`
`ImageInputStream(InputStream in)`
`ImageInputStream(InputStream in, String tsuid)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bigEndian()`
`void`	`close()`
`BulkData`	`createBulkData(ImageInputStream dis)`
`void`	`endDataset(ImageInputStream dis)`
`boolean`	`explicitVR()`
`int`	`getAllocateLimit()` Returns the limit of initial allocated memory for element values.
`String`	`getAttributePath()`
`BulkDataDescriptor`	`getBulkDataDescriptor()`
`File`	`getBulkDataDirectory()`
`String`	`getBulkDataFilePrefix()`
`List<File>`	`getBulkDataFiles()`
`String`	`getBulkDataFileSuffix()`
`Attributes`	`getFileMetaInformation()`
`ImageInputStream.IncludeBulkData`	`getIncludeBulkData()`
`long`	`getPosition()`
`byte[]`	`getPreamble()`
`long`	`getTagPosition()`
`String`	`getTransferSyntax()`
`String`	`getURI()`
`boolean`	`isConcatenateBulkDataFiles()`
`boolean`	`isExcludeBulkData()`
`boolean`	`isIncludeBulkDataURI()`
`int`	`length()`
`int`	`level()`
`void`	`mark(int readlimit)`
`int`	`read()`
`int`	`read(byte[] b)`
`int`	`read(byte[] b, int off, int len)`
`void`	`readAttributes(Attributes attrs, int len, int stopTag)`
`Attributes`	`readCommand()`
`Attributes`	`readDataset(int len, int stopTag)`
`Attributes`	`readFileMetaInformation()`
`void`	`readFully(byte[] b)`
`void`	`readFully(byte[] b, int off, int len)`
`void`	`readFully(short[] s, int off, int len)`
`void`	`readHeader()`
`Attributes`	`readItem()`
`boolean`	`readItemHeader()`
`byte[]`	`readValue()`
`void`	`readValue(ImageInputStream dis, Attributes attrs)`
`void`	`readValue(ImageInputStream dis, Fragments frags)`
`void`	`readValue(ImageInputStream dis, Sequence seq)`
`void`	`reset()`
`void`	`setAllocateLimit(int allocateLimit)` Sets the limit of initial allocated memory for element values.
`void`	`setBulkDataCreator(BulkDataCreator bulkDataCreator)`
`void`	`setBulkDataDescriptor(BulkDataDescriptor bulkDataDescriptor)`
`void`	`setBulkDataDirectory(File blkDirectory)`
`void`	`setBulkDataFilePrefix(String blkFilePrefix)`
`void`	`setBulkDataFileSuffix(String blkFileSuffix)`
`void`	`setConcatenateBulkDataFiles(boolean catBlkFiles)`
`void`	`setFileMetaInformationGroupLength(byte[] val)`
`void`	`setImageInputHandler(ImageInputHandler handler)`
`void`	`setIncludeBulkData(ImageInputStream.IncludeBulkData includeBulkData)`
`void`	`setPosition(long pos)`
`void`	`setURI(String uri)`
`long`	`skip(long n)`
`void`	`skipFully(long n)`
`void`	`startDataset(ImageInputStream dis)`
`int`	`tag()`
`static String`	`toAttributePath(List<ItemPointer> itemPointers, int tag)`
`VR`	`vr()`

Methods inherited from class java.io.FilterInputStream
available, markSupported

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageInputStream

public ImageInputStream(InputStream in,
                        String tsuid)
                 throws IOException

Throws:: IOException

ImageInputStream

public ImageInputStream(InputStream in)
                 throws IOException

Throws:: IOException

ImageInputStream

public ImageInputStream(File file)
                 throws IOException

Throws:: IOException

Method Detail

toAttributePath

public static String toAttributePath(List<ItemPointer> itemPointers,
                                     int tag)

getTransferSyntax

public final String getTransferSyntax()

getAllocateLimit
```
public final int getAllocateLimit()
```
Returns the limit of initial allocated memory for element values.
By default, the limit is set to 67108864 (64 MiB).

Returns:

Limit of initial allocated memory for value or -1 for no limit

See Also:

setAllocateLimit(int)

setAllocateLimit
```
public final void setAllocateLimit(int allocateLimit)
```
Sets the limit of initial allocated memory for element values. If the value length exceeds the limit, a byte array with the specified size is allocated. If the array can filled with bytes read from this DicomInputStream, the byte array is reallocated with twice the previous length and filled again. That continues until the twice of the previous length exceeds the actual value length. Then the byte array is reallocated with actual value length and filled with the remaining bytes for the value from this DicomInputStream.
The rational of the incrementing allocation of byte arrays is to avoid OutOfMemoryErrors on parsing corrupted DICOM streams.
By default, the limit is set to 67108864 (64 MiB).

Parameters:

allocateLimit - limit of initial allocated memory or -1 for no limit

getURI
```
public final String getURI()
```

setURI
```
public final void setURI(String uri)
```

getIncludeBulkData

public final ImageInputStream.IncludeBulkData getIncludeBulkData()

setIncludeBulkData

public final void setIncludeBulkData(ImageInputStream.IncludeBulkData includeBulkData)

getBulkDataDescriptor

public final BulkDataDescriptor getBulkDataDescriptor()

setBulkDataDescriptor

public final void setBulkDataDescriptor(BulkDataDescriptor bulkDataDescriptor)

getBulkDataFilePrefix

public final String getBulkDataFilePrefix()

setBulkDataFilePrefix

public final void setBulkDataFilePrefix(String blkFilePrefix)

getBulkDataFileSuffix

public final String getBulkDataFileSuffix()

setBulkDataFileSuffix

public final void setBulkDataFileSuffix(String blkFileSuffix)

getBulkDataDirectory

public final File getBulkDataDirectory()

setBulkDataDirectory

public final void setBulkDataDirectory(File blkDirectory)

isConcatenateBulkDataFiles

public final boolean isConcatenateBulkDataFiles()

setConcatenateBulkDataFiles

public final void setConcatenateBulkDataFiles(boolean catBlkFiles)

getBulkDataFiles

public final List<File> getBulkDataFiles()

setImageInputHandler

public final void setImageInputHandler(ImageInputHandler handler)

setBulkDataCreator

public void setBulkDataCreator(BulkDataCreator bulkDataCreator)

setFileMetaInformationGroupLength

public final void setFileMetaInformationGroupLength(byte[] val)

getPreamble
```
public final byte[] getPreamble()
```

getFileMetaInformation

public Attributes getFileMetaInformation()
                                  throws IOException

Throws:: IOException

level
```
public final int level()
```

tag
```
public final int tag()
```

vr
```
public final VR vr()
```

length
```
public final int length()
```

getPosition
```
public final long getPosition()
```

setPosition
```
public void setPosition(long pos)
```

getTagPosition
```
public long getTagPosition()
```

bigEndian
```
public final boolean bigEndian()
```

explicitVR
```
public final boolean explicitVR()
```

isExcludeBulkData
```
public boolean isExcludeBulkData()
```

isIncludeBulkDataURI
```
public boolean isIncludeBulkDataURI()
```

getAttributePath
```
public String getAttributePath()
```

close
```
public void close()
           throws IOException
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException

mark
```
public void mark(int readlimit)
```
Overrides:

mark in class FilterInputStream

reset
```
public void reset()
           throws IOException
```
Overrides:

reset in class FilterInputStream

Throws:

IOException

read
```
public final int read()
               throws IOException
```
Overrides:

read in class FilterInputStream

Throws:

IOException

read

public final int read(byte[] b,
                      int off,
                      int len)
               throws IOException

Overrides:: read in class FilterInputStream
Throws:: IOException

read

public final int read(byte[] b)
               throws IOException

Overrides:: read in class FilterInputStream
Throws:: IOException

skip

public final long skip(long n)
                throws IOException

Overrides:: skip in class FilterInputStream
Throws:: IOException

skipFully

public void skipFully(long n)
               throws IOException

Throws:: IOException

readFully

public void readFully(byte[] b)
               throws IOException

Throws:: IOException

readFully

public void readFully(byte[] b,
                      int off,
                      int len)
               throws IOException

Throws:: IOException

readFully

public void readFully(short[] s,
                      int off,
                      int len)
               throws IOException

Throws:: IOException

readHeader

public void readHeader()
                throws IOException

Throws:: IOException

readItemHeader

public boolean readItemHeader()
                       throws IOException

Throws:: IOException

readCommand

public Attributes readCommand()
                       throws IOException

Throws:: IOException

readDataset

public Attributes readDataset(int len,
                              int stopTag)
                       throws IOException

Throws:: IOException

readFileMetaInformation

public Attributes readFileMetaInformation()
                                   throws IOException

Throws:: IOException

readAttributes

public void readAttributes(Attributes attrs,
                           int len,
                           int stopTag)
                    throws IOException

Throws:: IOException

readValue

public void readValue(ImageInputStream dis,
                      Attributes attrs)
               throws IOException

Specified by:: readValue in interface ImageInputHandler
Throws:: IOException

createBulkData

public BulkData createBulkData(ImageInputStream dis)
                        throws IOException

Specified by:: createBulkData in interface BulkDataCreator
Throws:: IOException

readValue

public void readValue(ImageInputStream dis,
                      Sequence seq)
               throws IOException

Specified by:: readValue in interface ImageInputHandler
Throws:: IOException

readValue

public void readValue(ImageInputStream dis,
                      Fragments frags)
               throws IOException

Specified by:: readValue in interface ImageInputHandler
Throws:: IOException

startDataset
```
public void startDataset(ImageInputStream dis)
```
Specified by:

startDataset in interface ImageInputHandler

endDataset
```
public void endDataset(ImageInputStream dis)
```
Specified by:

endDataset in interface ImageInputHandler

readItem

public Attributes readItem()
                    throws IOException

Throws:: IOException

readValue

public byte[] readValue()
                 throws IOException

Throws:: IOException

Class ImageInputStream

Nested Class Summary

Field Summary

Fields inherited from class java.io.FilterInputStream

Constructor Summary

Method Summary

Methods inherited from class java.io.FilterInputStream

Methods inherited from class java.lang.Object

Constructor Detail

ImageInputStream

ImageInputStream

ImageInputStream

Method Detail

toAttributePath

getTransferSyntax

getAllocateLimit

setAllocateLimit

getURI

setURI

getIncludeBulkData

setIncludeBulkData

getBulkDataDescriptor

setBulkDataDescriptor

getBulkDataFilePrefix

setBulkDataFilePrefix

getBulkDataFileSuffix

setBulkDataFileSuffix

getBulkDataDirectory

setBulkDataDirectory

isConcatenateBulkDataFiles

setConcatenateBulkDataFiles

getBulkDataFiles

setImageInputHandler

setBulkDataCreator

setFileMetaInformationGroupLength

getPreamble

getFileMetaInformation

level

tag

vr

length

getPosition

setPosition

getTagPosition

bigEndian

explicitVR

isExcludeBulkData

isIncludeBulkDataURI

getAttributePath

close

mark

reset

read

read

read

skip

skipFully

readFully

readFully

readFully

readHeader

readItemHeader

readCommand

readDataset

readFileMetaInformation

readAttributes

readValue

createBulkData

readValue

readValue

startDataset

endDataset

readItem

readValue