it.geosolutions.imageio.maskband
Interface DatasetLayout

All Known Implementing Classes:
DefaultDatasetLayoutImpl

public interface DatasetLayout

Interface defining methods for accessing Internal Image structure, like overviews, masks and so on

Author:
Nicola Lagomarsini GeoSolutions S.A.S.

Method Summary
 File getExternalMaskOverviews()
          This methods returns a File containing external overviews associated to external Image masks, or null if not present.
 File getExternalMasks()
          This methods returns a File containing external masks associated to input Image, or null if not present.
 File getExternalOverviews()
          This methods returns a File containing external overviews associated to input Image, or null if not present.
 int getInternalMaskImageIndex(int maskIndex)
          Returns the Mask index associated to the input image index defined.
 int getInternalOverviewImageIndex(int overviewIndex)
          Returns the Overview index associated to the input image index defined.
 int getNumExternalMaskOverviews()
          Returns the number of external mask overviews
 int getNumExternalMasks()
          Returns the total number of externals Image masks.
 int getNumExternalOverviews()
          Returns the number of external Image overviews
 int getNumInternalMasks()
          Returns the total number of internal Image masks.
 int getNumInternalOverviews()
          Returns the number of internal Image overviews
 

Method Detail

getNumInternalOverviews

int getNumInternalOverviews()
Returns the number of internal Image overviews

Returns:
an Integer indicating how many overviews are present

getNumExternalOverviews

int getNumExternalOverviews()
Returns the number of external Image overviews

Returns:
an Integer indicating how many overviews are present

getNumExternalMaskOverviews

int getNumExternalMaskOverviews()
Returns the number of external mask overviews

Returns:
an Integer indicating how many overviews are present

getNumInternalMasks

int getNumInternalMasks()
Returns the total number of internal Image masks. Notice that If masks are more than one, the others are considered as overviews of the first mask

Returns:
an Integer indicating how many masks are present

getNumExternalMasks

int getNumExternalMasks()
Returns the total number of externals Image masks. Notice that If masks are more than one, the others are considered as overviews of the first mask

Returns:
an Integer indicating how many external masks are present

getInternalOverviewImageIndex

int getInternalOverviewImageIndex(int overviewIndex)
Returns the Overview index associated to the input image index defined. This is helpful when we have overviews and masks and we are unable to distinguish them. If no overwiew is present or the overview index is greater than the maximum index, -1 will be returned.

Parameters:
overviewIndex - Integer defining an image overview index (0 means the native image)
Returns:
The Overview index related to the imageIndex defined

getInternalMaskImageIndex

int getInternalMaskImageIndex(int maskIndex)
Returns the Mask index associated to the input image index defined. This is helpful when we have overviews and masks and we are unable to distinguish them. If no mask is present or the mask index is greater than the maximum index, -1 will be returned.

Parameters:
maskIndex - Integer defining an image mask index (0 means the native image resolution)
Returns:
The Overview index related to the imageIndex defined

getExternalMasks

File getExternalMasks()
This methods returns a File containing external masks associated to input Image, or null if not present.

Returns:
a File containing external masks associated to an input File

getExternalOverviews

File getExternalOverviews()
This methods returns a File containing external overviews associated to input Image, or null if not present.

Returns:
a File containing external overviews associated to an input File

getExternalMaskOverviews

File getExternalMaskOverviews()
This methods returns a File containing external overviews associated to external Image masks, or null if not present.

Returns:
a File containing external mask overviews associated to an input File


Copyright © 2006–2018 GeoSolutions. All rights reserved.