org.opensha.commons.mapping.gmt
Class GMT_MapGenerator

java.lang.Object
  org.opensha.commons.mapping.gmt.GMT_MapGenerator

All Implemented Interfaces:

Serializable, SecureMapGenerator

Direct Known Subclasses:

GMT_MapGeneratorForShakeMaps

public class GMT_MapGenerator
extends Object
implements SecureMapGenerator, Serializable

Title: GMT_MapGenerator

Description: This class generates Maps using the java wrapper around GMT

Version:

1.0

See Also:

Serialized Form

Field Summary

protected ParameterList	adjustableParams
protected static boolean	BLACK_BACKGROUND_PARAM_DEFAULT
static String	BLACK_BACKGROUND_PARAM_NAME
protected static String	C Name of the class
protected static String	COAST_DEFAULT
static String	COAST_DRAW
static String	COAST_FILL
static String	COAST_NONE
static String	COAST_PARAM_NAME
static String	COLOR_SCALE_MAX_PARAM_NAME
static String	COLOR_SCALE_MIN_PARAM_NAME
static String	COLOR_SCALE_MODE_DEFAULT
static String	COLOR_SCALE_MODE_FROMDATA
static String	COLOR_SCALE_MODE_INFO
static String	COLOR_SCALE_MODE_MANUALLY
static String	COLOR_SCALE_MODE_NAME
protected static String	COMMAND_PATH
protected static String	CONVERT_PATH
protected static GMT_CPT_Files	CPT_PARAM_DEFAULT
static String	CPT_PARAM_NAME
static String	CUSTOM_SCALE_LABEL_PARAM_CHECK_NAME
protected BooleanParameter	customScaleLabelCheckParam
protected static boolean	D
protected static String	DEFAULT_GMT_SCRIPT_NAME
static String	DEFAULT_JPG_FILE_NAME
protected static String	DEFAULT_METADATA_FILE_NAME
protected static String	DEFAULT_PDF_FILE_NAME
static String	DEFAULT_PNG_FILE_NAME
protected static String	DEFAULT_PS_FILE_NAME
protected static String	DEFAULT_XYZ_FILE_NAME
protected static Integer	DPI_DEFAULT
static String	DPI_PARAM_NAME
protected static String	GMT_PATH
protected String	GMT_SCRIPT_NAME
protected static boolean	GMT_SMOOTHING_DEFAULT
static String	GMT_SMOOTHING_PARAM_NAME
static String	GMT_WEBSERVICE_NAME
static String	GRID_SPACING_PARAM_NAME
protected static String	GS_PATH
protected static Double	IMAGE_WIDTH_DEFAULT
static String	IMAGE_WIDTH_NAME
protected String	imgWebAddr
protected String	JPG_FILE_NAME
static String	LOG_PLOT_NAME
protected static boolean	LOG_PLOT_PARAM_DEFAULT
protected BooleanParameter	logPlotParam
static String	MAX_LAT_PARAM_NAME
static String	MAX_LON_PARAM_NAME
protected String	METADATA_FILE_NAME
static String	MIN_LAT_PARAM_NAME
static String	MIN_LON_PARAM_NAME
protected static String	NETCDF_LIB_PATH
static String	OPENSHA_CLASSPATH
static String	OPENSHA_CONVERT_PATH
static String	OPENSHA_GMT_DATA_PATH
static String	OPENSHA_GMT_PATH
static String	OPENSHA_GS_PATH
static String	OPENSHA_JAVA_PATH
static String	OPENSHA_NETCDF_LIB_PATH
static String	OPENSHA_PS2PDF_PATH
static String	OPENSHA_SERVLET_URL
protected String	PDF_FILE_NAME
protected String	PNG_FILE_NAME
protected String	projWdth
protected String	PS_FILE_NAME
protected static String	PS2PDF_PATH
protected String	region
protected String	SCALE_LABEL
static String	SCALE_LABEL_PARAM_NAME
protected StringParameter	scaleLabelParam
static String	SCEC_GMT_DATA_PATH
static String	SHOW_HIWYS_ALL
static String	SHOW_HIWYS_MAIN
static String	SHOW_HIWYS_NONE
static String	SHOW_HIWYS_OTHER
static String	SHOW_HIWYS_PARAM_DEFAULT
static String	SHOW_HIWYS_PARAM_INFO
static String	SHOW_HIWYS_PARAM_NAME
static String	TOPO_RESOLUTION_03_CA
static String	TOPO_RESOLUTION_06_CA
static String	TOPO_RESOLUTION_18_CA
static String	TOPO_RESOLUTION_30_CA
static String	TOPO_RESOLUTION_30_GLOBAL
static String	TOPO_RESOLUTION_NONE
protected static String	TOPO_RESOLUTION_PARAM_DEFAULT
static String	TOPO_RESOLUTION_PARAM_NAME
protected String	xOff
protected String	XYZ_FILE_NAME
protected GeoDataSet	xyzDataSet
protected String	yOff

Constructor Summary

GMT_MapGenerator()

Method Summary

static void	addCleanup(ArrayList<String> gmtCommandLines, ArrayList<String> rmFiles)
static void	addCoastCommand(ArrayList<String> gmtCommandLines, GMT_Map map, String region, String proj, String psFile)
static void	addColorbarCommand(ArrayList<String> gmtCommandLines, GMT_Map map, double colorScaleMin, double colorScaleMax, String cptFile, String psFile)
static void	addColorbarCommand(ArrayList<String> gmtCommandLines, String scaleLabel, boolean isLog, double colorScaleMin, double colorScaleMax, String cptFile, String psFile)
protected void	addFinalGMT_ScriptLines(ArrayList gmtCommandLines) Function to adds any final commands desired by a subclass.
static void	addHighwayCommand(ArrayList<String> gmtCommandLines, GMT_Map map, String region, String proj, String psFile)
protected void	addIntermediateGMT_ScriptLines(ArrayList gmtLines) This method allows subclasses to add intemediate lines the the GMT script.
static void	addPolyCommands(ArrayList<String> gmtCommandLines, GMT_Map map, String region, String proj, String psFile)
static void	addSpecialElements(ArrayList<String> gmtCommandLines, GMT_Map map, String region, String proj, String psFile)
static void	addSymbolCommands(ArrayList<String> gmtCommandLines, GMT_Map map, String region, String proj, String psFile)
static void	addSymbolSetCommands(ArrayList<String> gmtCommandLines, GMT_Map map, String region, String proj, String psFile)
void	createMapInfoFile(String mapInfo) This simply saves the supplied string to an ascii file that is placed in the same directory where the image, gmt script, etc.
ListIterator	getAdjustableParamsIterator() method to get the adjustable parameters
ParameterList	getAdjustableParamsList()
GriddedRegion	getEvenlyGriddedGeographicRegion()
protected ArrayList	getGMT_ScriptLines() This method generates a list of strings needed for the GMT script
ArrayList<String>	getGMT_ScriptLines(GMT_Map map, String dir) This method generates a list of strings needed for the GMT script
static String	getGMTColorString(Color color)
String	getGMTFilesWebAddress()
GMT_Map	getGMTMapSpecification(GeoDataSet xyzData)
static ArrayList<String>	getGMTPathEnvLines()
String	getImageFileName()
protected ArrayList	getMapInfoLines()
protected void	makeFileFromLines(ArrayList lines, String fileName)
String	makeMapLocally(GeoDataSet xyzDataSet, String scaleLabel, String metadata, String dirName) this function generates a GMT map from an XYZ data set using the current parameter settings, and using the version of GMT on the local computer.
String	makeMapUsingServlet(GeoDataSet xyzDataSet, String scaleLabel, String metadata, String dirName) This generates GMT map for the given XYZ dataset and for the current parameter setting, using the GMT Servlet on the SCEC server (the map is made on the SCEC server).
String	makeMapUsingServlet(GMT_Map map, String metadata, String dirName) This generates GMT map for the given XYZ dataset and for the current parameter setting, using the GMT Servlet on the SCEC server (the map is made on the SCEC server).
String	makeMapUsingWebServer(GeoDataSet xyzDataSet, String scaleLabel, String metadata) This generates GMT map for the given XYZ dataset and for the current parameter setting, using the GMT Web Service on the SCEC server (the map is made on the SCEC server).
protected String	openServletConnection(GMT_Map map, String metadataLines, String dirName) sets up the connection with the servlet on the server (gravity.usc.edu)
void	setMetatdataFileName(String fileName) sets the name of the metadata file with fileName( with full path)
void	setParameter(String paramName, Object value) This method allows one to set an adjustable parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

C

protected static final String C

Name of the class

See Also:

Constant Field Values

D

protected static final boolean D

See Also:

Constant Field Values

DEFAULT_GMT_SCRIPT_NAME

protected static final String DEFAULT_GMT_SCRIPT_NAME

See Also:

Constant Field Values

GMT_SCRIPT_NAME

protected String GMT_SCRIPT_NAME

DEFAULT_XYZ_FILE_NAME

protected static final String DEFAULT_XYZ_FILE_NAME

See Also:

Constant Field Values

XYZ_FILE_NAME

protected String XYZ_FILE_NAME

DEFAULT_METADATA_FILE_NAME

protected static final String DEFAULT_METADATA_FILE_NAME

See Also:

Constant Field Values

METADATA_FILE_NAME

protected String METADATA_FILE_NAME

DEFAULT_PS_FILE_NAME

protected static final String DEFAULT_PS_FILE_NAME

See Also:

Constant Field Values

PS_FILE_NAME

protected String PS_FILE_NAME

DEFAULT_JPG_FILE_NAME

public static final String DEFAULT_JPG_FILE_NAME

See Also:

Constant Field Values

JPG_FILE_NAME

protected String JPG_FILE_NAME

DEFAULT_PNG_FILE_NAME

public static final String DEFAULT_PNG_FILE_NAME

See Also:

Constant Field Values

PNG_FILE_NAME

protected String PNG_FILE_NAME

DEFAULT_PDF_FILE_NAME

protected static final String DEFAULT_PDF_FILE_NAME

See Also:

Constant Field Values

PDF_FILE_NAME

protected String PDF_FILE_NAME

SCALE_LABEL

protected String SCALE_LABEL

OPENSHA_GMT_PATH

public static final String OPENSHA_GMT_PATH

See Also:

Constant Field Values

OPENSHA_GS_PATH

public static final String OPENSHA_GS_PATH

See Also:

Constant Field Values

OPENSHA_PS2PDF_PATH

public static final String OPENSHA_PS2PDF_PATH

See Also:

Constant Field Values

OPENSHA_CONVERT_PATH

public static final String OPENSHA_CONVERT_PATH

See Also:

Constant Field Values

OPENSHA_GMT_DATA_PATH

public static final String OPENSHA_GMT_DATA_PATH

See Also:

Constant Field Values

OPENSHA_SERVLET_URL

public static final String OPENSHA_SERVLET_URL

OPENSHA_JAVA_PATH

public static final String OPENSHA_JAVA_PATH

See Also:

Constant Field Values

OPENSHA_CLASSPATH

public static final String OPENSHA_CLASSPATH

See Also:

Constant Field Values

OPENSHA_NETCDF_LIB_PATH

public static final String OPENSHA_NETCDF_LIB_PATH

See Also:

Constant Field Values

SCEC_GMT_DATA_PATH

public static String SCEC_GMT_DATA_PATH

GMT_PATH

protected static String GMT_PATH

GS_PATH

protected static String GS_PATH

CONVERT_PATH

protected static String CONVERT_PATH

PS2PDF_PATH

protected static String PS2PDF_PATH

NETCDF_LIB_PATH

protected static String NETCDF_LIB_PATH

COMMAND_PATH

protected static String COMMAND_PATH

xyzDataSet

protected GeoDataSet xyzDataSet

xOff

protected String xOff

yOff

protected String yOff

region

protected String region

projWdth

protected String projWdth

MIN_LAT_PARAM_NAME

public static final String MIN_LAT_PARAM_NAME

See Also:

Constant Field Values

MAX_LAT_PARAM_NAME

public static final String MAX_LAT_PARAM_NAME

See Also:

Constant Field Values

MIN_LON_PARAM_NAME

public static final String MIN_LON_PARAM_NAME

See Also:

Constant Field Values

MAX_LON_PARAM_NAME

public static final String MAX_LON_PARAM_NAME

See Also:

Constant Field Values

GRID_SPACING_PARAM_NAME

public static final String GRID_SPACING_PARAM_NAME

See Also:

Constant Field Values

IMAGE_WIDTH_NAME

public static final String IMAGE_WIDTH_NAME

See Also:

Constant Field Values

IMAGE_WIDTH_DEFAULT

protected static final Double IMAGE_WIDTH_DEFAULT

CPT_PARAM_NAME

public static final String CPT_PARAM_NAME

See Also:

Constant Field Values

CPT_PARAM_DEFAULT

protected static final GMT_CPT_Files CPT_PARAM_DEFAULT

COAST_PARAM_NAME

public static final String COAST_PARAM_NAME

See Also:

Constant Field Values

COAST_DRAW

public static final String COAST_DRAW

See Also:

Constant Field Values

COAST_FILL

public static final String COAST_FILL

See Also:

Constant Field Values

COAST_NONE

public static final String COAST_NONE

See Also:

Constant Field Values

COAST_DEFAULT

protected static final String COAST_DEFAULT

See Also:

Constant Field Values

COLOR_SCALE_MODE_NAME

public static final String COLOR_SCALE_MODE_NAME

See Also:

Constant Field Values

COLOR_SCALE_MODE_INFO

public static final String COLOR_SCALE_MODE_INFO

See Also:

Constant Field Values

COLOR_SCALE_MODE_MANUALLY

public static final String COLOR_SCALE_MODE_MANUALLY

See Also:

Constant Field Values

COLOR_SCALE_MODE_FROMDATA

public static final String COLOR_SCALE_MODE_FROMDATA

See Also:

Constant Field Values

COLOR_SCALE_MODE_DEFAULT

public static final String COLOR_SCALE_MODE_DEFAULT

See Also:

Constant Field Values

COLOR_SCALE_MIN_PARAM_NAME

public static final String COLOR_SCALE_MIN_PARAM_NAME

See Also:

Constant Field Values

COLOR_SCALE_MAX_PARAM_NAME

public static final String COLOR_SCALE_MAX_PARAM_NAME

See Also:

Constant Field Values

DPI_PARAM_NAME

public static final String DPI_PARAM_NAME

See Also:

Constant Field Values

DPI_DEFAULT

protected static final Integer DPI_DEFAULT

GMT_SMOOTHING_PARAM_NAME

public static final String GMT_SMOOTHING_PARAM_NAME

See Also:

Constant Field Values

GMT_SMOOTHING_DEFAULT

protected static final boolean GMT_SMOOTHING_DEFAULT

See Also:

Constant Field Values

BLACK_BACKGROUND_PARAM_NAME

public static final String BLACK_BACKGROUND_PARAM_NAME

See Also:

Constant Field Values

BLACK_BACKGROUND_PARAM_DEFAULT

protected static final boolean BLACK_BACKGROUND_PARAM_DEFAULT

See Also:

Constant Field Values

TOPO_RESOLUTION_PARAM_NAME

public static final String TOPO_RESOLUTION_PARAM_NAME

See Also:

Constant Field Values

TOPO_RESOLUTION_03_CA

public static final String TOPO_RESOLUTION_03_CA

See Also:

Constant Field Values

TOPO_RESOLUTION_06_CA

public static final String TOPO_RESOLUTION_06_CA

See Also:

Constant Field Values

TOPO_RESOLUTION_18_CA

public static final String TOPO_RESOLUTION_18_CA

See Also:

Constant Field Values

TOPO_RESOLUTION_30_CA

public static final String TOPO_RESOLUTION_30_CA

See Also:

Constant Field Values

TOPO_RESOLUTION_30_GLOBAL

public static final String TOPO_RESOLUTION_30_GLOBAL

See Also:

Constant Field Values

TOPO_RESOLUTION_PARAM_DEFAULT

protected static final String TOPO_RESOLUTION_PARAM_DEFAULT

See Also:

Constant Field Values

TOPO_RESOLUTION_NONE

public static final String TOPO_RESOLUTION_NONE

See Also:

Constant Field Values

SHOW_HIWYS_PARAM_NAME

public static final String SHOW_HIWYS_PARAM_NAME

See Also:

Constant Field Values

SHOW_HIWYS_PARAM_DEFAULT

public static final String SHOW_HIWYS_PARAM_DEFAULT

See Also:

Constant Field Values

SHOW_HIWYS_PARAM_INFO

public static final String SHOW_HIWYS_PARAM_INFO

See Also:

Constant Field Values

SHOW_HIWYS_ALL

public static final String SHOW_HIWYS_ALL

See Also:

Constant Field Values

SHOW_HIWYS_MAIN

public static final String SHOW_HIWYS_MAIN

See Also:

Constant Field Values

SHOW_HIWYS_OTHER

public static final String SHOW_HIWYS_OTHER

See Also:

Constant Field Values

SHOW_HIWYS_NONE

public static final String SHOW_HIWYS_NONE

See Also:

Constant Field Values

GMT_WEBSERVICE_NAME

public static final String GMT_WEBSERVICE_NAME

See Also:

Constant Field Values

LOG_PLOT_NAME

public static final String LOG_PLOT_NAME

See Also:

Constant Field Values

LOG_PLOT_PARAM_DEFAULT

protected static final boolean LOG_PLOT_PARAM_DEFAULT

See Also:

Constant Field Values

logPlotParam

protected BooleanParameter logPlotParam

CUSTOM_SCALE_LABEL_PARAM_CHECK_NAME

public static final String CUSTOM_SCALE_LABEL_PARAM_CHECK_NAME

See Also:

Constant Field Values

customScaleLabelCheckParam

protected BooleanParameter customScaleLabelCheckParam

SCALE_LABEL_PARAM_NAME

public static final String SCALE_LABEL_PARAM_NAME

See Also:

Constant Field Values

scaleLabelParam

protected StringParameter scaleLabelParam

adjustableParams

protected ParameterList adjustableParams

imgWebAddr

protected String imgWebAddr

Constructor Detail

GMT_MapGenerator

public GMT_MapGenerator()

Method Detail

makeMapLocally

public String makeMapLocally(GeoDataSet xyzDataSet,
                             String scaleLabel,
                             String metadata,
                             String dirName)
                      throws GMT_MapException

this function generates a GMT map from an XYZ data set using the current parameter settings, and using the version of GMT on the local computer.

Parameters:

xyzDataSet -

scaleLabel - - a string for the label (with no spaces!)

Returns:

- the name of the jpg file

Throws:

GMT_MapException

getGMTMapSpecification

public GMT_Map getGMTMapSpecification(GeoDataSet xyzData)

makeMapUsingServlet

public String makeMapUsingServlet(GeoDataSet xyzDataSet,
                                  String scaleLabel,
                                  String metadata,
                                  String dirName)
                           throws GMT_MapException,
                                  RuntimeException

This generates GMT map for the given XYZ dataset and for the current parameter setting, using the GMT Servlet on the SCEC server (the map is made on the SCEC server).

Parameters:

xyzDataSet -

scaleLabel - - a string for the label (with no spaces!)

Returns:

- the name of the jpg file

Throws:

GMT_MapException

RuntimeException

makeMapUsingServlet

public String makeMapUsingServlet(GMT_Map map,
                                  String metadata,
                                  String dirName)
                           throws GMT_MapException,
                                  RuntimeException

This generates GMT map for the given XYZ dataset and for the current parameter setting, using the GMT Servlet on the SCEC server (the map is made on the SCEC server).

Parameters:

xyzDataSet -

scaleLabel - - a string for the label (with no spaces!)

Returns:

- the name of the jpg file

Throws:

GMT_MapException

RuntimeException

makeMapUsingWebServer

public String makeMapUsingWebServer(GeoDataSet xyzDataSet,
                                    String scaleLabel,
                                    String metadata)
                             throws GMT_MapException

This generates GMT map for the given XYZ dataset and for the current parameter setting, using the GMT Web Service on the SCEC server (the map is made on the SCEC server).

Parameters:

xyzDataSet -

scaleLabel - - a string for the label (with no spaces!)

Returns:

- the name of the jpg file

Throws:

GMT_MapException

getAdjustableParamsIterator

public ListIterator getAdjustableParamsIterator()

method to get the adjustable parameters

getAdjustableParamsList

public ParameterList getAdjustableParamsList()

Returns:

the GMT Params List

getImageFileName

public String getImageFileName()

Returns:

the image file name

getMapInfoLines

protected ArrayList getMapInfoLines()

Returns:

the ArrayList containing the Metadata Info

makeFileFromLines

protected void makeFileFromLines(ArrayList lines,
                                 String fileName)

setMetatdataFileName

public void setMetatdataFileName(String fileName)

sets the name of the metadata file with fileName( with full path)

Parameters:

fileName -

openServletConnection

protected String openServletConnection(GMT_Map map,
                                       String metadataLines,
                                       String dirName)
                                throws RuntimeException

sets up the connection with the servlet on the server (gravity.usc.edu)

Throws:

RuntimeException

setParameter

public void setParameter(String paramName,
                         Object value)

This method allows one to set an adjustable parameter.

Parameters:

paramName - - the name of the Parameter to be set

value - - the desired parameter value

getGMTFilesWebAddress

public String getGMTFilesWebAddress()

Returns:

the WebAddress to the files if the person used the GMT webservice, to download all the files

getEvenlyGriddedGeographicRegion

public GriddedRegion getEvenlyGriddedGeographicRegion()

getGMT_ScriptLines

protected ArrayList getGMT_ScriptLines()
                                throws GMT_MapException

This method generates a list of strings needed for the GMT script

Throws:

GMT_MapException

getGMTColorString

public static String getGMTColorString(Color color)

getGMTPathEnvLines

public static ArrayList<String> getGMTPathEnvLines()

getGMT_ScriptLines

public ArrayList<String> getGMT_ScriptLines(GMT_Map map,
                                            String dir)
                                     throws GMT_MapException

This method generates a list of strings needed for the GMT script

Specified by:

getGMT_ScriptLines in interface SecureMapGenerator

Throws:

GMT_MapException

addCleanup

public static void addCleanup(ArrayList<String> gmtCommandLines,
                              ArrayList<String> rmFiles)

addHighwayCommand

public static void addHighwayCommand(ArrayList<String> gmtCommandLines,
                                     GMT_Map map,
                                     String region,
                                     String proj,
                                     String psFile)

addCoastCommand

public static void addCoastCommand(ArrayList<String> gmtCommandLines,
                                   GMT_Map map,
                                   String region,
                                   String proj,
                                   String psFile)

addPolyCommands

public static void addPolyCommands(ArrayList<String> gmtCommandLines,
                                   GMT_Map map,
                                   String region,
                                   String proj,
                                   String psFile)
                            throws GMT_MapException

Throws:

GMT_MapException

addSymbolCommands

public static void addSymbolCommands(ArrayList<String> gmtCommandLines,
                                     GMT_Map map,
                                     String region,
                                     String proj,
                                     String psFile)

addSymbolSetCommands

public static void addSymbolSetCommands(ArrayList<String> gmtCommandLines,
                                        GMT_Map map,
                                        String region,
                                        String proj,
                                        String psFile)

addSpecialElements

public static void addSpecialElements(ArrayList<String> gmtCommandLines,
                                      GMT_Map map,
                                      String region,
                                      String proj,
                                      String psFile)
                               throws GMT_MapException

Throws:

GMT_MapException

addColorbarCommand

public static void addColorbarCommand(ArrayList<String> gmtCommandLines,
                                      GMT_Map map,
                                      double colorScaleMin,
                                      double colorScaleMax,
                                      String cptFile,
                                      String psFile)

addColorbarCommand

public static void addColorbarCommand(ArrayList<String> gmtCommandLines,
                                      String scaleLabel,
                                      boolean isLog,
                                      double colorScaleMin,
                                      double colorScaleMax,
                                      String cptFile,
                                      String psFile)

addIntermediateGMT_ScriptLines

protected void addIntermediateGMT_ScriptLines(ArrayList gmtLines)

This method allows subclasses to add intemediate lines the the GMT script. For example, for Scenario ShakeMaps one might want to plot the Earthuake Rupture Surface. These lines have to be added at an intermediate step because the last layer in GMT has to have the "-O" but not "-K" option.

addFinalGMT_ScriptLines

protected void addFinalGMT_ScriptLines(ArrayList gmtCommandLines)

Function to adds any final commands desired by a subclass.

Parameters:

gmtCommandLines - : ArrayList to store the command line

createMapInfoFile

public void createMapInfoFile(String mapInfo)

This simply saves the supplied string to an ascii file that is placed in the same directory where the image, gmt script, etc. are placed. The name of the file is in the METADATA_FILE_NAME String. This is simply a method for saving arbitrary metatdata associated with a map.