org.hps.recon.ecal.cluster

Interface NumericalCuts

All Known Implementing Classes:

NumericalCutsImpl

public interface NumericalCuts

This is an interface for accessing the numerical cut values of a clustering algorithm by index or name.

The default units are generally GeV for energy and nanoseconds for time, though this is not in any way modeled by this class.

Author:

Jeremy McCormick

Method Summary

Modifier and Type	Method and Description
double[]	getDefaultValues() Get the default cuts.
String[]	getNames() Get the names of the cuts.
double	getValue(int index) Get a cut value by index.
double	getValue(String name) Get a cut setting by name.
double[]	getValues() Get the cut values.
boolean	isDefaultValues() True if using the default cuts.
void	setValue(int index, double value) Set the value of a cut by index.
void	setValue(String name, double value) Set a cut value by name.
void	setValues(double[] values) Set all the cut values from an array.
void	setValues(Map<String,Double> valueMap) Set the cut values from a map of keys to values.

Method Detail

setValues

void setValues(double[] values)

Set all the cut values from an array.

Parameters:

values - The cut values.

getValues

double[] getValues()

Get the cut values.

Returns:

The cut values array.

getValue

double getValue(String name)

Get a cut setting by name.

Parameters:

name - The name of the cut.

Returns:

The cut value.

getValue

double getValue(int index)

Get a cut value by index.

Parameters:

index - The index of the cut.

Returns:

The cut value from the index.

getNames

String[] getNames()

Get the names of the cuts.

Returns:

The names of the cuts.

setValue

void setValue(int index,
              double value)

Set the value of a cut by index.

Parameters:

index - The index of the cut.

value - The value of the cut.

setValue

void setValue(String name,
              double value)

Set a cut value by name.

Parameters:

name - The name of the cut.

value - The value of the cut.

isDefaultValues

boolean isDefaultValues()

True if using the default cuts.

Returns:

True if using default cuts.

getDefaultValues

double[] getDefaultValues()

Get the default cuts.

Returns:

The default cuts.

setValues

void setValues(Map<String,Double> valueMap)

Set the cut values from a map of keys to values.

Parameters:

valueMap - The cut values as a map.