| it.geosolutions.imageio.plugins.slices2D.SliceImageReader
 it.geosolutions.imageio.plugins.jhdf.BaseHDFImageReader
All known Subclasses: it.geosolutions.imageio.plugins.jhdf.tovs.TOVSImageReader, it.geosolutions.imageio.plugins.jhdf.aps.APSImageReader,
| Inner Class :protected class SourceStructure | |
| Method Summary | |
| public void | dispose()
| | abstract protected int | getBandNumberFromProduct(String productName)
| | public int | getHeight(int imageIndex)
Returns the height in pixels of the given image within the input source.
Parameters:
imageIndex - the index of the image to be queried. | | public Iterator | getImageTypes(int imageIndex)
Returns an Iterator containing possible image
types to which the given image may be decoded, in the form of
ImageTypeSpecifierss. | | public int[] | getSlice2DIndexCoordinates(int requiredSlice2DIndex)
Given a specifiedIndex as an input, returns a long[]
having the subDataset/coverage index at the first position of the array.
Then, the indexes (of the other dimensions) needed to retrieve a proper
2D Slice.
As an instance, suppose a HDF source contains a 4D SubDataset with the
form (X,Y,Z,T). | | public int | getTileHeight(int imageIndex)
Returns the height of a tile in the given image.
Parameters:
imageIndex - the index of the image to be queried. | | public int | getTileWidth(int imageIndex)
Returns the width of a tile in the given image.
Parameters:
imageIndex - the index of the image to be queried. | | public int | getWidth(int imageIndex)
Returns the width in pixels of the given image within the input source.
Parameters:
imageIndex - the index of the image to be queried. | | protected void | initialize()
| | abstract protected void | initializeProfile()
Additional initialization for a specific HDF "Profile".
Depending on the HDF data producer, the originating file has a proper
data/metadata structure. | | abstract protected boolean | isAcceptedItem(String itemName)
| | public BufferedImage | read(int imageIndex, ImageReadParam param)
Reads the image indexed by imageIndex and returns it as a
BufferedImage, using a supplied ImageReadParam
Parameters:
imageIndex - the index of the image to be retrieved.
Parameters:
param - an ImageReadParam used to control the readingprocess, or null. | | public void | reset()
| | protected Dataset | retrieveDataset(int subDatasetIndex)
| | public int | retrieveSlice2DIndex(int imageIndex, int[] selectedIndexOfEachDim)
returns a proper subindex needed to access a specific 2D slice of a
specified coverage/subdataset. | | protected int | retrieveSubDatasetIndex(int imageIndex)
Given the index of a 2D image, retrieve the index of the subDataset
containing that image. | | public void | setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)
| | public void | setInput(Object input, boolean seekForwardOnly)
| | public void | setInput(Object input)
|
| fileFormat | | protected FileFormat fileFormat(Code) | | The originating FileFormat
|
| mutex | | final protected int[] mutex(Code) | | A mutex used to synchronize operations
|
| root | | protected HObject root(Code) | | root of the FileFormat related to the provided input source
|
| sourceStructure | | protected SourceStructure sourceStructure(Code) | | a SourceStructure's instance needed to get main
SubDatasets info and properties.
|
| subDatasetsMap | | protected LinkedHashMap subDatasetsMap(Code) | | A LinkedHashMap having all the Datasets
contained within the source
|
| dispose | | public void dispose()(Code) | | |
| getBandNumberFromProduct | | abstract protected int getBandNumberFromProduct(String productName)(Code) | | |
| getHeight | | public int getHeight(int imageIndex) throws IOException(Code) | | Returns the height in pixels of the given image within the input source.
Parameters:
imageIndex - the index of the image to be queried. the height of the image, as an int. |
| getImageTypes | | public Iterator getImageTypes(int imageIndex) throws IOException(Code) | | Returns an Iterator containing possible image
types to which the given image may be decoded, in the form of
ImageTypeSpecifierss.
Parameters:
imageIndex - the index of the image to beretrieved. an Iterator containing at least oneImageTypeSpecifier representing suggested imagetypes for decoding the current given image.
exception:
IllegalStateException - if the input source has not been set.
exception:
IndexOutOfBoundsException - if the supplied index isout of bounds.
exception:
IOException - if an error occurs reading the formatinformation from the input source. |
| getSlice2DIndexCoordinates | | public int[] getSlice2DIndexCoordinates(int requiredSlice2DIndex)(Code) | | Given a specifiedIndex as an input, returns a long[]
having the subDataset/coverage index at the first position of the array.
Then, the indexes (of the other dimensions) needed to retrieve a proper
2D Slice.
As an instance, suppose a HDF source contains a 4D SubDataset with the
form (X,Y,Z,T). if returnedIndex[]={2,3,1}, the required Slice2D is
available at the subDataset with index=2, timeIndex=3, zIndex=1.
TODO: Now, we are supposing order is 5thDim -> T -> Z -> (X,Y)
|
| getTileHeight | | public int getTileHeight(int imageIndex) throws IOException(Code) | | Returns the height of a tile in the given image.
Parameters:
imageIndex - the index of the image to be queried. the height of a tile.
exception:
IOException - if an error occurs during reading. |
| getTileWidth | | public int getTileWidth(int imageIndex) throws IOException(Code) | | Returns the width of a tile in the given image.
Parameters:
imageIndex - the index of the image to be queried. the width of a tile.
exception:
IOException - if an error occurs during reading. |
| getWidth | | public int getWidth(int imageIndex) throws IOException(Code) | | Returns the width in pixels of the given image within the input source.
Parameters:
imageIndex - the index of the image to be queried. the width of the image, as an int. |
| initialize | | protected void initialize() throws IOException(Code) | | Simple initialization method
|
| initializeProfile | | abstract protected void initializeProfile() throws Exception(Code) | | Additional initialization for a specific HDF "Profile".
Depending on the HDF data producer, the originating file has a proper
data/metadata structure. For this reason, a specific initialization
should be implemented for each different HDF "Profile".
As an instance, the Automated Processing System (APS) produces HDF files
having a structure which differes from the HDF structure of a file
produced by TIROS Operational Vertical Sounder (TOVS).
throws:
Exception - |
| isAcceptedItem | | abstract protected boolean isAcceptedItem(String itemName)(Code) | |
Parameters:
itemName - The name of the product/subDataset to be checked true if the product/subdataset needs to be takenon account. |
| read | | public BufferedImage read(int imageIndex, ImageReadParam param) throws IOException(Code) | | Reads the image indexed by imageIndex and returns it as a
BufferedImage, using a supplied ImageReadParam
Parameters:
imageIndex - the index of the image to be retrieved.
Parameters:
param - an ImageReadParam used to control the readingprocess, or null. the desired portion of the image as a BufferedImage. |
| reset | | public void reset()(Code) | | |
| retrieveDataset | | protected Dataset retrieveDataset(int subDatasetIndex)(Code) | | Returns a subDataset given a subDatasetIndex
Parameters:
subDatasetIndex - The index of the required subDataset the required subDataset |
| retrieveSlice2DIndex | | public int retrieveSlice2DIndex(int imageIndex, int[] selectedIndexOfEachDim)(Code) | | returns a proper subindex needed to access a specific 2D slice of a
specified coverage/subdataset.
Parameters:
imageIndex - the specified coverage/subDataset
Parameters:
selectedIndexOfEachDim - the required index of each dimensionTODO: Should I use a single long[] input parameter containing also thesubdataset index? |
| retrieveSubDatasetIndex | | protected int retrieveSubDatasetIndex(int imageIndex)(Code) | | Given the index of a 2D image, retrieve the index of the subDataset
containing that image.
Parameters:
imageIndex - the index of a 2D image the index of the subDataset containing that image. |
| setInput | | public void setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)(Code) | | |
| setInput | | public void setInput(Object input, boolean seekForwardOnly)(Code) | | |
|
|