fact.pedestalSuperposition

Class SamplePedestalEvent

java.lang.Object

fact.pedestalSuperposition.SamplePedestalEvent

All Implemented Interfaces:

stream.Processor, stream.StatefulProcessor

public class SamplePedestalEvent
extends Object
implements stream.StatefulProcessor

This processors loads the given noise database and randomly chooses for each event processed a noise event, which is then loaded into the item, with the keys prepended with the string prependKey.

Author:

mbulinski

Field Summary

Fields

Modifier and Type	Field and Description
String[]	binning
String	dataFolder
String	dbBinningKey
String	itemBinningKey
int	maxIterations
String	noiseCondition
stream.io.SourceURL	noiseDatabase
String	prependKey
String	samplingTryKey
long	seed

Constructor Summary

Constructors

Constructor and Description
SamplePedestalEvent()

Method Summary

Modifier and Type	Method and Description
static double[]	createBinning(String[] binning) Given a string array create the binning.
void	finish()
protected int	getBin(double data) Given a value data, calculate the bin it would end up in.
void	init(stream.ProcessContext processContext)
stream.Data	process(stream.Data input)
void	resetState()
void	setBinning(String[] binning)
void	setNoiseCondition(String noiseCondition)

Methods inherited from class java.lang.Object

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

Field Detail

seed

@Parameter(required=false,
           defaultValue="0",
           description="The seed to make the results reproductable if desired.")
public long seed

noiseDatabase

@Parameter(required=true,
           description="The file containing the noise database for the noise to be used.")
public stream.io.SourceURL noiseDatabase

dataFolder

@Parameter(required=true,
           description="The folder containing the data files in FACTS canonical folder structure.")
public String dataFolder

prependKey

@Parameter(required=false,
           defaultValue="",
           description="The value to prepend all keys from the noise file. (Exp: prependKey=\'Noise_\', \'ZdPointing\'->\'Noise_ZdPointing\'")
public String prependKey

noiseCondition

@Parameter(required=false,
           description="The condition for the noise which will be used")
public String noiseCondition

binning

@Parameter(required=true,
           description="The binning of the zenith-angle. If single value: steplenght, bins into the given steplengthIf multivalue: Each value is the length of a single step starting with zenith=0.")
public String[] binning

dbBinningKey

@Parameter(required=true,
           description="The binning key of the double value from the noise database. e.g. key of the Zd value in the provided noise DB. A bin will be chosen according to the itemBinningKey")
public String dbBinningKey

itemBinningKey

@Parameter(required=true,
           description="The binning key of the double value from the item.")
public String itemBinningKey

samplingTryKey

@Parameter(required=true,
           description="The key which will hold the amount of sampling tries.")
public String samplingTryKey

maxIterations

@Parameter(required=false,
           defaultValue="10",
           description="number of max sampling iteration if a pedestal event is not readable")
public int maxIterations

Constructor Detail

SamplePedestalEvent

public SamplePedestalEvent()

Method Detail

process

public stream.Data process(stream.Data input)

Specified by:

process in interface stream.Processor

setNoiseCondition

public void setNoiseCondition(String noiseCondition)

createBinning

public static double[] createBinning(String[] binning)

Given a string array create the binning. If the array is a single element use it as the binwidth. I more than one element is given each Element represents the right edge of a bin.

Parameters:

binning - The binning given as a string array.

Returns:

setBinning

public void setBinning(String[] binning)

getBin

protected int getBin(double data)

Given a value data, calculate the bin it would end up in.

Parameters:

data -

Returns:

init

public void init(stream.ProcessContext processContext)
          throws Exception

Specified by:

init in interface stream.StatefulProcessor

Throws:

Exception

resetState

public void resetState()
                throws Exception

Specified by:

resetState in interface stream.StatefulProcessor

Throws:

Exception

finish

public void finish()
            throws Exception

Specified by:

finish in interface stream.StatefulProcessor

Throws:

Exception