fact.extraction

Class NeighborPixelDCF

java.lang.Object

fact.extraction.NeighborPixelDCF

All Implemented Interfaces:

stream.Processor, stream.StatefulProcessor

public class NeighborPixelDCF
extends Object
implements stream.StatefulProcessor

Calculate the Descrete Correlation Function for the Time Series of neigbouring pixels as a measure for their correllation

Created by jebuss on 10.08.16.

Field Summary

Fields

Modifier and Type	Field and Description
String	key
String	neighborPixDCFKey
String	noiseKey
String	pixelSetKey
int	skipFirst
int	skipLast

Constructor Summary

Constructors

Constructor and Description
NeighborPixelDCF()

Method Summary

Modifier and Type	Method and Description
double	DCF(int t, double[] a, double[] b, double meanA, double meanB, double UDCFNorm) Calculate the descrete correlation function for a pair of values
void	finish()
void	init(stream.ProcessContext context)
stream.Data	process(stream.Data input)
void	resetState()
double	UDCF(double a, double b, double meanA, double meanB, double UDCFNorm) Calculate the unbinned descrete correlation function for a pair of values
double	UDCFNorm(double stdDevA, double stdDevB, double noiseA, double noiseB) Calculate the norm for the unbinned descrete correlation function

Methods inherited from class java.lang.Object

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

Field Detail

key

@Parameter(required=true,
           description="raw data array")
public String key

noiseKey

@Parameter(required=false,
           description="pixel array containing a noise estimation for each pixel")
public String noiseKey

pixelSetKey

@Parameter(description="Key of the pixel sample that should be used, if no pixelset is given, the whole camera is used",
           defaultValue="")
public String pixelSetKey

skipFirst

@Parameter(description="Number of slices to be skipped at the time lines beginning",
           defaultValue="30")
public int skipFirst

skipLast

@Parameter(description="Number of slices to be skipped at the time lines end",
           defaultValue="50")
public int skipLast

neighborPixDCFKey

@Parameter(required=false,
           description="Outputkey for the mean correlation of neighbouring pixels")
public String neighborPixDCFKey

Constructor Detail

NeighborPixelDCF

public NeighborPixelDCF()

Method Detail

process

public stream.Data process(stream.Data input)

Specified by:

process in interface stream.Processor

DCF

public double DCF(int t,
                  double[] a,
                  double[] b,
                  double meanA,
                  double meanB,
                  double UDCFNorm)

Calculate the descrete correlation function for a pair of values

Parameters:

t - shift of the arrays

a - first array

b - second array

meanA - mean of a

meanB - mean of b

UDCFNorm -

Returns:

descrete correlation

UDCF

public double UDCF(double a,
                   double b,
                   double meanA,
                   double meanB,
                   double UDCFNorm)

Calculate the unbinned descrete correlation function for a pair of values

Parameters:

a - first value

b - second value

meanA - mean of the a's origin

meanB - mean of the b's origin

UDCFNorm -

Returns:

unbinned descrete correlation

UDCFNorm

public double UDCFNorm(double stdDevA,
                       double stdDevB,
                       double noiseA,
                       double noiseB)

Calculate the norm for the unbinned descrete correlation function

Parameters:

stdDevA - standard deviation of a

stdDevB - standard deviation of b

noiseA - noise of a

noiseB - noise of b

Returns:

unbinned descrete correlation

init

public void init(stream.ProcessContext context)
          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