fact.datacorrection

Class DrsCalibration

java.lang.Object

fact.datacorrection.DrsCalibration

All Implemented Interfaces:

stream.Processor, stream.StatefulProcessor

public class DrsCalibration
extends Object
implements stream.StatefulProcessor

This processor handles the DRS calibration. It requires a DRS data source either as File or URL and will read the DRS data from that. This data is then applied to all FactEvents processed by this class.

Author:

Christian Bockermann <christian.bockermann@udo.edu> , Michael Bulinski <michael.bulinski@udo.edu>

Field Summary

Fields

Modifier and Type	Field and Description
String	drsFileOutputKey
URL	drsFileURL
String	drsKey
String	outputKey
boolean	reverse
String	startCellKey
String	url

Constructor Summary

Constructors

Constructor and Description
DrsCalibration()

Method Summary

Modifier and Type	Method and Description
double[]	applyDrsCalibration(double[] data, double[] destination, short[] startCellVector)
void	finish()
void	init(stream.ProcessContext processContext)
protected void	loadDrsData(URL in) This method reads the DRS calibration values from the given data source.
stream.Data	process(stream.Data data)
void	resetState()
double[]	reverseDrsCalibration(double[] data, double[] destination, short[] startCellVector) Reverses the drsCalibration performed in applyDrsCalibration.

Methods inherited from class java.lang.Object

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

Field Detail

outputKey

@Parameter(required=false,
           description="The data key that will hold the resulting data array.")
public String outputKey

url

@Parameter(required=false,
           description="A URL to the DRS calibration data (in FITS formats)",
           defaultValue="Null. Will try to find path to drsFile from the stream.")
public String url

startCellKey

@Parameter(required=false,
           description="Key to the StartCellData.")
public String startCellKey

drsFileURL

public URL drsFileURL

drsKey

@Parameter(required=false,
           description="The name of the key that holds the drs filename.",
           defaultValue="@drsFile")
public String drsKey

reverse

@Parameter(required=false,
           description="Whether to reverse the process.",
           defaultValue="false")
public boolean reverse

drsFileOutputKey

@Parameter(required=false,
           description="output key for the used drs file")
public String drsFileOutputKey

Constructor Detail

DrsCalibration

public DrsCalibration()

Method Detail

loadDrsData

protected void loadDrsData(URL in)

This method reads the DRS calibration values from the given data source. The datasource is expected to be a FITS file that provides at least one data item/row (only the first will be read).

That item/row in turn is expected to contain a set of variables, e.g. the BaselineMean, BaselineRms,...

Parameters:

in - sourceurl to be loaded

process

public stream.Data process(stream.Data data)

Specified by:

process in interface stream.Processor

See Also:

Processor.process(stream.Data)

applyDrsCalibration

public double[] applyDrsCalibration(double[] data,
                                    double[] destination,
                                    short[] startCellVector)

reverseDrsCalibration

public double[] reverseDrsCalibration(double[] data,
                                      double[] destination,
                                      short[] startCellVector)

Reverses the drsCalibration performed in applyDrsCalibration.

Parameters:

data - The calibrated data the decalibrate.

destination - If given use this as the destination array otherwise a new one is created.

startCellVector - The array containing the start cells used to know which calibration constants to use.

Returns:

The decalibrated data array

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