gov.usgs.earthquake.nshmp.eq.fault.surface

Interface GriddedSurface

All Superinterfaces:

RuptureSurface

All Known Implementing Classes:

ApproxGriddedSurface, DefaultGriddedSurface

public interface GriddedSurface
extends RuptureSurface

Method Summary

Modifier and Type	Method and Description
void	clear() Deprecated. Empties the list of all data.
boolean	exist(int row, int column) Deprecated. 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.
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>	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.
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.
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() Deprecated.
double	getGridSpacingAlongStrike() Returns the grid spacing along strike
double	getGridSpacingDownDip() returns the grid spacing down dip
Location	getLastLocOnUpperEdge() Deprecated.
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	getNumRows() Deprecated. 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)
ListIterator<T>	getRowIterator(int column) Deprecated. 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).
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	setName(String name) Deprecated. Every container has a name associated with it to distinguish it from other container instances.
long	size() Deprecated. returns the number of cells in this two dimensional matrix, i.e.

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

name

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface gov.usgs.earthquake.nshmp.eq.fault.surface.RuptureSurface

area, centroid, depth, dip, dipDirection, dipRad, distanceTo, length, strike, width

Method Detail

getGridSpacingAlongStrike

double getGridSpacingAlongStrike()

Returns the grid spacing along strike

getGridSpacingDownDip

double getGridSpacingDownDip()

returns the grid spacing down dip

getLocation

Location getLocation(int row,
                     int column)

gets the location from the 2D container

Parameters:

row - index

column - index

getAveGridSpacing

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.

getEvenlyDiscritizedListOfLocsOnSurface

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. 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).

getEvenlyDiscritizedPerimeter

@Deprecated
LocationList getEvenlyDiscritizedPerimeter()

Deprecated.

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.

getEvenlyDiscritizedUpperEdge

LocationList getEvenlyDiscritizedUpperEdge()

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()

getEvenlyDiscritizedLowerEdge

LocationList getEvenlyDiscritizedLowerEdge()

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()

getUpperEdge

LocationList getUpperEdge()

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.

getPerimeter

LocationList getPerimeter()

Get a list of locations that constitutes the perimeter of the surface (not necessarily evenly spaced)

getFirstLocOnUpperEdge

@Deprecated
Location getFirstLocOnUpperEdge()

Deprecated.

This returns the first location on the upper edge of the surface

getLastLocOnUpperEdge

@Deprecated
Location getLastLocOnUpperEdge()

Deprecated.

This returns the last location on the upper edge of the surface

getNumRows

int getNumRows()

Deprecated.

Returns the number of rows int this two dimensional container.

Returns:

Number of rows.

setName

void setName(String name)

Deprecated.

Every container has a name associated with it to distinguish it from other container instances.

Parameters:

name -

getNumCols

int getNumCols()

Deprecated.

Returns the number of columns in this two dimensional container.

Returns:

Get number of columns.

clear

void clear()

Deprecated.

Empties the list of all data. Note, the data may still exist elsewhere if it is referenced elsewhere.

exist

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

long size()

Deprecated.

returns the number of cells in this two dimensional matrix, i.e. numwRows * numCols.

Returns:

The number of cells.

set

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

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

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

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

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

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