ApproxGriddedSurface (nshmp-haz)

java.lang.Object
- gov.usgs.earthquake.nshmp.eq.fault.surface.ApproxGriddedSurface

All Implemented Interfaces:

GriddedSurface, RuptureSurface
```
public class ApproxGriddedSurface
extends Object
```
A GriddedSurface defined by an upper and lower trace whose spacing is scaled to the be as close to a desired target spacing as possible over the entire surface. The fault traces supplied to this surface must adhere to the right-hand-rule (dip of surface is to right of direction of travel along trace).

Author:

Ned Field, Peter Powers

Constructor Summary

Constructors
Constructor and Description
`ApproxGriddedSurface(LocationList upperTrace, LocationList lowerTrace, double spacing)` This constructor takes an upper and lower fault trace, re-samples these according the the given aveGridSpacing to represent the first and last rows of the surface, and then fills in the intermediate rows by evenly sampling a straight line between the top and bottom point of each column.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`double`	`area()` The surface area of this surface in km².
`Location`	`centroid()` The centroid of this surface.
`protected void`	`checkBounds(int row, int column)` Checks that the specified row and column are valid indices into the 2D array.
`void`	`clear()` Deprecated. Empties the list of all data.
`void`	`clear()` Removes all object reference stored in this container and resets all grid metics back to 0.
`double`	`depth()` The average depth to the top of this surface in km (always positive)
`double`	`dip()` The average dip of this surface in degrees [0°, 90°].
`double`	`dipDirection()` The average dip direction of this surface in degrees [0°, 360°).
`double`	`dipRad()` The average dip of this surface in radians [0, π/2].
`Distance`	`distanceTo(Location loc)` Returns the distance metrics commonly required by PSHA ground motion models (GMMs): rJB, rRup, and rX.
`boolean`	`exist(int row, int column)` Deprecated. Check if this grid cell has a java object stored in it.
`boolean`	`exist(int row, int column)` check if this grid cell has a java object stored in it.
`T`	`get(int row, int column)` Deprecated. Returns the object stored in this two dimensional grid cell.
`T`	`get(int row, int column)` Returns the object stored in this two dimensional cell.
`ListIterator<T>`	`getAllByColumnsIterator()` Deprecated. This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all rows within a column and then moving to the next column until iteration has been done over all rows and all columns.
`ListIterator<T>`	`getAllByColumnsIterator()` This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all rows within a column and then moving to the next column until iteration has been done over all rows and all columns.
`ListIterator<T>`	`getAllByRowsIterator()` Deprecated. This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all columns within a rows and then moving to the next column until iteration has been done over all columns and all rows.
`ListIterator<T>`	`getAllByRowsIterator()` This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all columns within a rows and then moving to the next column until iteration has been done over all columns and all rows.
`double`	`getAveGridSpacing()` This returns the average grid spacing used to define the discretization used in what's returned by the methods here that contain "Discretized" in their names.
`ListIterator<T>`	`getColumnIterator(int row)` Deprecated. Returns an ordered list iterator over all columns associated with one row.
`ListIterator<T>`	`getColumnIterator(int row)` Returns an ordered list iterator over all columns associated with one row.
`LocationList`	`getEvenlyDiscritizedListOfLocsOnSurface()` This returns a list of locations that are evenly spread (at least approximately) over the rupture surface, with a spacing given by what's returned by the getGridSpacing() method.
`LocationList`	`getEvenlyDiscritizedLowerEdge()` This returns a list of locations that are evenly spread along the lower edge of the surface.
`LocationList`	`getEvenlyDiscritizedPerimeter()` Deprecated.
`LocationList`	`getEvenlyDiscritizedUpperEdge()` This returns a list of locations that are evenly spread along the upper edge of the surface.
`Location`	`getFirstLocOnUpperEdge()` This returns the first location on row zero (which should be the same as the first loc of the FaultTrace)
`double`	`getGridSpacingAlongStrike()` Returns the grid spacing along strike
`double`	`getGridSpacingDownDip()` returns the grid spacing down dip
`Location`	`getLastLocOnUpperEdge()` This returns the last location on row zero (which may not be the same as the last loc of the FaultTrace depending on the discretization)
`Location`	`getLocation(int row, int column)` gets the location from the 2D container
`int`	`getNumCols()` Deprecated. Returns the number of columns in this two dimensional container.
`int`	`getNumCols()` Returns the number of columns in this two dimensional container.
`int`	`getNumRows()` Deprecated. Returns the number of rows int this two dimensional container.
`int`	`getNumRows()` Returns the number of rows int this two dimensional container.
`LocationList`	`getPerimeter()` Get a list of locations that constitutes the perimeter of the surface (not necessarily evenly spaced)
`LocationList`	`getRow(int row)`
`LocationList`	`getRowAsTrace(int row)` Gets a specified row as a fault trace
`ListIterator<T>`	`getRowIterator(int column)` Deprecated. Returns an ordered list iterator over all rows associated with one column.
`ListIterator<T>`	`getRowIterator(int column)` Returns an ordered list iterator over all rows associated with one column.
`LocationList`	`getUpperEdge()` This returns the upper edge of the rupture surface (where the locations are not necessarily equally spaced).
`Iterator<T>`	`iterator()`
`double`	`length()` The average length of the upper edge or trace of this surface in km.
`static void`	`main(String[] args)`
`String`	`name()` Gets the name of this container
`void`	`set(int row, int column, T obj)` Deprecated. Places a Java object into one cell in this two dimensional matrix specified by the row and column indices.
`void`	`set(int row, int column, T obj)` Places a Java object into one cell in this two dimensional matrix specified by the row and column indices.
`void`	`setName(String name)` Deprecated. Every container has a name associated with it to distinguish it from other container instances.
`void`	`setName(String name)` Sets the name of this container
`protected void`	`setNumRowsAndNumCols(int numRows, int numCols)` Sets the number of Rows and Cols of the 2D container object.
`long`	`size()` Deprecated. returns the number of cells in this two dimensional matrix, i.e.
`long`	`size()` returns the number of cells in this two dimensional matrix, i.e.
`double`	`strike()` The average strike of this surface in degrees [0°, 360°).
`Object[][]`	`toJava2D()` Converts our internal data structure to the Java 2 dimensional array.
`String`	`toString()` Prints out each location and fault information for debugging
`double`	`width()` The average down-dip width of this surface in km.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gov.usgs.earthquake.nshmp.util.Named
name

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Constructor Detail
  - ApproxGriddedSurface
```
public ApproxGriddedSurface(LocationList upperTrace,
                            LocationList lowerTrace,
                            double spacing)
```
    This constructor takes an upper and lower fault trace, re-samples these according the the given aveGridSpacing to represent the first and last rows of the surface, and then fills in the intermediate rows by evenly sampling a straight line between the top and bottom point of each column. The number of columns is the average length the top and bottom trace divided by the aveGridSpacing (plus 1), and the number of rows is the average distance between the top and bottom points in each column divided by the aveGridSpacing (plus 1). and then
    
    Parameters:
    
    upperTrace -
    
    lowerTrace -
    
    spacing -
- Method Detail
  - main
```
public static void main(String[] args)
```
    Parameters:
    
    args -
  - strike
```
public double strike()
```
    Description copied from interface: RuptureSurface
    
    The average strike of this surface in degrees [0°, 360°).
  - dip
```
public double dip()
```
    Description copied from interface: RuptureSurface
    
    The average dip of this surface in degrees [0°, 90°].
  - dipRad
```
public double dipRad()
```
    Description copied from interface: RuptureSurface
    
    The average dip of this surface in radians [0, π/2].
  - dipDirection
```
public double dipDirection()
```
    Description copied from interface: RuptureSurface
    
    The average dip direction of this surface in degrees [0°, 360°).
  - depth
```
public double depth()
```
    Description copied from interface: RuptureSurface
    
    The average depth to the top of this surface in km (always positive)
  - centroid
```
public Location centroid()
```
    Description copied from interface: RuptureSurface
    
    The centroid of this surface.
  - getRow
```
public LocationList getRow(int row)
```
  - getPerimeter
```
public LocationList getPerimeter()
```
    Description copied from interface: GriddedSurface
    
    Get a list of locations that constitutes the perimeter of the surface (not necessarily evenly spaced)
    
    Specified by:
    
    getPerimeter in interface GriddedSurface
  - getEvenlyDiscritizedListOfLocsOnSurface
```
public LocationList getEvenlyDiscritizedListOfLocsOnSurface()
```
    Description copied from interface: GriddedSurface
    
    This returns a list of locations that are evenly spread (at least approximately) over the rupture surface, with a spacing given by what's returned by the getGridSpacing() method. Further details are specified by the implementing class. Don't assume the locations are ordered as one reads the words on a page in a book (not the case for CompoundGriddedSurface).
    
    Specified by:
    
    getEvenlyDiscritizedListOfLocsOnSurface in interface GriddedSurface
  - getGridSpacingAlongStrike
```
public double getGridSpacingAlongStrike()
```
    Returns the grid spacing along strike
    
    Specified by:
    
    getGridSpacingAlongStrike in interface GriddedSurface
  - getGridSpacingDownDip
```
public double getGridSpacingDownDip()
```
    returns the grid spacing down dip
    
    Specified by:
    
    getGridSpacingDownDip in interface GriddedSurface
  - getEvenlyDiscritizedPerimeter
```
@Deprecated
public LocationList getEvenlyDiscritizedPerimeter()
```
    Deprecated.
    
    Description copied from interface: GriddedSurface
    
    This returns a list of locations that are evenly spread (at least approximately) over the surface perimeter, with a spacing given by what's returned by the getGridSpacing() method. Further details are specified by the implementing class. These locations should be ordered starting along the top and moving along following the Aki and Richards convention.
    
    Specified by:
    
    getEvenlyDiscritizedPerimeter in interface GriddedSurface
  - getLocation
```
public Location getLocation(int row,
                            int column)
```
    gets the location from the 2D container
    
    Specified by:
    
    getLocation in interface GriddedSurface
    
    Parameters:
    
    row -
    
    column -
  - getRowAsTrace
```
public LocationList getRowAsTrace(int row)
```
    Gets a specified row as a fault trace
    
    Parameters:
    
    row -
  - distanceTo
```
public Distance distanceTo(Location loc)
```
    Description copied from interface: RuptureSurface
    
    Returns the distance metrics commonly required by PSHA ground motion models (GMMs): rJB, rRup, and rX.
    
    Specified by:
    
    distanceTo in interface RuptureSurface
    
    Parameters:
    
    loc - Location to compute distances to
    
    Returns:
    
    a distance metric wrapper object
    
    See Also:
    
    Distance
  - getEvenlyDiscritizedUpperEdge
```
public LocationList getEvenlyDiscritizedUpperEdge()
```
    Description copied from interface: GriddedSurface
    
    This returns a list of locations that are evenly spread along the upper edge of the surface. Further details are specified by the implementing class. These locations should be ordered along the fault following the Aki and Richards convention. TODO move to Container2D topRow()
    
    Specified by:
    
    getEvenlyDiscritizedUpperEdge in interface GriddedSurface
  - getEvenlyDiscritizedLowerEdge
```
public LocationList getEvenlyDiscritizedLowerEdge()
```
    Description copied from interface: GriddedSurface
    
    This returns a list of locations that are evenly spread along the lower edge of the surface. Further details are specified by the implementing class. These locations should be ordered along the fault following the Aki and Richards convention. TODO move to Container2D bottomRow()
    
    Specified by:
    
    getEvenlyDiscritizedLowerEdge in interface GriddedSurface
  - getUpperEdge
```
public LocationList getUpperEdge()
```
    Description copied from interface: GriddedSurface
    
    This returns the upper edge of the rupture surface (where the locations are not necessarily equally spaced). This may be the original Fault Trace used to define the surface, but not necessarily.
    
    Specified by:
    
    getUpperEdge in interface GriddedSurface
  - getFirstLocOnUpperEdge
```
public Location getFirstLocOnUpperEdge()
```
    This returns the first location on row zero (which should be the same as the first loc of the FaultTrace)
    
    Specified by:
    
    getFirstLocOnUpperEdge in interface GriddedSurface
  - getLastLocOnUpperEdge
```
public Location getLastLocOnUpperEdge()
```
    This returns the last location on row zero (which may not be the same as the last loc of the FaultTrace depending on the discretization)
    
    Specified by:
    
    getLastLocOnUpperEdge in interface GriddedSurface
  - length
```
public double length()
```
    Description copied from interface: RuptureSurface
    
    The average length of the upper edge or trace of this surface in km.
    
    Specified by:
    
    length in interface RuptureSurface
  - width
```
public double width()
```
    Description copied from interface: RuptureSurface
    
    The average down-dip width of this surface in km.
    
    Specified by:
    
    width in interface RuptureSurface
  - area
```
public double area()
```
    Description copied from interface: RuptureSurface
    
    The surface area of this surface in km².
    
    Specified by:
    
    area in interface RuptureSurface
  - getAveGridSpacing
```
public double getAveGridSpacing()
```
    Description copied from interface: GriddedSurface
    
    This returns the average grid spacing used to define the discretization used in what's returned by the methods here that contain "Discretized" in their names.
    
    Specified by:
    
    getAveGridSpacing in interface GriddedSurface
  - toString
```
public String toString()
```
    Prints out each location and fault information for debugging
  - getNumRows
```
public int getNumRows()
```
    Deprecated.
    
    Returns the number of rows int this two dimensional container.
    
    Returns:
    
    Number of rows.
  - setName
```
public void setName(String name)
```
    Deprecated.
    
    Every container has a name associated with it to distinguish it from other container instances.
    
    Parameters:
    
    name -
  - getNumCols
```
public int getNumCols()
```
    Deprecated.
    
    Returns the number of columns in this two dimensional container.
    
    Returns:
    
    Get number of columns.
  - clear
```
public void clear()
```
    Deprecated.
    
    Empties the list of all data. Note, the data may still exist elsewhere if it is referenced elsewhere.
  - exist
```
public boolean exist(int row,
                     int column)
```
    Deprecated.
    
    Check if this grid cell has a java object stored in it. Returns false if this gird point object is null.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    column - The y coordinate of the cell.
    
    Returns:
    
    True if an object has been set in this cell.
  - size
```
public long size()
```
    Deprecated.
    
    returns the number of cells in this two dimensional matrix, i.e. numwRows * numCols.
    
    Returns:
    
    The number of cells.
  - set
```
public void set(int row,
                int column,
                T obj)
         throws ArrayIndexOutOfBoundsException,
                ClassCastException
```
    Deprecated.
    
    Places a Java object into one cell in this two dimensional matrix specified by the row and column indices.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    column - The y coordinate of the cell.
    
    obj - The Java object to place in the cell.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if the row and column are beyond the two dimensional matrix range.
    
    ClassCastException - Thrown by subclasses that expect a particular type of Java object.
  - get
```
public T get(int row,
             int column)
```
    Deprecated.
    
    Returns the object stored in this two dimensional grid cell.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    column - The y coordinate of the cell.
  - getColumnIterator
```
public ListIterator<T> getColumnIterator(int row)
                                  throws ArrayIndexOutOfBoundsException
```
    Deprecated.
    
    Returns an ordered list iterator over all columns associated with one row. This returns all the objects in that row. The results are returned from lowest index to highest along the interating row.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    Returns:
    
    The columnIterator value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if the row is beyond the two dimensional matrix range.
  - getRowIterator
```
public ListIterator<T> getRowIterator(int column)
                               throws ArrayIndexOutOfBoundsException
```
    Deprecated.
    
    Returns an ordered list iterator over all rows associated with one column. This returns all the objects in that column. The results are returned from lowest index to highest along the interating column.
    
    Parameters:
    
    column - The y coordinate of the cell.
    
    Returns:
    
    The rowIterator value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if the column is beyond the two dimensional matrix range.
  - getAllByColumnsIterator
```
public ListIterator<T> getAllByColumnsIterator()
```
    Deprecated.
    
    This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all rows within a column and then moving to the next column until iteration has been done over all rows and all columns.
    
    Returns:
    
    The allByColumnsIterator value
  - getAllByRowsIterator
```
public ListIterator<T> getAllByRowsIterator()
```
    Deprecated.
    
    This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all columns within a rows and then moving to the next column until iteration has been done over all columns and all rows.
    
    Returns:
    
    The allByRowsIterator value
  - setName
```
public void setName(String name)
```
    Sets the name of this container
  - name
```
public String name()
```
    Gets the name of this container
    
    Returns:
    
    the name
  - set
```
public void set(int row,
                int column,
                T obj)
         throws ArrayIndexOutOfBoundsException
```
    Places a Java object into one cell in this two dimensional matrix specified by the row and column indices.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    column - The y coordinate of the cell.
    
    obj - The Java object to place in the cell.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if the row and column are beyond the two dimensional matrix range.
  - setNumRowsAndNumCols
```
protected void setNumRowsAndNumCols(int numRows,
                                    int numCols)
```
    Sets the number of Rows and Cols of the 2D container object.
    
    Parameters:
    
    numRows - int number of rows
    
    numCols - int number of cols
  - getNumRows
```
public int getNumRows()
```
    Returns the number of rows int this two dimensional container.
    
    Returns:
    
    Number of rows.
  - getNumCols
```
public int getNumCols()
```
    Returns the number of columns in this two dimensional container.
    
    Returns:
    
    Get number of columns.
  - get
```
public T get(int row,
             int column)
```
    Returns the object stored in this two dimensional cell.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    column - The y coordinate of the cell.
  - getColumnIterator
```
public ListIterator<T> getColumnIterator(int row)
                                  throws ArrayIndexOutOfBoundsException
```
    Returns an ordered list iterator over all columns associated with one row. This returns all the objects in that row. The results are returned from lowest index to highest along the interating row.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    Returns:
    
    The columnIterator value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if the row is beyond the two dimensional matrix range.
  - getRowIterator
```
public ListIterator<T> getRowIterator(int column)
                               throws ArrayIndexOutOfBoundsException
```
    Returns an ordered list iterator over all rows associated with one column. This returns all the objects in that column. The results are returned from lowest index to highest along the interating column.
    
    Parameters:
    
    column - The y coordinate of the cell.
    
    Returns:
    
    The rowIterator value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if the column is beyond the two dimensional matrix range.
  - getAllByColumnsIterator
```
public ListIterator<T> getAllByColumnsIterator()
```
    This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all rows within a column and then moving to the next column until iteration has been done over all rows and all columns.
    
    Returns:
    
    The allByColumnsIterator value
  - getAllByRowsIterator
```
public ListIterator<T> getAllByRowsIterator()
```
    This returns an iterator of all the Java objects stored in this two dimensional matrix iterating over all columns within a rows and then moving to the next column until iteration has been done over all columns and all rows.
    
    Returns:
    
    The allByRowsIterator value
  - checkBounds
```
protected void checkBounds(int row,
                           int column)
                    throws ArrayIndexOutOfBoundsException
```
    Checks that the specified row and column are valid indices into the 2D array. Internal helper function used only by this class.
    
    Parameters:
    
    row - check row value less that max row index
    
    column - check col value less that max col index
    
    Throws:
    
    ArrayIndexOutOfBoundsException - Thrown if row or column < 0 or > max row or max col.
  - clear
```
public void clear()
```
    Removes all object reference stored in this container and resets all grid metics back to 0. Doesn't delete the actual objects, only removes the pointer references stored at each grid cell location.
  - exist
```
public boolean exist(int row,
                     int column)
```
    check if this grid cell has a java object stored in it. Returns false if this data point is null.
    
    Parameters:
    
    row - The x coordinate of the cell.
    
    column - The y coordinate of the cell.
    
    Returns:
    
    True if an object has been set in this cell.
  - size
```
public long size()
```
    returns the number of cells in this two dimensional matrix, i.e. numwRows * numCols.
    
    Returns:
    
    The number of cells.
  - toJava2D
```
public Object[][] toJava2D()
```
    Converts our internal data structure to the Java 2 dimensional array. Helper translation function.
    
    Returns:
    
    2D Object array - Object[][]
  - iterator
```
public Iterator<T> iterator()
```

Class ApproxGriddedSurface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface gov.usgs.earthquake.nshmp.util.Named

Methods inherited from interface java.lang.Iterable

Constructor Detail

ApproxGriddedSurface

Method Detail

main

strike

dip

dipRad

dipDirection

depth

centroid

getRow

getPerimeter

getEvenlyDiscritizedListOfLocsOnSurface

getGridSpacingAlongStrike

getGridSpacingDownDip

getEvenlyDiscritizedPerimeter

getLocation

getRowAsTrace

distanceTo

getEvenlyDiscritizedUpperEdge

getEvenlyDiscritizedLowerEdge

getUpperEdge

getFirstLocOnUpperEdge

getLastLocOnUpperEdge

length

width

area

getAveGridSpacing

toString

getNumRows

setName

getNumCols

clear

exist

size

set

get

getColumnIterator

getRowIterator

getAllByColumnsIterator

getAllByRowsIterator

setName

name

set

setNumRowsAndNumCols

getNumRows

getNumCols

get

getColumnIterator

getRowIterator

getAllByColumnsIterator

getAllByRowsIterator

checkBounds

clear

exist

size

toJava2D

iterator