gov.usgs.earthquake.nshmp.calc

Class HazardExport

java.lang.Object

gov.usgs.earthquake.nshmp.calc.HazardExport

public final class HazardExport
extends Object

Hazard calculation result exporter.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
void	add(Hazard hazard, Optional<Deaggregation> deagg) Add a Hazard and optional Deaggregation result to this handler.
static HazardExport	create(CalcConfig config, Sites sites, Logger log) Create a new results handler.
static Map<Imt,Map<Gmm,XySequence>>	curvesByGmm(Hazard hazard) Derive maps of curves by Gmm for each Imt in a Hazard result.
static Map<Imt,Map<SourceType,XySequence>>	curvesBySource(Hazard hazard) Derive maps of curves by SourceType for each Imt.
String	elapsedTime() A string representation of the time duration that this result handler has been running.
void	expire() Calls flush() a final time, stops all timers and sets the state of this Results instance to 'used'; no more results may be added.
void	flush() Flush any stored Hazard and Deaggregation results to file, clearing
Path	outputDir() The target output directory established by this handler.
int	resultsProcessed() The number of hazard [and deagg] results passed to this handler thus far.
int	size() The number of Hazard results this handler is currently storing.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static HazardExport create(CalcConfig config,
                                  Sites sites,
                                  Logger log)
                           throws IOException

Create a new results handler.

Parameters:

config - that specifies output options and formats

sites - reference to the sites to be processed (not retained)

log - shared logging instance from calling class

Throws:

IllegalStateException - if binary output has been specified in the config but the sites container does not specify map extents.

IOException

add

public void add(Hazard hazard,
                Optional<Deaggregation> deagg)
         throws IOException

Add a Hazard and optional Deaggregation result to this handler.

Parameters:

hazard - to add

deagg - to add

Throws:

IOException

flush

public void flush()
           throws IOException

Flush any stored Hazard and Deaggregation results to file, clearing

Throws:

IOException

expire

public void expire()
            throws IOException

Calls flush() a final time, stops all timers and sets the state of this Results instance to 'used'; no more results may be added.

Throws:

IOException

resultsProcessed

public int resultsProcessed()

The number of hazard [and deagg] results passed to this handler thus far.

size

public int size()

The number of Hazard results this handler is currently storing.

elapsedTime

public String elapsedTime()

A string representation of the time duration that this result handler has been running.

outputDir

public Path outputDir()

The target output directory established by this handler.

curvesBySource

public static Map<Imt,Map<SourceType,XySequence>> curvesBySource(Hazard hazard)

Derive maps of curves by SourceType for each Imt.

curvesByGmm

public static Map<Imt,Map<Gmm,XySequence>> curvesByGmm(Hazard hazard)

Derive maps of curves by Gmm for each Imt in a Hazard result.