icecube.gcdserver.Geometry module

file: Geometry.py Contains all of the string keys for geometry documents along with simple routines and classes to access the data. This file is designed to internalize all knowledge of the geometry document.

class icecube.gcdserver.Geometry.DataObject(name=None, type=None, data=None)

Bases: DictionaryBacked

Base class for all GCD objects. Contains name and a dictionary for underlying data. Uses DictionaryBacked to manage the outer dictionary, containing an object name and a second dictionary for data.

OBJECT_DATA_KEY = 'data'

OBJECT_NAME_KEY = 'objectName'

OBJECT_TYPE_KEY = 'objectType'

property data

property name

property type

class icecube.gcdserver.Geometry.DictionaryBacked

Bases: object

Class with a backing dictionary used for serialization

getdict()

classmethod wrapdict(d)

class icecube.gcdserver.Geometry.GeometryObject(name=None, type=None, data=None, stringID=None, positionID=None, tankLabel=None)

Bases: DataObject

Base class for geometry objects. Present a flat object that represents all possible geometry objects, and it is up to the user to understand which data is available based on the ‘type’ property.

class icecube.gcdserver.Geometry.Keys

Bases: object

Set of keys used in GeometryObject.data()

DEPLOYMENT_COMMENT = 'deploymentComment'

DEPLOYMENT_DATE = 'deploymentDate'

GEOMETRY_X = 'x'

GEOMETRY_Y = 'y'

GEOMETRY_Z = 'z'

MBID = 'mbid'

NICKNAME = 'nickname'

ORIENTATION = 'orientation'

ORIENTATION_AZIMUTH = 'orientationAzimuth'

ORIENTATION_NX = 'nx'

ORIENTATION_NY = 'ny'

ORIENTATION_NZ = 'nz'

PMT_ID = 'pmt'

PMT_TYPE = 'pmtType'

POSITION_ID = 'position'

SENSOR_AREA = 'sensorArea'

STRING_ID = 'string'

TANK_HEIGHT = 'tankHeight'

TANK_LABEL = 'tank'

TANK_LINER = 'tankLiner'

TANK_RADIUS = 'tankRadius'

TANK_WATER_HEIGHT = 'tankWaterHeight'

TOROID_TYPE = 'toroidType'

class icecube.gcdserver.Geometry.ObjectType

Bases: object

Enumeration of DB object type strings

AMANDA_SYNC = 'AMANDA Synchronization Board'

AMANDA_TRIG = 'AMANDA Trigger Board'

DMICE = 'DMIce'

ICEACT = 'IceACT'

ICECUBE_DOM = 'IceCube DOM'

ICETOP_DOM = 'IceTop DOM'

ICE_TOP_STATION = 'IceTop Station'

ICE_TOP_TANK = 'IceTop Tank'

IN_ICE_STRING = 'IceCube String'

POINT = 'Point'

SCINTILLATOR = 'IceCube Scintillator'

class icecube.gcdserver.Geometry.Orientation

Bases: object

Enumeration of device installation orientation strings

DOWN = 'Down'

UP = 'Up'

class icecube.gcdserver.Geometry.PMTType

Bases: object

Enumeration of PMT model strings

R7081 = 'R7081'

R7081_100 = 'R7081-100'

class icecube.gcdserver.Geometry.TankLiner

Bases: object

Enumeration of IceTop tank liner strings

TYVEK = 'Tyvek'

ZIRCONIUM = 'Zirconium'

class icecube.gcdserver.Geometry.ToroidType

Bases: object

New vs old toroid in charge transformer

NEW = 'New'

OLD = 'Old'

icecube.gcdserver.Geometry.getTankName(stringID, tankLabel)

Construct a tank name from a stringID and tankLabel