Package org.ivoa.dm.caom2

Class Metrics.MetricsBuilder

java.lang.Object

org.ivoa.dm.caom2.Metrics.MetricsBuilder

Enclosing class:

Metrics

public static class Metrics.MetricsBuilder
extends Object

A builder class for Metrics, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
Double	background	background level.
Double	backgroundStddev	standard deviation in the background level.
Double	fluxDensityLimit	flux density with a signal:noise ratio of 10.
Double	magLimit	magnitude with a signal:noise ratio of 10.
Double	sampleSNR	signal:noise ratio for a representative subset of samples.
Double	sourceNumberDensity	number of sources detected per unit area.

Constructor Summary

Constructors

Constructor	Description
MetricsBuilder()

Method Summary

Modifier and Type	Method	Description
Metrics	create()	create a Metrics from this builder.

Methods inherited from class java.lang.Object

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

Field Details

sourceNumberDensity

public Double sourceNumberDensity

number of sources detected per unit area.

background

public Double background

background level.

backgroundStddev

public Double backgroundStddev

standard deviation in the background level.

fluxDensityLimit

public Double fluxDensityLimit

flux density with a signal:noise ratio of 10.

magLimit

public Double magLimit

magnitude with a signal:noise ratio of 10.

sampleSNR

public Double sampleSNR

signal:noise ratio for a representative subset of samples.

Constructor Details

MetricsBuilder

public MetricsBuilder()

Method Details

create

public Metrics create()

create a Metrics from this builder.

Returns:

an object initialized from the builder.