tcc.msg.formatObjFields Namespace Reference

Classes
class	MoveItemKW

Functions
def	formatChebyCoeff
	Format cheby coeffs. More...
def	formatCoordSys
	Format a coordinate system. More...
def	formatMag
	Format a magnitude. More...
def	formatPVT
	Format a single PVT. More...
def	formatPVTList
	Format a sequence of PVTs. More...
def	formatPVTCoord
	Format a PVTCoord. More...
def	formatPxPMRadVel
	Format a pxPMRadVel. More...
def	formatRotType
	Format rot type as a name; return "?" for unknown values. More...
def	formatWrapPref
	Format wrap preference as a name; return "?" for unknown values. More...
def	formatUseCheby
	Format boolean use cheby, either T or F. More...
def	makeObjBlockWriter

Variables
list	__all__
dictionary	CoordSysNameKeyDict
dictionary	RotTypeEnumKeyDict
tuple	computedFields = set(["ObjZPMPos", "ObjNetPos", "ObjInstAng", "SpiderInstAng"])
tuple	objFieldKWDict
tuple	moveItemKW = MoveItemKW()
tuple	writerFromObjBlock = makeObjBlockWriter()

Function Documentation

def tcc.msg.formatObjFields.formatChebyCoeff

(

chebyCoeff

)

Format cheby coeffs.

Parameters

[in]

chebyCoeff

a list of floats

Definition at line 36 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatCoordSys

(

coordSys

)

Format a coordinate system.

Parameters

[in]

coordSys

a coordConv.CoordSys

Definition at line 43 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatMag

(

mag

)

Format a magnitude.

Definition at line 64 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatPVT

(

pvt

)

Format a single PVT.

The format is:

pos, vel, time

where all values are shown in decimal format (rather than exponential notation):

• pos and vel are shown to 7 digits after the decimal point (0.0003 arcsec resolution)
• time is shown to 6 digits (a bit more than needed at sidereal tracking rates, but time is often known to the nearest microsecond)

Example: "25.123456, -3.7654321, 2314.123456"

Parameters

[in]

pvt

a coordConv.PVT

Definition at line 69 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatPVTCoord

(

pvtCoord

)

Format a PVTCoord.

Parameters

[in]

pvtCoord

a coordConv.PVTCoord

Definition at line 98 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatPVTList

(

pvtList

)

Format a sequence of PVTs.

The format is: PVT(pos, vel, time) where all values are shown in decimal format (rather than exponential notation):

• pos and vel are shown to 7 digits after the decimal point (0.0003 arcsec resolution)
• time is shown to 6 digits (because time is commonly given to the nearest microsecond)

Parameters

[in]

pvtList

sequence of coordConv.PVT

Definition at line 85 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatPxPMRadVel

(

pxPMRadVel

)

Format a pxPMRadVel.

Parameters

[in]

pxPMRadVel

a tcc.base.PxPMRadVel

Definition at line 107 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatRotType

(

rotType

)

Format rot type as a name; return "?" for unknown values.

Parameters

[in]

rotType

a rotation type (a tcc.base.RotTypeEnum)

Definition at line 115 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatUseCheby

(

useCheby

)

Format boolean use cheby, either T or F.

Parameters

[in]

useCheby

obj (field on obj block)

Definition at line 129 of file formatObjFields.py.

def tcc.msg.formatObjFields.formatWrapPref

(

wrapType

)

Format wrap preference as a name; return "?" for unknown values.

Parameters

[in]

wrapType

a wrap preference type (a tcc.base.WrapTypeEnum)

Definition at line 122 of file formatObjFields.py.

def tcc.msg.formatObjFields.makeObjBlockWriter

(

)

Definition at line 213 of file formatObjFields.py.

Variable Documentation

list tcc.msg.formatObjFields.__all__

Initial value:

= ["CoordSysNameKeyDict", "RotTypeEnumKeyDict",
    "formatCoordSys", "formatMag", "formatPVT", "formatPVTList", "formatPVTCoord",
    "formatPxPMRadVel", "formatRotType", "formatWrapPref", "formatChebyCoeff", "formatUseCheby",
    "moveItemKW", "writerFromObjBlock", "computedFields", "objFieldKWDict"]

Definition at line 10 of file formatObjFields.py.

tuple tcc.msg.formatObjFields.computedFields = set(["ObjZPMPos", "ObjNetPos", "ObjInstAng", "SpiderInstAng"])

Definition at line 139 of file formatObjFields.py.

dictionary tcc.msg.formatObjFields.CoordSysNameKeyDict

Initial value:

= {
    "icrs": "ICRS",
    "fk5": "FK5",
    "fk4": "FK4",
    "gal": "Gal",
    "appgeo": "Geo",
    "apptopo": "Topo",
    "obs": "Obs",
    "mount": "Mount",
    "none": "None",
}

Definition at line 16 of file formatObjFields.py.

tuple tcc.msg.formatObjFields.moveItemKW = MoveItemKW()

Def