Package gov.nasa.pds.objectAccess
Class TwoDImageExporter
java.lang.Object
gov.nasa.pds.objectAccess.ObjectExporter
gov.nasa.pds.objectAccess.ImageExporter
gov.nasa.pds.objectAccess.TwoDImageExporter
- All Implemented Interfaces:
Exporter<Array2DImage>
public class TwoDImageExporter extends ImageExporter implements Exporter<Array2DImage>
Class for converting 2D PDS images.
- Author:
- dcberrio, mcayanan
-
Method Summary
Modifier and Type Method Description voidconvert(Array2DImage array2DImage, OutputStream outputStream)Converts a 2D array file to a viewable image file.voidconvert(OutputStream outputStream, int objectIndex)Converts the object at index objectIndex into the desired export type.Array2DImagegetArray2DImage()Get the Array 2D ImageStringgetExportType()Get the export image formatintgetTargetPixelDepth()Return the target image pixel depth in bitsbooleanisFirstIndexFastest()Is the first index fastest?booleanisSampleDirectionRight()Is the sample direction to the right?booleanmaximizeDynamicRange()Get whether or not input data elements are scaled up to the target pixel bit depthvoidmaximizeDynamicRange(boolean dynamicRangeScaling)Set whether or not input data elements are scaled up to the maximum pixel bit depthvoidsetArray2DImage(Array2DImage img)Set the Array 2D ImagevoidsetExportType(String exportType)Set the export image format.voidsetFirstIndexFastest(boolean firstIndexFastest)Set whether the first index is fastest.voidsetSampleDirectionRight(boolean sampleDirectionRight)Set the sample direction.voidsetTargetPixelDepth(int targetPixelDepth)Set the target pixel bit depthMethods inherited from class gov.nasa.pds.objectAccess.ImageExporter
getDisplaySettings, parseLabel, parseLabel, parseLabel, parseLabel, setDisplaySettingsMethods inherited from class gov.nasa.pds.objectAccess.ObjectExporter
getObjectProvider, getObservationalFileArea, setObjectProvider, setObservationalFileAreaMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface gov.nasa.pds.objectAccess.Exporter
setObjectProvider, setObservationalFileArea
-
Method Details
-
convert
Description copied from interface:ExporterConverts the object at index objectIndex into the desired export type.- Specified by:
convertin interfaceExporter<Array2DImage>- Parameters:
outputStream- the output stream for the output objectobjectIndex- the index of the input object of type T in the associated observational file area- Throws:
IOException
-
convert
Converts a 2D array file to a viewable image file.- Specified by:
convertin interfaceExporter<Array2DImage>- Parameters:
outputStream- the output streamarray2DImage- the array2DImage object to convert- Throws:
IOException- if there is an exception writing to the stream or reading the image
-
getTargetPixelDepth
public int getTargetPixelDepth()Return the target image pixel depth in bits- Returns:
- targetPixelBitDepth
-
setTargetPixelDepth
public void setTargetPixelDepth(int targetPixelDepth)Set the target pixel bit depth- Parameters:
targetPixelDepth- the target pixel bit depth
-
maximizeDynamicRange
public boolean maximizeDynamicRange()Get whether or not input data elements are scaled up to the target pixel bit depth- Returns:
- boolean
-
maximizeDynamicRange
public void maximizeDynamicRange(boolean dynamicRangeScaling)Set whether or not input data elements are scaled up to the maximum pixel bit depth- Parameters:
dynamicRangeScaling-
-
getExportType
Get the export image format- Returns:
- exportType the export image format
-
setExportType
Set the export image format. The format is limited to those supported by Java.- Specified by:
setExportTypein interfaceExporter<Array2DImage>- Parameters:
exportType- the export image format
-
isSampleDirectionRight
public boolean isSampleDirectionRight()Is the sample direction to the right?- Returns:
- sampleDirectionRight
-
setSampleDirectionRight
public void setSampleDirectionRight(boolean sampleDirectionRight)Set the sample direction.- Parameters:
sampleDirectionRight-
-
isFirstIndexFastest
public boolean isFirstIndexFastest()Is the first index fastest?- Returns:
- firstIndexFastest
-
setFirstIndexFastest
public void setFirstIndexFastest(boolean firstIndexFastest)Set whether the first index is fastest.- Parameters:
firstIndexFastest-
-
getArray2DImage
Get the Array 2D Image- Returns:
- pdsImage
-
setArray2DImage
Set the Array 2D Image- Parameters:
img-
-