Utils (fact-tools 1.1.3 API)

java.lang.Object
- fact.Utils

```
public class Utils
extends Object
```
Author:

Kai Bruegge <kai.bruegge@tu-dortmund.de>

Constructor Summary

Constructors
Constructor and Description

Utils()

Constructors
Constructor and Description
`Utils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`absPos(int pix, int slice, int roi)` Absolute position in the data array by pixel and slice
`static double[]`	`arrayListToDouble(ArrayList<Double> list)`
`static int[]`	`arrayListToInt(ArrayList<Integer> list)`
`static double[]`	`arrayMultiplication(double[] a, double[] b)` Elementwise multiplication of arrays
`static Double`	`arraySum(double[] a)` Sum up array
`static ArrayList<Integer>`	`arrayToList(int[] a)` make an Array of the type int[] into ArrayList.
`static double[]`	`averageSlicesForEachPixel(double[] data)` This takes a data array (of length pixels * roi) and returns an array(length = roi) in which each entry is the average over all the values of the other pixels in that slice.
`static ArrayList<PixelSet>`	`breadthFirstSearch(PixelSet showerPixel)` Finds all unconnected sets of pixel in the showerPixel List and returns a list of lists.
`static double[]`	`byteToDoubleArray(byte[] ar)`
`static double`	`calculateDistancePointToShowerAxis(double cogx, double cogy, double delta, double x, double y)`
`static org.apache.commons.math3.stat.descriptive.DescriptiveStatistics[]`	`calculateTimeseriesStatistics(double[][] data)` Calculate the statistics of given 2 dim data array, where the first field is the pixel Id and the second the slices.
`static void`	`checkWindow(int start, int size, int validLeft, int validRight)`
`static double[]`	`flatten2dArray(double[][] array2d)` Flatten a 2d array
`static double[]`	`floatToDoubleArray(float[] ar)`
`static ZonedDateTime`	`getTimeStamp(stream.Data item)` Check if the dataitem has the timestamp key, if not return the MC data default timestamp
`static ZonedDateTime`	`getTimeStamp(stream.Data item, String timeStampKey)` Check if the dataitem has the timestamp key, if not return the MC data default timestamp
`static int[]`	`getValidPixelSetAsIntArr(stream.Data item, int npix, String pixelSetKey)` Return an int array with the ids of the pixelSet belonging to the given Key, return all camera pixel Ids if the set is not existing
`static int[]`	`getValidWindow(int start, int size, int validLeft, int validRight)`
`static double[]`	`intToDoubleArray(int[] ar)`
`static void`	`isKeyValid(stream.Data item, String key, Class<?> type)` This method tries to find the key in the data item and tries to cast them into the type given by the type parameter.
`static void`	`mapContainsKeys(stream.Data item, Collection<String> keys)` This is a helper method which checks if all the keys provided are in the data item.
`static void`	`mapContainsKeys(stream.Data item, String... keys)` This is a helper method which checks if all the keys provided are in the data item.
`static double[]`	`shortToDoubleArray(short[] ar)`
`static double[][]`	`snipPixelData(double[] data, int skipFirst, int skipLast, int npix, int roi)` Convert the fact data array to a 2 dim array of pixels and slices and snip out an desired window of slices
`static double[][]`	`sortPixels(double[] data, int numPixel)` Return a 2D array
`static double[]`	`toDoubleArray(Serializable arr)` This is method might be useful for getting stuff from the data items and, if possible, cast it into a double array.
`static double[]`	`transformToEllipseCoordinates(double x, double y, double cogX, double cogY, double delta)` Transforms camera coordinates (x, y) into longitudinal and transversal ellipse coordinates (l, t).
`static ZonedDateTime`	`unixTimeUTCToZonedDateTime(int[] unixTimeUTC)`
`static double`	`valueToDouble(Serializable val)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Utils
```
public Utils()
```
- Method Detail
  - unixTimeUTCToZonedDateTime
```
public static ZonedDateTime unixTimeUTCToZonedDateTime(int[] unixTimeUTC)
```
  - sortPixels
```
public static double[][] sortPixels(double[] data,
                                    int numPixel)
```
    Return a 2D array
  - getValidPixelSetAsIntArr
```
public static int[] getValidPixelSetAsIntArr(stream.Data item,
                                             int npix,
                                             String pixelSetKey)
```
    Return an int array with the ids of the pixelSet belonging to the given Key, return all camera pixel Ids if the set is not existing
  - averageSlicesForEachPixel
```
public static double[] averageSlicesForEachPixel(double[] data)
```
    This takes a data array (of length pixels * roi) and returns an array(length = roi) in which each entry is the average over all the values of the other pixels in that slice.
    
    Parameters:
    
    data - array of length pixels*region of interest
    
    Returns:
    
    an array of length roi containing the slice averages
  - breadthFirstSearch
```
public static ArrayList<PixelSet> breadthFirstSearch(PixelSet showerPixel)
```
    Finds all unconnected sets of pixel in the showerPixel List and returns a list of lists. Each list containing one separate set. Does a BFs search. See the wikipedia article on BFS. This version is not as memory efficient as it could be.
    
    Parameters:
    
    showerPixel - the list to search in
    
    Returns:
    
    A list of lists.
  - arrayToList
```
public static ArrayList<Integer> arrayToList(int[] a)
```
    make an Array of the type int[] into ArrayList. We need this because there is no autoboxing between Integer and int types hence Arrays.aslist cannot be used for this conversion
  - floatToDoubleArray
```
public static double[] floatToDoubleArray(float[] ar)
```
  - intToDoubleArray
```
public static double[] intToDoubleArray(int[] ar)
```
  - shortToDoubleArray
```
public static double[] shortToDoubleArray(short[] ar)
```
  - byteToDoubleArray
```
public static double[] byteToDoubleArray(byte[] ar)
```
  - toDoubleArray
```
public static double[] toDoubleArray(Serializable arr)
```
    This is method might be useful for getting stuff from the data items and, if possible, cast it into a double array. This is not very fast. And its also very ugly. But thats okay. I still like you
    
    Parameters:
    
    arr -
    
    Returns:
    
    can be null!
  - valueToDouble
```
public static double valueToDouble(Serializable val)
```
  - arrayListToDouble
```
public static double[] arrayListToDouble(ArrayList<Double> list)
```
  - arrayListToInt
```
public static int[] arrayListToInt(ArrayList<Integer> list)
```
  - mapContainsKeys
```
public static void mapContainsKeys(stream.Data item,
                                   String... keys)
```
    This is a helper method which checks if all the keys provided are in the data item. If one of the keys is not in the item a RuntimeException will be thrown containing a message detailing which processor is causing the error
    
    Parameters:
    
    item -
    
    keys -
  - mapContainsKeys
```
public static void mapContainsKeys(stream.Data item,
                                   Collection<String> keys)
```
    This is a helper method which checks if all the keys provided are in the data item. If one of the keys is not in the item a RuntimeException will be thrown containing a message detailing which processor is causing the error
    
    Parameters:
    
    item -
    
    keys -
  - isKeyValid
```
public static void isKeyValid(stream.Data item,
                              String key,
                              Class<?> type)
```
    This method tries to find the key in the data item and tries to cast them into the type given by the type parameter. If it fails it will throw a RuntimeException with a message containing information about the error.
    
    Parameters:
    
    item -
    
    key -
    
    type -
  - transformToEllipseCoordinates
```
public static double[] transformToEllipseCoordinates(double x,
                                                     double y,
                                                     double cogX,
                                                     double cogY,
                                                     double delta)
```
    Transforms camera coordinates (x, y) into longitudinal and transversal ellipse coordinates (l, t). The ellipse coordinate system is defined by the center of gravity (x,y) and the angle between the major axis and the camera x-axis (delta in radians).
    
    Parameters:
    
    x -
    
    y -
    
    cogX -
    
    cogY -
    
    delta -
    
    Returns:
    
    an array having two elements {l, t}
  - calculateDistancePointToShowerAxis
```
public static double calculateDistancePointToShowerAxis(double cogx,
                                                        double cogy,
                                                        double delta,
                                                        double x,
                                                        double y)
```
  - arraySum
```
public static Double arraySum(double[] a)
```
    Sum up array
    
    Parameters:
    
    a -
    
    Returns:
  - arrayMultiplication
```
public static double[] arrayMultiplication(double[] a,
                                           double[] b)
                                    throws ArrayStoreException
```
    Elementwise multiplication of arrays
    
    Parameters:
    
    a -
    
    b -
    
    Returns:
    
    double array containing a[i] * b[i]
    
    Throws:
    
    ArrayStoreException
  - getValidWindow
```
public static int[] getValidWindow(int start,
                                   int size,
                                   int validLeft,
                                   int validRight)
```
  - checkWindow
```
public static void checkWindow(int start,
                               int size,
                               int validLeft,
                               int validRight)
```
  - absPos
```
public static int absPos(int pix,
                         int slice,
                         int roi)
```
    Absolute position in the data array by pixel and slice
    
    Parameters:
    
    pix -
    
    slice -
    
    Returns:
    
    absolute array position
  - snipPixelData
```
public static double[][] snipPixelData(double[] data,
                                       int skipFirst,
                                       int skipLast,
                                       int npix,
                                       int roi)
```
    Convert the fact data array to a 2 dim array of pixels and slices and snip out an desired window of slices
    
    Parameters:
    
    data -
    
    skipFirst -
    
    skipLast -
    
    npix -
    
    Returns:
    
    2dim snipped data array
  - calculateTimeseriesStatistics
```
public static org.apache.commons.math3.stat.descriptive.DescriptiveStatistics[] calculateTimeseriesStatistics(double[][] data)
```
    Calculate the statistics of given 2 dim data array, where the first field is the pixel Id and the second the slices.
    
    Parameters:
    
    data -
    
    Returns:
    
    pixel array of Descriptive Statistics
  - flatten2dArray
```
public static double[] flatten2dArray(double[][] array2d)
```
    Flatten a 2d array
    
    Parameters:
    
    array2d - 2dim double array
    
    Returns:
    
    flattend double array
  - getTimeStamp
```
public static ZonedDateTime getTimeStamp(stream.Data item)
```
    Check if the dataitem has the timestamp key, if not return the MC data default timestamp
    
    Parameters:
    
    item - The event to process
    
    Returns:
    
    The timestamp of the event
  - getTimeStamp
```
public static ZonedDateTime getTimeStamp(stream.Data item,
                                         String timeStampKey)
```
    Check if the dataitem has the timestamp key, if not return the MC data default timestamp
    
    Parameters:
    
    item - The event to process
    
    Returns:
    
    The timestamp of the event

Class Utils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Utils

Method Detail

unixTimeUTCToZonedDateTime

sortPixels

getValidPixelSetAsIntArr

averageSlicesForEachPixel

breadthFirstSearch

arrayToList

floatToDoubleArray

intToDoubleArray

shortToDoubleArray

byteToDoubleArray

toDoubleArray

valueToDouble

arrayListToDouble

arrayListToInt

mapContainsKeys

mapContainsKeys

isKeyValid

transformToEllipseCoordinates

calculateDistancePointToShowerAxis

arraySum

arrayMultiplication

getValidWindow

checkWindow

absPos

snipPixelData

calculateTimeseriesStatistics

flatten2dArray

getTimeStamp

getTimeStamp