pylal.autotrackutils.TGN

Class TGN

This class provides the definition of a single defined autotrack defined neighborhood. We use these neighborhoods to track how the instrument behavior groups change, appear or disappear.

Instance Methods

[hide private]

__init__(self)
This method initializes an empty neighborhood.

source code

__setID__(self, inputArg)
Should set the ID numeric field

source code

getID(self)
Fetches the numeric ID assigned to this TGN instance

source code

__setBirthDate__(self, bDate=str(""))
Set a text string which is the GPS birthdate, as closely as possible for this neighborhood.

source code

__setGPS__(self, gps=int(0))
Set a text string which is the GPS birthdate, as closely as possible for this neighborhood.

source code

getBirthDateText(self)
This retrieves the text string birthdate stored in TGN instance.

source code

getGPS(self)
This retrieves the integer GPS birthdate stored in TGN instance.

source code

createFromString(self, mString, bString, delim=" ")
This input method assumes you've opened a text file container and will input the data from text strings.

source code

reverseCreateFromString(self)
Returns a tuple of two strings, that can be dumped to disk and read back into a TGN object with method createFromString()

source code

__setMemberCount__(self, mCount=0)
Sets the tally of members in the group.

source code

getMemberCount(self)
get the registered members listed for this TGN

source code

__setVolume__(self, volume=0)
Sets the volume value of this grouping.

source code

getVolume(self)
Gets the registered volume for a given TGN.

source code

exportToString(self)
Create a text string that can be directly inserted into the text field of the sqlite database table TGN.

source code

getDensity(self)
Returns the value of TGN density set.

source code

__setDensity__(self, inputArg)
Sets the input density value to the TGN instance.

source code

isNULL(self)
Check the defined properties, returns true if they are all zeroed out which is NULL according the the matlab generator.

source code

getBoundVector(self)
Gets the variance components of this TGN instance.

source code

getCenterVector(self)
Gets the center of the neighborhood

source code

getCentroidErrorViaIndex(self, index=0)
Given an index select the that index from the Center vector and the bound Vector.

source code

isSame(self, TGN)
Checks to see if self instance is IDENTICAL to TGN instance given as argument!

source code

checkOverlap(self, TGN, boundSize=0.5, mutual=bool(True))
Check to see if SELF neighborhood overlaps with other input TGN class.

source code

getSeparation(self, TGN)
Gets the resultant seperation vectors and normalizes this value by the boundVector, then use this to compute a normalized magnitude of the vector.

source code

spatialAxisMinMax(self, TGN)
Return the index returned by getCenterVector for self the spatial axis with the smallest difference between self.getCenterVector and TGN.getCenterVector returns a tuple of two indices {minAxisIndex,maxAxisIndex}

source code

nearestTGNid(self, TGNList, boundSize=0.5)
wrapper

source code

nearestTGN(self, TGNList, boundSize=0.5)
Takes a list of TGNs and compares it to self to determine which is the closest one, this ideally is the same group and we can associate the group IDs.

source code

init(self)
(Constructor)

source code

This method initializes an empty neighborhood. To populate the neightborhood invoke the proper method depending on the source of the data, ie ascii mysql etc

createFromString(self, mString, bString, delim=" ")

source code

This input method assumes you've opened a text file container and will input the data from text strings. The assumed delimiter is a space but can be set in the method call.

getCentroidErrorViaIndex(self, index=0)

source code

Given an index select the that index from the Center vector and the bound Vector. This will return a tuple (center,bound)

checkOverlap(self, TGN, boundSize=0.5, mutual=bool(True))

source code

Check to see if SELF neighborhood overlaps with other input TGN class. We define them as over lapping if they are withing boundSize stddevs of the center of SELF compared to the center of argument TGN. The last optional argument dictates that given the bound vector of both TGNs they should be able to 'walk' into each other not just A into B but that B must also be able to step into the neighborhood of B.

nearestTGN(self, TGNList, boundSize=0.5)

source code

Takes a list of TGNs and compares it to self to determine which is the closest one, this ideally is the same group and we can associate the group IDs. If method does not find TGN it returns a NONE value.

Class TGN

__init__(self) (Constructor)

createFromString(self, mString, bString, delim=" ")

getCentroidErrorViaIndex(self, index=0)

checkOverlap(self, TGN, boundSize=0.5, mutual=bool(True))

nearestTGN(self, TGNList, boundSize=0.5)

init(self)
(Constructor)