HiRISE

HiRISE.HiReport.product
Class ProductImageFile

java.lang.Object
  extended by HiRISE.HiReport.product.ProductFile
      extended by HiRISE.HiReport.product.ProductImageFile

public class ProductImageFile
extends ProductFile

Represents a particular image product


Field Summary
static String ID
          CVS ID
 
Fields inherited from class HiRISE.HiReport.product.ProductFile
creationTime, id, path, product, proffered, ref, size, type, version
 
Constructor Summary
ProductImageFile(String id, HiProduct product, ProductFileType type, String path, int version, boolean proffered)
          Create a new image product
ProductImageFile(String id, HiProduct product, String ref, ProductFileType type, String path, int version, boolean proffered)
          Create a new image product
 
Method Summary
 String getAreaGpx()
          Get a string representation of the total number of pixels
 String getAreaKm2()
          Get a string representation of the total area in square kilometers
 Dimension getDimensions()
          Get the pixel dimensions, will be zero if unknown.
 float getScale()
          Get the scale in meters per pixel.
 String getScaleMpx()
          Get the scale in meters per pixel.
 String getSizeKm()
          Get a string representation of the size in kilometers
 String getSizePx()
          Get a string representation of the size in pixels.
 void setDimensions(Dimension dim)
          Set the pixel dim.
 void setScale(float mpx)
          Set the scale in meters per pixel.
 
Methods inherited from class HiRISE.HiReport.product.ProductFile
getCreationTime, getId, getPath, getProduct, getProffered, getSize, getType, getVersion, setCreationTime, setPath, setSize, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final String ID
CVS ID

See Also:
Constant Field Values
Constructor Detail

ProductImageFile

public ProductImageFile(String id,
                        HiProduct product,
                        ProductFileType type,
                        String path,
                        int version,
                        boolean proffered)
Create a new image product

Parameters:
id - String identifier
product - unique product identifier
type - file type
path - absolute path
version - number
proffered - true if available

ProductImageFile

public ProductImageFile(String id,
                        HiProduct product,
                        String ref,
                        ProductFileType type,
                        String path,
                        int version,
                        boolean proffered)
Create a new image product

Parameters:
id - String identifier
product - unique product identifier
ref - Referring product identifier
type - file type
path - absolute path
version - number
proffered - true if available
Method Detail

getDimensions

public Dimension getDimensions()
Get the pixel dimensions, will be zero if unknown.

Returns:
pixels

getSizePx

public String getSizePx()
Get a string representation of the size in pixels.

Returns:
pixel px

getSizeKm

public String getSizeKm()
Get a string representation of the size in kilometers

Returns:
dimensions in kilometers

getAreaGpx

public String getAreaGpx()
Get a string representation of the total number of pixels

Returns:
gigapixels

getAreaKm2

public String getAreaKm2()
Get a string representation of the total area in square kilometers

Returns:
square kilometers

getScaleMpx

public String getScaleMpx()
Get the scale in meters per pixel.

Returns:
meters per pixel

setDimensions

public void setDimensions(Dimension dim)
Set the pixel dim.

Parameters:
dim - pixels

getScale

public float getScale()
Get the scale in meters per pixel.

Returns:
meters per pixel

setScale

public void setScale(float mpx)
Set the scale in meters per pixel.

Parameters:
mpx - meters per pixel

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona